numerator.php

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

<?php
 
namespace Bitrix\Main\Numerator;
 
use Bitrix\Main\ORM\Fields\ExpressionField;
use Bitrix\Main\ORM\Query\Query;
use Bitrix\Main\Error;
use Bitrix\Main\Event;
use Bitrix\Main\Localization\Loc;
use Bitrix\Main\Numerator\Generator\Contract\DynamicConfigurable;
use Bitrix\Main\Numerator\Generator\Contract\Sequenceable;
use Bitrix\Main\Numerator\Generator\Contract\UserConfigurable;
use Bitrix\Main\Numerator\Generator\NumberGenerator;
use Bitrix\Main\Numerator\Model\NumeratorSequenceTable;
use Bitrix\Main\Numerator\Model\NumeratorTable;
use Bitrix\Main\Result;
 
Loc::loadMessages(__FILE__);

class Numerator
{
    private $template;
    private $type;
    private $name;
    private $generators = [];
    private $code;
    private $id;
 
    const NUMERATOR_DEFAULT_TYPE = 'DEFAULT';
    const NUMERATOR_ALL_GENERATORS_TYPE = 'ALL';
    static protected $numberGeneratorFactory;

    public static function create()
    {
        return new static();
    }
 
    private function __construct()
    {
    }

    protected static function getNumberGeneratorFactory()
    {
        if (static::$numberGeneratorFactory === null)
        {
            static::$numberGeneratorFactory = new NumberGeneratorFactory();
        }
        return static::$numberGeneratorFactory;
    }

    public static function getSettingsFields($numeratorType)
    {
        $numeratorsAmount = static::getNextNumeratorNumber($numeratorType);
        $settings = ['settingsFields' => [], 'settingsWords' => [],];
        $settings['settingsFields'][static::getType()] = [
            [
                'title' => Loc::getMessage('TITLE_BITRIX_MAIN_NUMERATOR_NUMERATOR_NAME_TITLE'),
                'settingName' => 'name',
                'type' => 'string',
                'default' => Loc::getMessage('NUMERATOR_DEFAULT_NUMERATOR_NAME', ['#NUMBER#' => $numeratorsAmount]),
            ],
            [
                'settingName' => 'template',
                'type' => 'string',
                'title' => Loc::getMessage('TITLE_BITRIX_MAIN_NUMERATOR_NUMERATOR_TEMPLATE_TITLE'),
            ],
        ];
        $allGeneratorsClasses = static::getNumberGeneratorFactory()->getClasses();
        foreach ($allGeneratorsClasses as $class)
        {
            $isAvailableForAll = $class::getAvailableForType() == static::NUMERATOR_DEFAULT_TYPE;
            if ($isAvailableForAll || $class::getAvailableForType() == $numeratorType)
            {
                if (in_array(UserConfigurable::class, class_implements($class)))
                {
                    $settings['settingsFields'][$class::getType()] = $class::getSettingsFields();
                }
                $settings['settingsWords'][$class::getType()] = $class::getTemplateWordsSettings();
            }
        }
        $settings['settingsWords'] = array_merge_recursive($settings['settingsWords'], static::getUserDefinedTemplateWords($numeratorType));
 
        return $settings;
    }

    protected static function getUserDefinedTemplateWords($numeratorType)
    {
        $settingsWords = [];
        $event = new Event('main', 'onBuildNumeratorTemplateWordsList', ['numeratorType' => $numeratorType]);
        $event->send();
 
        if ($event->getResults())
        {
            $count = 0;
            foreach ($event->getResults() as $eventResult)
            {
                $eventParameters = $eventResult->getParameters();
                if (isset($eventParameters['CODE']) && isset($eventParameters['NAME']))
                {
                    $settingsWords["UserDefinedVirtualGenerator" . $count++] = [
                        NumberGenerator::USER_DEFINED_SYMBOL_START . $eventParameters['CODE'] . NumberGenerator::USER_DEFINED_SYMBOL_END
                        => $eventParameters['NAME'],
                    ];
                }
                else
                {
                    foreach ($eventParameters as $parameters)
                    {
                        if (isset($parameters['CODE']) && isset($parameters['NAME']))
                        {
                            $settingsWords["UserDefinedVirtualGenerator" . $count++] = [
                                NumberGenerator::USER_DEFINED_SYMBOL_START . $parameters['CODE'] . NumberGenerator::USER_DEFINED_SYMBOL_END
                                => $parameters['NAME'],
                            ];
                        }
                    }
                }
            }
        }
        return $settingsWords;
    }

    public static function getListByType($type = null, $sort = null)
    {
        if (is_null($type))
        {
            $type = static::NUMERATOR_DEFAULT_TYPE;
        }
        return NumeratorTable::getNumeratorList($type, $sort);
    }

    public static function getOneByType($type = null)
    {
        if (is_null($type))
        {
            $type = static::NUMERATOR_DEFAULT_TYPE;
        }
        $numeratorSettings = static::getListByType($type);
        if ($numeratorSettings && isset($numeratorSettings[0]))
        {
            return $numeratorSettings[0];
        }
        return null;
    }

    public static function getTemplateWordsForType($isAvailableByType = null)
    {
        if (is_null($isAvailableByType))
        {
            $isAvailableByType = static::NUMERATOR_DEFAULT_TYPE;
        }
        $settings = [];
        $allGeneratorsClasses = static::getNumberGeneratorFactory()->getClasses();
        foreach ($allGeneratorsClasses as $class)
        {
            $isAllTypesNeeded = $isAvailableByType === static::NUMERATOR_ALL_GENERATORS_TYPE;
            $isAvailableByDefault = $class::getAvailableForType() == static::NUMERATOR_DEFAULT_TYPE;
            if ($isAllTypesNeeded || $isAvailableByDefault || $class::getAvailableForType() == $isAvailableByType)
            {
                $settings = array_merge($settings, [$class::getType() => $class::getTemplateWordsForParse()]);
            }
        }
        return $settings;
    }

    private function setNumberHashForGenerators($hash)
    {
        foreach ($this->generators as $index => $generator)
        {
            if ($generator instanceof Sequenceable)
            {
                $generator->setNumberHash($hash);
            }
        }
    }

    public function getNext($hash = null)
    {
        $this->setNumberHashForGenerators($hash);
        $nextNumber = $this->template;
        foreach ($this->generators as $index => $generator)
        {
            $nextNumber = $generator->parseTemplate($nextNumber);
        }
 
        return $nextNumber;
    }

    private function setDynamicConfigForGenerators($dynamicConfig)
    {
        if ($dynamicConfig !== null)
        {
            foreach ($this->generators as $generator)
            {
                if ($generator instanceof DynamicConfigurable)
                {
                    $generator->setDynamicConfig($dynamicConfig);
                }
            }
        }
    }

    public static function update($numId, $config)
    {
        $numerator = static::create();
        $config[static::getType()]['idFromDb'] = $numId;
        $result = $numerator->setNumeratorConfig($config);
        if ($result->isSuccess())
        {
            $result = $numerator->setGeneratorsConfig($config);
            if ($result->isSuccess())
            {
                return $numerator->save();
            }
        }
        return $result;
    }

    public function setHash($hashable)
    {
        if ($hashable instanceof Hashable)
        {
            $this->setNumberHashForGenerators($hashable->getHash());
        }
    }

    public function setDynamicConfig($dynamicConfig)
    {
        $this->setDynamicConfigForGenerators($dynamicConfig);
    }

    public function save()
    {
        $settingsToStore = $this->getSettings();
        $result = NumeratorTable::saveNumerator($this->id, [
            'CODE' => $this->code,
            'NAME' => $this->name,
            'TEMPLATE' => $this->template,
            'TYPE' => $this->type ? $this->type : static::NUMERATOR_DEFAULT_TYPE,
            'SETTINGS' => $settingsToStore,
        ]);
        if ($result->isSuccess())
        {
            $this->id = $result->getId();
        }
 
        return $result;
    }

    private function getSettings()
    {
        $settingsToStore = [];
        foreach ($this->generators as $numberGenerator)
        {
            if ($numberGenerator instanceof UserConfigurable)
            {
                $settingsToStore = array_merge($settingsToStore, [$this->getTypeOfGenerator($numberGenerator) => $numberGenerator->getConfig(),]);
            }
        }
        return $settingsToStore;
    }

    public static function load($numeratorId, $source = null)
    {
        if ($config = NumeratorTable::loadSettings($numeratorId))
        {
            $numerator = new static();
            $result = $numerator->setConfig($config);
            if (($result->isSuccess()))
            {
                $numerator->setDynamicConfig($source);
                $numerator->setHash($source);
                return $numerator;
            }
        }
        return null;
    }

    public static function loadByCode($code, $source = null)
    {
        $id = NumeratorTable::getIdByCode($code);
        if ($id === null)
        {
            return null;
        }
 
        return self::load($id, $source);
    }

    public static function delete($id)
    {
        if (!$id)
        {
            return (new Result())->addError(new Error('Numerator id is required'));
        }
        $result = NumeratorTable::delete((int)$id);
        if ($result->isSuccess())
        {
            NumeratorSequenceTable::deleteByNumeratorId($id);
        }
        return $result;
    }

    public function previewNextNumber($hash = null)
    {
        $this->setNumberHashForGenerators($hash);
        $nextNumber = $this->template;
        foreach ($this->generators as $index => $generator)
        {
            $nextNumber = $generator->parseTemplateForPreview($nextNumber);
        }
 
        return $nextNumber;
    }

    public function previewNextSequentialNumber($hash = null)
    {
        $this->setNumberHashForGenerators($hash);
        foreach ($this->generators as $generator)
        {
            if ($generator instanceof Sequenceable)
            {
                return $generator->getNextNumber($this->id);
            }
        }
        return null;
    }

    public function hasSequentialNumber()
    {
        foreach ($this->generators as $generator)
        {
            if ($generator instanceof Sequenceable)
            {
                return true;
            }
        }
        return false;
    }

    public function setNextSequentialNumber($nextNumber, $whereNumber = null, $hash = null)
    {
        $this->setNumberHashForGenerators($hash);
        foreach ($this->generators as $generator)
        {
            if ($generator instanceof Sequenceable)
            {
                return $generator->setNextNumber($this->id, $nextNumber, $whereNumber);
            }
        }
        return (new Result())->addError(new Error(Loc::getMessage('NUMERATOR_SET_SEQUENTIAL_IS_IMPOSSIBLE')));
    }

    public function getConfig()
    {
        $selfConfig = [
            static::getType() => [
                'name' => $this->name,
                'template' => $this->template,
                'id' => $this->id,
                'code' => $this->code,
                'type' => $this->type,
            ],
        ];
        $generatorConfigs = [];
        foreach ($this->generators as $generator)
        {
            if ($generator instanceof UserConfigurable)
            {
                $generatorConfigs[$this->getTypeOfGenerator($generator)] = $generator->getConfig();
            }
        }
        return $selfConfig + $generatorConfigs;
    }

    public function setConfig($config)
    {
        $result = $this->setNumeratorConfig($config);
        if (!$result->isSuccess())
        {
            return $result;
        };
 
        return $this->setGeneratorsConfig($config);
    }

    private function setNumeratorConfig($config)
    {
        $result = $this->validate($config);
        if (!$result->isSuccess())
        {
            return $result;
        };
        $this->type = trim($config[static::getType()]['type']);
        $this->setTemplate($config[static::getType()]['template']);
        $this->name = trim($config[static::getType()]['name']);
        if (isset($config[static::getType()]['idFromDb']))
        {
            $this->id = $config[static::getType()]['idFromDb'];
        }
        if (array_key_exists('code', $config[static::getType()]))
        {
            $code = $config[static::getType()]['code'];
            if (is_string($code))
            {
                $code = trim($code);
            }
 
            $this->code = (is_string($code) && !empty($code)) ? $code : null;
        }
        return $result;
    }
 
    private function createGenerators()
    {
        $generatorTypesToCreate = $this->getGeneratorTypesByTemplate();
        if ($this->type === static::NUMERATOR_ALL_GENERATORS_TYPE)
        {
            return $this->createGeneratorsOfTypes($generatorTypesToCreate);
        }
 
        $factory = static::getNumberGeneratorFactory();
        $typesForCurrentNumerator = [];
        foreach ($generatorTypesToCreate as $index => $generatorType)
        {
            $generatorClass = $factory->getClassByType($generatorType);
            if ($generatorClass::getAvailableForType() === $this->type
                || $generatorClass::getAvailableForType() === static::NUMERATOR_DEFAULT_TYPE
            )
            {
                $typesForCurrentNumerator[] = $generatorType;
            }
        }
 
        return $this->createGeneratorsOfTypes($typesForCurrentNumerator);
    }

    private function setGeneratorsConfig($config)
    {
        $generators = $this->createGenerators();
        foreach ($generators as $index => $generator)
        {
            $this->addGenerator($generator);
        }
        $result = $this->validateGeneratorsConfig($config);
 
        if ($result->isSuccess())
        {
            foreach ($this->generators as $generator)
            {
                if ($generator instanceof UserConfigurable)
                {
                    $generator->setConfig($config[$this->getTypeOfGenerator($generator)] ?? null);
                }
            }
        };
 
        return $result;
    }

    public static function getType()
    {
        return str_replace('\\', '_', static::class);
    }

    protected function setTemplate($template)
    {
        $this->template = str_replace(["\r\n", "\n"], '', trim($template));
    }

    private function getTypeToTemplateWords()
    {
        $result = [];
        $typesToClasses = static::getNumberGeneratorFactory()->getTypeToClassMap();
        foreach ($typesToClasses as $type => $class)
        {
            $result[$type] = $class::getTemplateWordsForParse();
        }
        return $result;
    }

    private function getGeneratorTypesByTemplate()
    {
        $generatorTypes = [];
        foreach ($this->getTypeToTemplateWords() as $type => $words)
        {
            foreach ($words as $word)
            {
                if (mb_stripos($this->template, $word) !== false)
                {
                    $generatorTypes[$type] = 1;
                }
            }
        }
 
        return array_keys($generatorTypes);
    }

    private function createGeneratorsOfTypes($generatorTypesToCreate)
    {
        $generators = [];
        foreach ($generatorTypesToCreate as $key => $type)
        {
            if ($generator = static::getNumberGeneratorFactory()->createGeneratorByType($type))
            {
                $generators[] = $generator;
            }
        }
 
        return $generators;
    }

    private function validate($numeratorConfig)
    {
        $result = new Result();
        if (!isset($numeratorConfig[static::getType()]))
        {
            $result->addError(new Error('Numerator config is required'));
        }
        $numeratorBaseConfig = $numeratorConfig[static::getType()];
 
        if (isset($numeratorBaseConfig['code']))
        {
            if (is_string($numeratorBaseConfig['code']) && !empty($numeratorBaseConfig['code']))
            {
                $idWithSameCode = NumeratorTable::getIdByCode($numeratorBaseConfig['code']);
                if ($idWithSameCode !== null)
                {
                    $id = (int)($numeratorBaseConfig['idFromDb'] ?? null);
                    if ($id <= 0 || $idWithSameCode !== $id)
                    {
                        $result->addError(new Error('Another numerator with same code already exists'));
                    }
                }
            }
            elseif (is_string($numeratorBaseConfig['code']))
            {
                $result->addError(new Error('Numerator code should be a non-empty string, if it is provided'));
            }
            else
            {
                $result->addError(new Error('Numerator code should be a string'));
            }
        }
        if (!(isset($numeratorBaseConfig['name']) && $numeratorBaseConfig['name']))
        {
            $result->addError(new Error(Loc::getMessage('NUMERATOR_VALIDATE_NAME_IS_REQUIRED')));
        }
        $resultTemplate = $this->validateTemplate($numeratorBaseConfig['template']);
        if ($resultTemplate->getErrors())
        {
            $result->addErrors($resultTemplate->getErrors());
        }
 
        return $result;
    }

    private function validateTemplate($template)
    {
        if (!($template && $template != ''))
        {
            return (new Result())->addError(new Error(Loc::getMessage('NUMERATOR_VALIDATE_TEMPLATE_IS_REQUIRED')));
        }
        return new Result();
    }

    private static function getNextNumeratorNumber($isAvailableForType)
    {
        $query = new Query(NumeratorTable::getEntity());
        $query->addSelect(new ExpressionField('COUNT', 'COUNT(*)'));
        $query->where('TYPE', $isAvailableForType);
        $result = $query->exec()->fetch();
        return $result ? $result['COUNT'] + 1 : 1;
    }

    private function validateGeneratorsConfig($config)
    {
        $result = new Result();
        foreach ($this->generators as $generator)
        {
            if ($generator instanceof UserConfigurable)
            {
                $generatorResult = ($generator->validateConfig($config));
                if ($generatorResult->getErrors())
                {
                    $result->addErrors($generatorResult->getErrors());
                }
            }
        }
 
        return $result;
    }

    private function addGenerator($generator)
    {
        $this->generators[] = $generator;
    }

    private function getTypeOfGenerator($generator)
    {
        $generatorClass = get_class($generator);
        return $generatorClass::getType();
    }
 
    public function getId()
    {
        return $this->id;
    }
}