Documentation

PrototypeItem

Description and methods

ORM item base class.


Chain of inheritance

abstract Bitrix\Rpa\Model\PrototypeItem extends Bitrix\Main\UserField\Internal\PrototypeItemDataManager

Methods

Method Description Available from version
public static function updateUserFieldValues(int $id, array $fields): Result Updates item user field values. This method is used in the event handler from old API.

Returns object Bitrix\Main\Result

public static function deleteUserFieldValues(int $id): Result Deletes values for item user fields. This method is used in the event handler from old API.

Returns object Bitrix\Main\Result

public static function getDefaultStageId(): int Returns a process first stage ID.
public static function getUserSortReferenceField(int $typeId, int $userId): Reference Returns object Bitrix\Main\ORM\Fields\Relations\Reference for connecting with user sorting table.
public static function getFullTextReferenceField(string $referenceName = 'FULL_TEXT'): Reference Returns object Bitrix\Main\ORM\Fields\Relations\Reference for connecting with fulltext search table.

Field

Field Description Type Required
ID IdentifierInt Yes
STAGE_ID Item stage ID.Int Yes
PREVIOUS_STAGE_ID Previous item stage ID.Int
XML_ID External ID string.String Yes
CREATED_BY User ID who created item.Int Yes
UPDATED_BY User ID who modified item.Int
MOVED_BY User ID who change item stage.Int
CREATED_TIME Time when Item was created.Datetime Yes
UPDATED_TIME Time when item was updated.Datetime
MOVED_TIME Time when item stage changed.Datetime Yes

Additional:

  • Separate column for each user field. If field is multiple, this column stores set of values in serialized format, and separate table stores set of multiple values.

Find more details in [link=11276082]user field value storage[/link]

Please, be advised that this class is - abstract. Each specific class is compiled in runtime for each process. In this context, ID within table is ID with binding to a specific process and such binding is defined in an individual class.



© «Bitrix24», 2001-2022
Up