Iblock extends Iblock
Interface CopyImplementer for copy entities.
Table of Contents
Constants
- IBLOCK_COPY_ERROR = "IBLOCK_COPIER_ERROR"
Methods
- __construct() : mixed
- add() : int|bool
- Adds iblock.
- copyChildren() : Result
- Starts copying children entities.
- getErrors() : array<string|int, Error>
- getFields() : array<string|int, mixed>
- Returns iblock fields.
- prepareFieldsToCopy() : array<string|int, mixed>
- Preparing data before creating a new iblock.
- setCacheManager() : void
- Set cache manager object.
- setChild() : mixed
- Writes child implementer to the copy queue.
- setExecutiveUserId() : void
- To copy on agent need user id.
- setTargetIblockTypeId() : void
- Set destination iblock type.
- setTargetSocnetGroupId() : void
- Set destination socialnetwork group, if exists.
- 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
IBLOCK_COPY_ERROR
public
mixed
IBLOCK_COPY_ERROR
= "IBLOCK_COPIER_ERROR"
Methods
__construct()
public
__construct() : mixed
add()
Adds iblock.
public
add(Container $container, array<string|int, mixed> $fields) : int|bool
Parameters
- $container : Container
-
Storage.
- $fields : array<string|int, mixed>
-
Fields list.
Return values
int|bool —return iblock id or false.
copyChildren()
Starts copying children entities.
public
copyChildren(Container $container, mixed $iblockId, mixed $copiedIblockId) : Result
Parameters
- $container : Container
-
Storage.
- $iblockId : mixed
- $copiedIblockId : mixed
Return values
ResultgetErrors()
public
getErrors() : array<string|int, Error>
Return values
array<string|int, Error>getFields()
Returns iblock fields.
public
getFields(Container $container, int $entityId) : array<string|int, mixed>
Parameters
- $container : Container
-
Storage.
- $entityId : int
-
Iblock id.
Return values
array<string|int, mixed> —$fields
prepareFieldsToCopy()
Preparing data before creating a new iblock.
public
prepareFieldsToCopy(Container $container, array<string|int, mixed> $fields) : array<string|int, mixed>
Parameters
- $container : Container
-
Storage.
- $fields : array<string|int, mixed>
-
List iblock fields.
Return values
array<string|int, mixed> —$fields
setCacheManager()
Set cache manager object.
public
setCacheManager(mixed $cacheManager) : void
Parameters
- $cacheManager : mixed
-
Cache manager object.
setChild()
Writes child implementer to the copy queue.
public
setChild(Child $child) : mixed
Parameters
- $child : Child
-
Child implementer.
setExecutiveUserId()
To copy on agent need user id.
public
setExecutiveUserId(int $executiveUserId) : void
Parameters
- $executiveUserId : int
setTargetIblockTypeId()
Set destination iblock type.
public
setTargetIblockTypeId(string $targetIblockTypeId) : void
Parameters
- $targetIblockTypeId : string
-
Iblock type id.
setTargetSocnetGroupId()
Set destination socialnetwork group, if exists.
public
setTargetSocnetGroupId(int $targetSocnetGroupId) : void
Parameters
- $targetSocnetGroupId : int
-
Socialnetwork group id.
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.