controller.php

См. документацию.

<?php
 
 
namespace Bitrix\Sale\Controller;
 
 
use Bitrix\Main\Engine;
use Bitrix\Main\Error;
use Bitrix\Main\Loader;
use Bitrix\Main\ModuleManager;
use Bitrix\Main\NotImplementedException;
use Bitrix\Rest\RestException;
use Bitrix\Sale\Helpers\Order\Builder\SettingsContainer;
use Bitrix\Sale\Rest\ModificationFieldsBase;
use Bitrix\Sale\Result;
use Bitrix\Sale\TradeBindingEntity;
/*
 * Error code notation x(category1) xxx(category2) xxx(code category) xxxxx(code) - 2 000 403 00010
 * category1:
 * Intrnalizer - 1
 * Controller - 2
 * Externalazer - 3
 * */
class Controller extends Engine\Controller
{
    protected function isCrmModuleInstalled()
    {
        return ModuleManager::isModuleInstalled('crm');
    }
 
    protected function processBeforeAction(Engine\Action $action)
    {
        $r = $this->checkPermission($action->getName());
        if($r->isSuccess())
        {
            if($this->isCrmModuleInstalled() && Loader::includeModule('crm'))
            {
                $internalizer = \Bitrix\Crm\Order\Rest\Internalizer::buildByAction($action, [], $this->getScope());
            }
            else
            {
                $internalizer = \Bitrix\Sale\Rest\Internalizer::buildByAction($action, [], $this->getScope());
            }
 
            $r = $internalizer->process();
 
            if($r->isSuccess())
            {
                $action->setArguments($r->getData()['data']);
                return parent::processBeforeAction($action);
            }
            else
            {
                $this->addErrors($r->getErrors());
                return null;
            }
        }
        else
        {
            $this->addErrors($r->getErrors());
            return null;
        }
    }
 
    protected function processAfterAction(Engine\Action $action, $result)
    {
        $externalizer = null;
        if($this->errorCollection->count()==0)
        {
            if($result instanceof Engine\Response\DataType\Page || is_array($result))
            {
                $data = $result instanceof Engine\Response\DataType\Page ?
                    [$result->getId()=>$result->getItems()]:$result;
 
                if($this->isCrmModuleInstalled() && Loader::includeModule('crm'))
                {
                    $externalizer = \Bitrix\Crm\Order\Rest\Externalizer::buildByAction($action, $data, $this->getScope());
                }
                else
                {
                    $externalizer = \Bitrix\Sale\Rest\Externalizer::buildByAction($action, $data, $this->getScope());
                }
            }
        }
        else
        {
            return parent::processAfterAction($action, $result);
        }
 
        if($externalizer instanceof ModificationFieldsBase)
        {
            if($this->getScope() == Engine\Controller::SCOPE_REST)
            {
                // nothing
            }
            else if($this->getScope() == Engine\Controller::SCOPE_AJAX)
            {
                $externalizer->setFormat([
                    ModificationFieldsBase::TO_WHITE_LIST,
                    ModificationFieldsBase::SORTING_KEYS
                ]);
            }
 
            if($this->getScope() == Engine\Controller::SCOPE_REST)
            {
                return $result instanceof Engine\Response\DataType\Page ?
                    $externalizer->getPage($result):$externalizer;
            }
            else if($this->getScope() == Engine\Controller::SCOPE_AJAX)
            {
                return $externalizer->toArray();
            }
        }
 
        return parent::processAfterAction($action, $result);
    }
 
    protected static function getApplication()
    {
        global $APPLICATION;
 
        return $APPLICATION;
    }
 
    protected static function getNavData($start, $bORM = false)
    {
        if($start >= 0)
        {
            return ($bORM ?
                ['limit' => \IRestService::LIST_LIMIT, 'offset' => intval($start)]
                :['nPageSize' => \IRestService::LIST_LIMIT, 'iNumPage' => intval($start / \IRestService::LIST_LIMIT) + 1]
            );
        }
        else
        {
            return ($bORM ?
                ['limit' => \IRestService::LIST_LIMIT]
                :['nTopCount' => \IRestService::LIST_LIMIT]
            );
        }
    }
 
    public function getBuilder(SettingsContainer $settings=null)
    {
        $settings = $settings === null? $this->getSettingsContainerDefault():$settings;
 
        return ($this->isCrmModuleInstalled() && Loader::includeModule('crm'))
            ? new \Bitrix\Crm\Order\Builder\OrderBuilderRest($settings)
            : new \Bitrix\Sale\Helpers\Order\Builder\OrderBuilderRest($settings);
    }
 
    protected function getSettingsContainerDefault()
    {
        return new SettingsContainer([
            'deleteClientsIfNotExists' => true,
            'deleteTradeBindingIfNotExists' => true,
            'deletePaymentIfNotExists' => true,
            'deleteShipmentIfNotExists' => true,
            'deleteShipmentItemIfNotExists' => true,
            'deletePropertyValuesIfNotExists' => true,
            'createDefaultPaymentIfNeed' => false,
            'createDefaultShipmentIfNeed' => false,
            'createUserIfNeed' => SettingsContainer::SET_ANONYMOUS_USER,
            'cacheProductProviderData' => false,
            'propsFiles' => $this->getFielsPropertyValuesFromRequest(),
            'acceptableErrorCodes' => []
        ]);
    }
 
    protected function getFielsPropertyValuesFromRequest()
    {
        $orderProperties = [];
 
        if (isset($this->request->getFileList()['fields']['PROPERTIES']))
        {
            foreach ($this->request->getFileList()['fields']['PROPERTIES'] as $orderPropId => $arFileData)
            {
                if (is_array($arFileData))
                {
                    foreach ($arFileData as $paramName => $value)
                    {
                        if (is_array($value))
                        {
                            foreach ($value as $nIndex => $val)
                            {
                                if ($arFileData["name"][$nIndex] <> '')
                                {
                                    $orderProperties[$orderPropId][$nIndex][$paramName] = $val;
                                }
                            }
                        }
                        else
                        {
                            $orderProperties[$orderPropId][$paramName] = $value;
                        }
                    }
                }
            }
        }
 
        return $orderProperties;
    }
 
    protected function toArray(\Bitrix\Sale\Order $order, array $fields=[])
    {
        //добавляем те поля, к существующим полям сущности, которые у неё отсутствуют
        $fields = array_merge($fields, $this->getAdditionalFields($order));
 
        if($this->isCrmModuleInstalled() && Loader::includeModule('crm'))
        {
            $director = new \Bitrix\Crm\Order\Rest\Normalizer\Director();
            $normalizer = new \Bitrix\Crm\Order\Rest\Normalizer\ObjectNormalizer($fields);
        }
        else
        {
            $director = new \Bitrix\Sale\Rest\Normalizer\Director();
            $normalizer = new \Bitrix\Sale\Rest\Normalizer\ObjectNormalizer($fields);
        }
 
        return $director->normalize($normalizer, $order);
    }
 
    private function getAdditionalFields(\Bitrix\Sale\Order $order)
    {
        $ixInternal = [];
        //region fill internal Index
        foreach (\Bitrix\Sale\PersonType::getList(['select'=>['ID', 'XML_ID']]) as $row)
        {
            $ixInternal['personType'][$row['ID']] = $row['XML_ID'];
        }
 
        foreach (\Bitrix\Sale\OrderStatus::getList(['select'=>['ID', 'XML_ID']]) as $row)
        {
            $ixInternal['orderStatus'][$row['ID']] = $row['XML_ID'];
        }
 
        foreach (\Bitrix\Sale\Property::getList(['select'=>['ID', 'XML_ID']])->fetchAll() as $row)
        {
            $ixInternal['properties'][$row['ID']] = $row['XML_ID'];
        }
 
        foreach (\Bitrix\Sale\PaySystem\Manager::getList(['select'=>['ID', 'XML_ID', 'IS_CASH']])->fetchAll() as $row)
        {
            $ixInternal['paySystems'][$row['ID']]['XML_ID'] = $row['XML_ID'];
            $ixInternal['paySystems'][$row['ID']]['IS_CASH'] = $row['IS_CASH'];
        }
 
        foreach (\Bitrix\Sale\Delivery\Services\Manager::getActiveList() as $row)
        {
            $ixInternal['deliverySystems'][$row['ID']] = $row['XML_ID'];
        }
 
        foreach (\Bitrix\Sale\DeliveryStatus::getList(['select'=>['ID', 'XML_ID']]) as $row)
        {
            $ixInternal['deliveryStatus'][$row['ID']] = $row['XML_ID'];
        }
 
        foreach (\Bitrix\Sale\TradingPlatformTable::getList(['select'=>['ID', 'XML_ID']])->fetchAll() as $row)
        {
            $ixInternal['tradingPlatform'][$row['ID']] = $row['XML_ID'];
        }
        //endregion
 
        $r['ORDER'][$order->getInternalId()] = [
            'PERSON_TYPE_XML_ID' => $ixInternal['personType'][$order->getPersonTypeId()] ?? null,
            'STATUS_XML_ID' => $ixInternal['orderStatus'][$order->getField('STATUS_ID')] ?? null,
        ];
 
        foreach ($order->getPropertyCollection() as $property)
        {
            $r['PROPERTIES'][$property->getInternalIndex()] = [
                'ORDER_PROPS_XML_ID' => $ixInternal['properties'][$property->getPropertyId()] ?? null,
            ];
        }
 
        foreach ($order->getPaymentCollection() as $payment)
        {
            $r['PAYMENTS'][$payment->getInternalIndex()] = [
                'PAY_SYSTEM_XML_ID' => $ixInternal['paySystems'][$payment->getPaymentSystemId()]['XML_ID'] ?? null,
                'PAY_SYSTEM_IS_CASH' => $ixInternal['paySystems'][$payment->getPaymentSystemId()]['IS_CASH'] ?? null,
            ];
        }

        foreach ($order->getShipmentCollection() as $shipment)
        {
            $shipmentIndex = $shipment->getInternalIndex();
            $r['SHIPMENTS'][$shipmentIndex] = [
                'DELIVERY_XML_ID' => $ixInternal['deliverySystems'][$shipment->getDeliveryId()] ?? null,
                'STATUS_XML_ID' => $ixInternal['deliveryStatus'][$shipment->getField('STATUS_ID')] ?? null,
            ];
        }

        foreach ($order->getTradeBindingCollection() as $binding)
        {
            if ($binding->getTradePlatform() !== null)
            {
                $r['TRADE_BINDINGS'][$binding->getInternalIndex()] = [
                    'TRADING_PLATFORM_XML_ID' => $ixInternal['tradingPlatform'][$binding->getTradePlatform()->getId()] ?? null,
                ];
            }
        }
 
        return $r;
    }
 
    private function checkPermission($name)
    {
        $r = new Result();
 
        if($name == 'add')
        {
            $r = $this->checkCreatePermissionEntity();
        }
        elseif ($name == 'update')
        {
            $r = $this->checkUpdatePermissionEntity();
        }
        elseif ($name == 'list')
        {
            $r = $this->checkReadPermissionEntity();
        }
        elseif ($name == 'getfields'){}
        elseif ($name == 'get')
        {
            $r = $this->checkReadPermissionEntity();
        }
        elseif ($name == 'delete')
        {
            $r = $this->checkDeletePermissionEntity();
        }
        elseif ($name == 'modify')
        {
            $r = $this->checkModifyPermissionEntity();
        }
        elseif ($name == 'tryadd')
        {
            $r = $this->checkCreatePermissionEntity();
        }
        elseif ($name == 'tryupdate')
        {
            $r = $this->checkUpdatePermissionEntity();
        }
        elseif ($name == 'trymodify')
        {
            $r = $this->checkModifyPermissionEntity();
        }
        else
        {
            $r = $this->checkPermissionEntity($name);
        }
 
        return $r;
    }
 
    protected function checkReadPermissionEntity()
    {
        $r = new Result();
 
        $saleModulePermissions = self::getApplication()->GetGroupRight("sale");
        if ($saleModulePermissions  == "D")
        {
            $r->addError(new Error('Access Denied', 200040300010));
        }
        return $r;
    }
 
    protected function checkModifyPermissionEntity()
    {
        $r = new Result();
 
        $saleModulePermissions = self::getApplication()->GetGroupRight("sale");
        if ($saleModulePermissions  < "W")
        {
            $r->addError(new Error('Access Denied', 200040300020));
        }
        return $r;
    }
 
    protected function checkCreatePermissionEntity()
    {
        return $this->checkModifyPermissionEntity();
    }
 
    protected function checkUpdatePermissionEntity()
    {
        return $this->checkModifyPermissionEntity();
    }
 
    protected function checkDeletePermissionEntity()
    {
        return $this->checkModifyPermissionEntity();
    }
 
    protected function checkPermissionEntity($name)
    {
        throw new NotImplementedException('Check permission entity. The method '.$name.' is not implemented.');
    }
}