Bitrix API

UserToGroupTable extends DataManager uses MergeTrait, DeleteByFilterTrait

Class UserToGroupTable

DO NOT WRITE ANYTHING BELOW THIS

<<< ORMENTITYANNOTATION

Table of Contents

Constants

INITIATED_BY_GROUP  = 'G'
INITIATED_BY_STRUCTURE  = 'S'
INITIATED_BY_USER  = 'U'
ROLE_BAN  = 'T'
ROLE_MODERATOR  = 'E'
ROLE_OWNER  = 'A'
ROLE_REQUEST  = 'Z'
ROLE_USER  = 'K'

Methods

add()  : AddResult
Adds row to entity table
createCollection()  : MemberEntityCollection
createObject()  : Member
delete()  : DeleteResult
Deletes row in entity table by primary key
deleteByFilter()  : void
getById()  : EO_UserToGroup_Result
getByPrimary()  : EO_UserToGroup_Result
getCollectionClass()  : string
getEntity()  : EO_UserToGroup_Entity
getGroupModerators()  : array<string|int, mixed>
getInitiatedByAll()  : array<string|int, mixed>
Returns set of all INITIATED_BY values
getList()  : EO_UserToGroup_Result
getMap()  : array<string|int, mixed>
Returns entity map definition
getObjectClass()  : string
getRolesAll()  : array<string|int, mixed>
Returns set of all possible roles of a user in a workgroup
getRolesMember()  : array<string|int, mixed>
Returns set of membership roles of a user in a workgroup
getTableName()  : string
Returns DB table name for entity
getUfId()  : string
merge()  : mixed
query()  : EO_UserToGroup_Query
update()  : UpdateResult
Updates row in entity table by primary key
wakeUpCollection()  : MemberEntityCollection
wakeUpObject()  : Member

Constants

INITIATED_BY_GROUP

public mixed INITIATED_BY_GROUP = 'G'
Tags
see
SONET_INITIATED_BY_GROUP

INITIATED_BY_STRUCTURE

public mixed INITIATED_BY_STRUCTURE = 'S'

INITIATED_BY_USER

public mixed INITIATED_BY_USER = 'U'
Tags
see
SONET_INITIATED_BY_USER

ROLE_BAN

public mixed ROLE_BAN = 'T'
Tags
see
SONET_ROLES_BAN

ROLE_MODERATOR

public mixed ROLE_MODERATOR = 'E'
Tags
see
SONET_ROLES_MODERATOR

ROLE_OWNER

public mixed ROLE_OWNER = 'A'
Tags
see
SONET_ROLES_OWNER

ROLE_REQUEST

public mixed ROLE_REQUEST = 'Z'
Tags
see
SONET_ROLES_REQUEST

ROLE_USER

public mixed ROLE_USER = 'K'
Tags
see
SONET_ROLES_USER

Methods

add()

Adds row to entity table

public static add(array<string|int, mixed> $data) : AddResult
Parameters
$data : array<string|int, mixed>
Tags
throws
Exception
Return values
AddResult —

Contains ID of inserted row

createCollection()

public static createCollection() : MemberEntityCollection
Return values
MemberEntityCollection

createObject()

public static createObject([mixed $setDefaultValues = = 'true' ]) : Member
Parameters
$setDefaultValues : mixed = = 'true'
Return values
Member

delete()

Deletes row in entity table by primary key

public static delete(mixed $primary) : DeleteResult
Parameters
$primary : mixed
Tags
throws
Exception
Return values
DeleteResult

deleteByFilter()

public static deleteByFilter(array<string|int, mixed> $filter) : void
Parameters
$filter : array<string|int, mixed>
Tags
throws
ArgumentException

getById()

public static getById(mixed $id) : EO_UserToGroup_Result
Parameters
$id : mixed
Return values
EO_UserToGroup_Result

getByPrimary()

public static getByPrimary(mixed $primary[, array<string|int, mixed> $parameters = = '[]' ]) : EO_UserToGroup_Result
Parameters
$primary : mixed
$parameters : array<string|int, mixed> = = '[]'
Return values
EO_UserToGroup_Result

getCollectionClass()

public static getCollectionClass() : string
Return values
string

getEntity()

public static getEntity() : EO_UserToGroup_Entity
Return values
EO_UserToGroup_Entity

getGroupModerators()

public static getGroupModerators(int $groupId) : array<string|int, mixed>
Parameters
$groupId : int
Return values
array<string|int, mixed>

getInitiatedByAll()

Returns set of all INITIATED_BY values

public static getInitiatedByAll() : array<string|int, mixed>
Return values
array<string|int, mixed>

getList()

public static getList([array<string|int, mixed> $parameters = = '[]' ]) : EO_UserToGroup_Result
Parameters
$parameters : array<string|int, mixed> = = '[]'
Return values
EO_UserToGroup_Result

getMap()

Returns entity map definition

public static getMap() : array<string|int, mixed>
Return values
array<string|int, mixed>

getObjectClass()

public static getObjectClass() : string
Return values
string

getRolesAll()

Returns set of all possible roles of a user in a workgroup

public static getRolesAll() : array<string|int, mixed>
Return values
array<string|int, mixed>

getRolesMember()

Returns set of membership roles of a user in a workgroup

public static getRolesMember() : array<string|int, mixed>
Return values
array<string|int, mixed>

getTableName()

Returns DB table name for entity

public static getTableName() : string
Return values
string

getUfId()

public static getUfId() : string
Return values
string

merge()

public static merge(array<string|int, mixed> $insertFields, array<string|int, mixed> $updateFields[, array<string|int, mixed>|null $uniqueFields = null ]) : mixed
Parameters
$insertFields : array<string|int, mixed>
$updateFields : array<string|int, mixed>
$uniqueFields : array<string|int, mixed>|null = null

query()

public static query() : EO_UserToGroup_Query
Return values
EO_UserToGroup_Query

update()

Updates row in entity table by primary key

public static update(mixed $primary, array<string|int, mixed> $data) : UpdateResult
Parameters
$primary : mixed
$data : array<string|int, mixed>
Tags
throws
Exception
Return values
UpdateResult

wakeUpCollection()

public static wakeUpCollection(mixed $rows) : MemberEntityCollection
Parameters
$rows : mixed
Return values
MemberEntityCollection

wakeUpObject()

public static wakeUpObject(mixed $row) : Member
Parameters
$row : mixed
Return values
Member 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results