collateDocuments

array public static
\Bitrix\Sale\Cashbox\CheckManager::collateDocuments(
	array $entities
);

Метод сопоставляет оплаты и отгрузки с типами чеков. Сначала метод передает данные обработчикам события OnCheckCollateDocuments, затем при необходимости применяет встроенный алгоритм. Статический метод.

Параметры

Возвращаемое значение

Метод возвращает массив описаний чеков. Каждый элемент содержит ключи TYPE, ENTITIES и RELATED_ENTITIES. Пустой массив означает, что создавать чек не нужно.

Исключения

Метод может выбросить \Bitrix\Main\NotSupportedException, если обработчик события вернул данные неверного типа или передан неподдерживаемый объект.

Пример

<?php

use Bitrix\Main\Loader;

use Bitrix\Sale\Cashbox\CheckManager;
use Bitrix\Sale\Order;

if (!Loader::includeModule('sale'))
{
	throw new RuntimeException('Не удалось подключить модуль sale');
}

// Идентификатор существующего заказа
$order = Order::load(100);
if ($order === null)
{
	throw new RuntimeException('Заказ не найден');
}

$payment = $order->getPaymentCollection()->current();
if ($payment === null)
{
	throw new RuntimeException('В заказе нет оплаты');
}

print_r(CheckManager::collateDocuments([$payment]));