Операции

Общее

Каждое изменение элемента любого типа CRM сопровождается большим количеством проверок и связанных действий.

Чтобы весь этот процесс был прозрачным, было решено сосредоточить это всё в одном классе.

Т.к. каждый тип сущности может иметь свои особенности и дополнительные действия, то экземпляр объекта получается через фабрику.

После получения объекта его можно дополнительным образом сконфигурировать.

Запуск выполняется методом launch, который вернет объект \Bitrix\Main\Result.

В общем случае, процесс выполняется следующим образом:

1. Проверка тарифных ограничений.
2. Проверка прав доступа к элементу.
3. Проверка прав доступа.
4. Проверка запущенных бизнес-процессов.
5. Выполнение бизнес-логики полей до сохранения.
6. Проверка заполнености обязательных полей.
• Если к этому моменту элемент не был изменен, то дальнейшие действия не производятся.
7. Выполнение дополнительных действий до сохранения.
8. Сохранение элемента.
9. Выполнение бизнес-логики полей после сохранения.
10. Обновление данных о правах доступа.
11. Обновление поискового индекса.
12. Сохранение истории действий над элементом.
13. Запись данных в таймлайн.
14. Выполнение дополнительных действий после сохранения.
15. Отправка пуш-уведомления.
16. Запуск роботов и шаблонов бизнес-процессов.

Методы, выполняющие проверки и изменения, являются публичными.

При необходимости можно получить объект операции и вызвать, например, проверку прав доступа, до запуска самой операции.

Методы

public function __construct
(Item $item, Operation\Settings $settings, 
Collection $fieldsCollection = null)

public function exportSettings(): Operation\Settings

ppublic function importSettings
(Operation\Settings $settings): self

public function getContext(): Context

public function setContext(Context $context): self

public function getItem(): Item

public function getItemBeforeSave(): Item

public function addAction
(string $actionPlacement, Action $action): self

public function launch(): Result

public function checkAccess(): Result

public function processFieldsWithPermissions(): Result

public function processFieldsBeforeSave(): Result

public function checkFields(): Result

public function checkRequiredFields
(array $requiredFields, Factory $factory): Result

public function processFieldsAfterSave(): Result

public function getStageDependantRequiredFields
(Factory $factory): array

public function isItemChanged(): bool

public function checkRunningWorkflows(): Result

Метод конфигурации

Для управления настройками выполнения операции можно получить объект настройки и работать с его методами напрямую.
Или можно вызвать методы этого класса и работать с настройками.

public function disableAllChecks(): self

enableAutomation / disableAutomation / isAutomationEnabled

enableBizProc / disableBizProc / isBizProcEnabled

enableCheckAccess / disableCheckAccess / isCheckAccessEnabled

isCheckFieldsEnabled / enableCheckFields / disableCheckFields

enableCheckRequiredUserFields / disableCheckRequiredUserFields / isCheckRequiredUserFields

enableFieldProcession / disableFieldProcession / isFieldProcessionEnabled

enableSaveToHistory / disableSaveToHistory / isSaveToHistoryEnabled

enableBeforeSaveActions / disableBeforeSaveActions / isBeforeSaveActionsEnabled

enableAfterSaveActions / disableAfterSaveActions / isAfterSaveActionsEnabled

enableCheckWorkflows / disableCheckWorkflows / isCheckWorkflowsEnabled

Наследники

Базовый класс операции является абстрактным. У этого класса есть пять реализаций, выполняющий разные виды операций:

• Operation\Add - добавление.
• Operation\Update - изменение.
• Operation\Delete - удаление.
• Operation\Copy - копирование.
• Operation\Conversion - конвертация.

В каждом из этих классов переопределены методы, отвечающие за особенности той или иной операции. Но в целом, процесс выполнения выполняется в том же порядке.

Разница в том, что, например, при удалении не запускаются роботы и бизнес-процессы - в этом нет смысла.

Примеры

use Bitrix\Crm\Service;

$entityTypeId = 128;

$factory = Service\Container::getInstance()->getFactory($entityTypeId);

$item = $factory->createItem();
$item->setStageId('D128_3:CLIENT');

$operation = $factory->getAddOperation($item)
	->disableCheckAccess()
	->disableCheckFields();

$result = $operation->launch();
if (!$result->isSuccess())
{
	print_r($result->getErrorMessages());
}

$newId = $item->getId();

Обновление Предложения с запуском связанных действий

\Bitrix\Main\Loader::includeModule('crm');

use Bitrix\Crm\Service;

$factory = Service\Container::getInstance()->getFactory(\CCrmOwnerType::Quote);

$itemId = 3; // ID сущности

$item = $factory->getItem($itemId);

if ($item) {
	$item->setStageId('SENT');
}

$operation = $factory->getUpdateOperation($item)
	->disableCheckAccess()
	->disableCheckFields();

$result = $operation->launch();
if (!$result->isSuccess())
{
	print_r($result->getErrorMessages());
}