cashbox.php

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

<?php
 
namespace Bitrix\Sale\Cashbox;
 
use Bitrix\Main;
use Bitrix\Main\Localization\Loc;
use Bitrix\Main\NotImplementedException;
use Bitrix\Sale\Cashbox\Internals\CashboxTable;
use Bitrix\Sale\Result;
 
Loc::loadMessages(__FILE__);

abstract class Cashbox
{
    const UUID_TYPE_CHECK = 'check';
    const UUID_TYPE_REPORT = 'report';
    const UUID_DELIMITER = '|';
 
    const EVENT_ON_GET_CUSTOM_CASHBOX_HANDLERS = 'OnGetCustomCashboxHandlers';
 
    protected const MAX_UUID_LENGTH = 100;

    private $fields = array();
 
    private $ofd;

    public static function init()
    {
        $handlers = static::getHandlerList();
        Main\Loader::registerAutoLoadClasses(null, $handlers);
    }
 
    public static function getCode()
    {
        $className = (new \ReflectionClass(static::class))->getShortName();
        return mb_strtolower($className);
    }

    public static function getHandlerList()
    {
        static $handlerList = array();
 
        if (!$handlerList)
        {
            $zone = '';
            $isCloud = Main\Loader::includeModule("bitrix24");
            if ($isCloud)
            {
                $zone = \CBitrix24::getLicensePrefix();
            }
            elseif (Main\Loader::includeModule('intranet'))
            {
                $zone = \CIntranetUtils::getPortalZone();
            }
            if ($zone === 'ru' && $isCloud)
            {
                $handlerList = [
                    '\Bitrix\Sale\Cashbox\CashboxAtolFarm' => '/bitrix/modules/sale/lib/cashbox/cashboxatolfarm.php',
                    '\Bitrix\Sale\Cashbox\CashboxAtolFarmV4' => '/bitrix/modules/sale/lib/cashbox/cashboxatolfarmv4.php',
                    '\Bitrix\Sale\Cashbox\CashboxAtolFarmV5' => '/bitrix/modules/sale/lib/cashbox/cashboxatolfarmv5.php',
                    '\Bitrix\Sale\Cashbox\CashboxOrangeData' => '/bitrix/modules/sale/lib/cashbox/cashboxorangedata.php',
                    '\Bitrix\Sale\Cashbox\CashboxOrangeDataFfd12' => '/bitrix/modules/sale/lib/cashbox/cashboxorangedataffd12.php',
                    '\Bitrix\Sale\Cashbox\CashboxBusinessRu' => '/bitrix/modules/sale/lib/cashbox/cashboxbusinessru.php',
                    '\Bitrix\Sale\Cashbox\CashboxBusinessRuV5' => '/bitrix/modules/sale/lib/cashbox/cashboxbusinessruv5.php',
                ];
            }
            elseif ($zone === 'ua')
            {
                $handlerList = [
                    '\Bitrix\Sale\Cashbox\CashboxCheckbox' => '/bitrix/modules/sale/lib/cashbox/cashboxcheckbox.php',
                ];
            }
            else
            {
                $handlerList = [
                    '\Bitrix\Sale\Cashbox\CashboxAtolFarm' => '/bitrix/modules/sale/lib/cashbox/cashboxatolfarm.php',
                    '\Bitrix\Sale\Cashbox\CashboxAtolFarmV4' => '/bitrix/modules/sale/lib/cashbox/cashboxatolfarmv4.php',
                    '\Bitrix\Sale\Cashbox\CashboxAtolFarmV5' => '/bitrix/modules/sale/lib/cashbox/cashboxatolfarmv5.php',
                    '\Bitrix\Sale\Cashbox\CashboxOrangeData' => '/bitrix/modules/sale/lib/cashbox/cashboxorangedata.php',
                    '\Bitrix\Sale\Cashbox\CashboxOrangeDataFfd12' => '/bitrix/modules/sale/lib/cashbox/cashboxorangedataffd12.php',
                    '\Bitrix\Sale\Cashbox\CashboxBitrixV2' => '/bitrix/modules/sale/lib/cashbox/cashboxbitrixv2.php',
                    '\Bitrix\Sale\Cashbox\CashboxBitrixV3' => '/bitrix/modules/sale/lib/cashbox/cashboxbitrixv3.php',
                    '\Bitrix\Sale\Cashbox\CashboxBitrix' => '/bitrix/modules/sale/lib/cashbox/cashboxbitrix.php',
                    '\Bitrix\Sale\Cashbox\Cashbox1C' => '/bitrix/modules/sale/lib/cashbox/cashbox1c.php',
                    '\Bitrix\Sale\Cashbox\CashboxCheckbox' => '/bitrix/modules/sale/lib/cashbox/cashboxcheckbox.php',
                    '\Bitrix\Sale\Cashbox\CashboxBusinessRu' => '/bitrix/modules/sale/lib/cashbox/cashboxbusinessru.php',
                    '\Bitrix\Sale\Cashbox\CashboxBusinessRuV5' => '/bitrix/modules/sale/lib/cashbox/cashboxbusinessruv5.php',
                ];
            }
 
            $handlerList['\Bitrix\Sale\Cashbox\CashboxRest'] = '/bitrix/modules/sale/lib/cashbox/cashboxrest.php';
 
            $handlerList['\Bitrix\Sale\Cashbox\CashboxRobokassa'] = '/bitrix/modules/sale/lib/cashbox/cashboxrobokassa.php';
            $handlerList['\Bitrix\Sale\Cashbox\CashboxYooKassa'] = '/bitrix/modules/sale/lib/cashbox/cashboxyookassa.php';
 
            $event = new Main\Event('sale', static::EVENT_ON_GET_CUSTOM_CASHBOX_HANDLERS);
            $event->send();
            $resultList = $event->getResults();
 
            if (is_array($resultList) && !empty($resultList))
            {
                foreach ($resultList as $eventResult)
                {
                    if ($eventResult->getType() === Main\EventResult::SUCCESS)
                    {
                        $params = $eventResult->getParameters();
                        if (!empty($params) && is_array($params))
                            $handlerList = array_merge($handlerList, $params);
                    }
                }
            }
        }
 
        return $handlerList;
    }

    public static function create(array $settings)
    {
        static::init();
 
        $handler = $settings['HANDLER'];
        if (class_exists($handler))
            return new $handler($settings);
 
        return null;
    }

    private function __construct($settings)
    {
        $this->fields = $settings;
    }

    public function getField($name)
    {
        return $this->fields[$name] ?? null;
    }

    public function getOfd()
    {
        if ($this->ofd === null)
        {
            $this->ofd = Ofd::create($this);
        }
 
        return $this->ofd;
    }

    abstract public function buildCheckQuery(Check $check);

    abstract public function buildZReportQuery($id);

    public static function getName()
    {
        throw new NotImplementedException();
    }

    public function getValueFromSettings($name, $code)
    {
        $map = $this->fields['SETTINGS'];
        if (isset($map[$name]))
        {
            if (!is_array($map[$name]))
            {
                return $map[$name];
            }
 
            if (isset($map[$name][$code]))
            {
                return $map[$name][$code];
            }
        }
 
        $settings = static::getSettings($this->getField('KKM_ID'));
 
        return $settings[$name]['ITEMS'][$code]['VALUE'] ?? null;
    }

    public function getCheckLink(array $linkParams)
    {
        if (!$linkParams)
        {
            return '';
        }
 
        if (static::isSupportedDirectCheckLink() && isset($linkParams[Check::PARAM_OFD_RECEIPT_URL]))
        {
            return $linkParams[Check::PARAM_OFD_RECEIPT_URL];
        }
        else
        {
            $ofd = $this->getOfd();
            if ($ofd !== null)
            {
                return $ofd->generateCheckLink($linkParams);
            }
        }
 
        return '';
    }

    protected static function getErrorType($errorCode)
    {
        throw new NotImplementedException();
    }

    protected static function extractCheckData(array $data)
    {
        throw new NotImplementedException();
    }

    protected static function extractZReportData(array $data)
    {
        throw new NotImplementedException();
    }

    public static function applyCheckResult(array $data)
    {
        $result = static::extractCheckData($data);
 
        $checkId = $result['ID'] ?? 0;
 
        return CheckManager::savePrintResult($checkId, $result);
    }

    public static function applyZReportResult(array $data)
    {
        $result = static::extractZReportData($data);
 
        return ReportManager::saveZReportPrintResult($result['ID'], $result);
    }

    public static function getSettings($modelId = 0)
    {
        return array();
    }

    public function validate()
    {
        $fields = $this->fields;
        unset($fields['OFD_SETTINGS']);
 
        $result = $this->validateFields($fields);
 
        $ofd = $this->getOfd();
        if ($ofd)
        {
            $r = $ofd->validate();
            if (!$r->isSuccess())
            {
                $result->addErrors($r->getErrors());
            }
        }
 
        return $result;
    }
 
    protected function validateFields($fields)
    {
        $result = new Result();
 
        foreach ($fields as $code => $value)
        {
            if (is_array($value))
            {
                $r = $this->validateFields($value);
                if (!$r->isSuccess())
                {
                    $result->addErrors($r->getErrors());
                }
 
                continue;
            }
 
            if (
                $this->isRequiredField($code)
                && $value === ''
            )
            {
                $requiredFields = $this->getRequiredFields();
 
                $result->addError(
                    new Main\Error(
                        Loc::getMessage(
                            'SALE_CASHBOX_VALIDATE_ERROR',
                            ['#FIELD_ID#' => $requiredFields[$code]]
                        )
                    )
                );
            }
        }
 
        return $result;
    }
 
    protected function isRequiredField($field) : bool
    {
        $requiredFields = $this->getRequiredFields();
 
        return isset($requiredFields[$field]);
    }

    public static function extractSettingsFromRequest(Main\HttpRequest $request)
    {
        $settings = $request->get('SETTINGS');
 
        return $settings;
    }

    private function getRequiredFields()
    {
        $result = static::getGeneralRequiredFields();
 
        $settings = static::getSettings($this->getField('KKM_ID'));
        foreach ($settings as $groupId => $group)
        {
            foreach ($group['ITEMS'] as $code => $item)
            {
                $isRequired =
                    isset($group['REQUIRED']) && $group['REQUIRED'] === 'Y'
                    || isset($item['REQUIRED']) && $item['REQUIRED'] === 'Y'
                ;
                if ($isRequired)
                {
                    $result[$code] = $item['LABEL'];
                }
            }
        }
 
        return $result;
    }

    public static function getGeneralRequiredFields()
    {
        $map = CashboxTable::getMap();
 
        return array(
            'NAME' => $map['NAME']['title'],
            'EMAIL' => $map['EMAIL']['title'],
            'HANDLER' => $map['HANDLER']['title']
        );
    }

    protected static function buildUuid($type, $id)
    {
        $context = Main\Application::getInstance()->getContext();
        $server = $context->getServer();
        $domain = $server->getServerName();
        $timestamp = time();
 
        $uuid =
            $type.static::UUID_DELIMITER.
            $domain.static::UUID_DELIMITER.
            $id.static::UUID_DELIMITER.
            $timestamp
        ;
 
        return mb_substr($uuid, 0, static::MAX_UUID_LENGTH);
    }

    protected static function parseUuid($uuid)
    {
        $info = explode(static::UUID_DELIMITER, $uuid);
 
        return array('type' => $info[0], 'id' => $info[2]);
    }

    public static function getSupportedKkmModels()
    {
        return array();
    }

    public function isCheckable()
    {
        return $this instanceof ICheckable;
    }

    public function isCorrection()
    {
        return (
            $this instanceof ICorrection
            && $this::isCorrectionOn()
        );
    }

    public static function isCorrectionOn(): bool
    {
        return true;
    }

    public static function getFfdVersion(): ?float
    {
        return null;
    }

    public static function isSupportedFFD105()
    {
        return static::getFfdVersion() >= 1.05;
    }
 
    protected static function isSupportedDirectCheckLink(): bool
    {
        return false;
    }
 
    public static function isOfdSettingsNeeded(): bool
    {
        if (static::isSupportedDirectCheckLink())
        {
            return false;
        }
 
        return true;
    }
}