PrototypeItem
Base class for items table.
Inheritance chain
Descendant for class Main\UserField\Internal\PrototypeItemDataManager.
abstract class Bitrix\Crm\Model\Dynamic\PrototypeItem extends Bitrix\Main\UserField\Internal\PrototypeItemDataManager
Table fields
| Field | Description | Required |
|---|---|---|
| ID | Item ID. | |
| XML_ID | Item external ID. | |
| TITLE | Item name. | |
| CREATED_BY | User ID, who created item. | Yes |
| UPDATED_BY | User ID, who updated item. | |
| MOVED_BY | User ID, who changes item stage. | |
| CREATED_TIME | Item creation time. | Yes |
| UPDATED_TIME | Item update time. | |
| MOVED_TIME | Item stage change time. | |
| CATEGORY_ID | Item pipeline ID. Default pipeline. | Yes |
| OPENED | Flag "Available to everyone". | |
| >STAGE_ID | String ID for item stage. Pipeline first stage by default. | |
| PREVIOUS_STAGE_ID | String ID for previous item stage. | |
| BEGINDATE | Start date. Creation date by default. | |
| CLOSEDATE | End date. Creation date by default + 7 days. | |
| COMPANY_ID | Company ID. More on bindings. | |
| CONTACT_ID | Main contact ID. More on bindings, as well as on multiple contacts. | |
| OPPORTUNITY | Total. | |
| IS_MANUAL_OPPORTUNITY | Flag "Total amount calculation ". Total calculated automatically by default. | |
| TAX_VALUE | SPA ID. | |
| CURRENCY_ID | Currency ID. | |
| OPPORTUNITY_ACCOUNT | Total for reports. | |
| TAX_VALUE_ACCOUNT | Tax total for reports. | |
| ACCOUNT_CURRENCY_ID | Currencies for reports. | |
| MYCOMPANY_ID | My company ID. | |
| SOURCE_ID | Source ID. | |
| SOURCE_DESCRIPTION | Source extra data. | |
| WEBFORM_ID | CRM form ID. |
In addition: Separate column for each custom field. When field is multiple, this column stores set of values in serialized format and separate table stores set of multiple values. Learn more at custom field value storage.
Please, be advised, this is an abstract class. Specific classes are compiled for each smart process in runtime. Within this table here ID - is ID with association to a specific smart process; this association is defined in a specific class.
Class methods
| Method | Description | Available from version |
|---|---|---|
public static function getFactory(): ?\Bitrix\Crm\Service\Factory |
Method returns factory service, associated to the smart process. | |
public static function prepareGetListParameters(
array $parameters = []
): array |
Method prepares parameters for passing in parent class getList. This method is called automatically in PrototypeItem::getList, you don't need to call it separately. |
|
public static function getFullTextDataClass(): string |
Method returns table class FQN for full-text search. | |
public static function getFullTextReferenceField(
string $referenceName = 'FULL_TEXT'
): Reference |
Returns object Bitrix\Main\ORM\Fields\Relations\Reference for linking with full-text search table. |
|
public static function getDefaultCategoryId(): ?int |
Returns default pipeline ID for a smart process. | |
public static function getDefaultStageId(): ?string |
Returns default stage ID for a smart process. | |
public static function getDefaultCloseDate(): Date |
Returns default closing date. | |
public static function disableUserFieldsCheck(): void |
Disables custom field value check during the next write operation runtime. |
© «Bitrix24», 2001-2024