Bitrix API

UserToGroup extends CopyImplementer

Interface CopyImplementer for copy entities.

Table of Contents

Constants

GROUP_USER_COPY_ERROR  = "GROUP_USER_COPY_ERROR"

Methods

__construct()  : mixed
add()  : int|bool
Adds entity.
copyChildren()  : Result
Starts copying children entities.
getErrors()  : array<string|int, Error>
getFields()  : array<string|int, mixed>
Returns entity fields.
prepareFieldsToCopy()  : array<string|int, mixed>
Preparing data before creating a new entity.
setExecutiveUserId()  : void
To copy on agent need user id.
setUfIgnoreList()  : void
To avoid copying specific fields, specify a list of fields to ignore.
setUserFieldManager()  : mixed
To copy uf fields, you must pass the uf field manager.
setUserGroupHelper()  : mixed
Record helper object to update the list of moderators when copying.

Constants

GROUP_USER_COPY_ERROR

public mixed GROUP_USER_COPY_ERROR = "GROUP_USER_COPY_ERROR"

Methods

add()

Adds entity.

public add(Container $container, array<string|int, mixed> $fields) : int|bool
Parameters
$container : Container
$fields : array<string|int, mixed>
Return values
int|bool —

Added entity id or false.

copyChildren()

Starts copying children entities.

public copyChildren(Container $container, int $entityId, int $copiedEntityId) : Result
Parameters
$container : Container
$entityId : int

Entity id.

$copiedEntityId : int

Copied entity id.

Return values
Result

getErrors()

public getErrors() : array<string|int, Error>
Return values
array<string|int, Error>

getFields()

Returns entity fields.

public getFields(Container $container, int $entityId) : array<string|int, mixed>
Parameters
$container : Container
$entityId : int
Return values
array<string|int, mixed> —

$fields

prepareFieldsToCopy()

Preparing data before creating a new entity.

public prepareFieldsToCopy(Container $container, array<string|int, mixed> $fields) : array<string|int, mixed>
Parameters
$container : Container
$fields : array<string|int, mixed>

List entity fields.

Return values
array<string|int, mixed> —

$fields

setExecutiveUserId()

To copy on agent need user id.

public setExecutiveUserId(int $executiveUserId) : void
Parameters
$executiveUserId : int

setUfIgnoreList()

To avoid copying specific fields, specify a list of fields to ignore.

public setUfIgnoreList(array<string|int, mixed> $ufIgnoreList) : void
Parameters
$ufIgnoreList : array<string|int, mixed>

Ignore list.

setUserFieldManager()

To copy uf fields, you must pass the uf field manager.

public setUserFieldManager(CUserTypeManager $userTypeManager) : mixed
Parameters
$userTypeManager : CUserTypeManager

Uf fields.

setUserGroupHelper()

Record helper object to update the list of moderators when copying.

public setUserGroupHelper(UserGroupHelper $userGroupHelper) : mixed
Parameters
$userGroupHelper : UserGroupHelper

Helper object.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results