Element extends CopyImplementer
Interface CopyImplementer for copy entities.
Table of Contents
Constants
- ELEMENT_COPY_ERROR = "ELEMENT_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 element 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.
Constants
ELEMENT_COPY_ERROR
public
mixed
ELEMENT_COPY_ERROR
= "ELEMENT_COPY_ERROR"
Methods
__construct()
public
__construct() : mixed
add()
Adds entity.
public
add(Container $container, array<string|int, mixed> $fields) : int|bool
Parameters
- $container : Container
-
Storage.
- $fields : array<string|int, mixed>
-
Element fields and property.
Return values
int|bool —return entity id or false.
copyChildren()
Starts copying children entities.
public
copyChildren(Container $container, int $elementId, int $copiedElementId) : Result
Parameters
- $container : Container
-
Storage.
- $elementId : int
-
Entity id.
- $copiedElementId : int
-
Copied entity id.
Return values
ResultgetErrors()
public
getErrors() : array<string|int, Error>
Return values
array<string|int, Error>getFields()
Returns element fields.
public
getFields(Container $container, int $entityId) : array<string|int, mixed>
Parameters
- $container : Container
-
Storage.
- $entityId : int
-
Iblock element id.
Return values
array<string|int, mixed> —$fields
prepareFieldsToCopy()
Preparing data before creating a new entity.
public
prepareFieldsToCopy(Container $container, array<string|int, mixed> $inputFields) : array<string|int, mixed>
Parameters
- $container : Container
-
Storage.
- $inputFields : array<string|int, mixed>
-
List element 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.