numerator.php

<?php
namespace Bitrix\Main\Numerator\Model;
 
use Bitrix\Main\Entity\DataManager;
use Bitrix\Main\Entity\DatetimeField;
use Bitrix\Main\Entity\IntegerField;
use Bitrix\Main\Entity\StringField;
use Bitrix\Main\Entity\UpdateResult;
use Bitrix\Main\Error;
use Bitrix\Main\Localization\Loc;
use Bitrix\Main\Numerator\Generator\Contract\Sequenceable;
use Bitrix\Main\Numerator\NumberGeneratorFactory;
use Bitrix\Main\Numerator\Numerator;
use Bitrix\Main\SystemException;
use Bitrix\Main\Type\DateTime;
use Bitrix\Main\Web\Json;
 
class NumeratorTable extends DataManager
{
    public static function getTableName()
    {
        return 'b_numerator';
    }
 
    public static function getMap()
    {
        return [
            (new IntegerField('ID'))
                ->configurePrimary(true)
                ->configureAutocomplete(true)
            ,
            (new StringField('NAME'))
                ->configureRequired(true)
            ,
            (new StringField('TEMPLATE'))
                ->configureRequired(true)
            ,
            (new StringField('SETTINGS'))
                ->configureRequired(true)
            ,
            (new StringField('TYPE'))
                ->configureDefaultValue('DEFAULT')
            ,
            new DatetimeField('CREATED_AT'),
            new IntegerField('CREATED_BY'),
            new DatetimeField('UPDATED_AT'),
            new IntegerField('UPDATED_BY'),
            (new StringField('CODE'))
                ->configureSize(255)
                ->configureUnique()
                ->configureNullable()
                ->addValidator(static function($value) {
                    if (is_null($value) || (is_string($value) && !empty($value)))
                    {
                        return true;
                    }
 
                    return 'CODE should be either NULL or non-empty string';
                })
                ->addValidator(static function($value, $primary) {
                    if (!is_string($value))
                    {
                        return true;
                    }
 
                    $existingId = self::getIdByCode($value);
                    if (!$existingId)
                    {
                        // no rows with this code exists
                        return true;
                    }
 
                    $id = (int)($primary['ID'] ?? 0);
                    if ($id > 0 && $id === $existingId)
                    {
                        return true;
                    }
 
                    return 'Entry with the same CODE already exists';
                })
            ,
        ];
    }
 
    private static function getCurrentUserId()
    {
        global $USER;
        $userId = 0;
        if ($USER && is_object($USER) && $USER->isAuthorized())
        {
            $userId = $USER->getID();
        }
        return $userId;
    }
 
    public static function getNumeratorList($type, $sort)
    {
        $filter = ['=TYPE' => $type];
        if ($type == 'ALL')
        {
            $filter = [];
        }
        $params = [
            'select' => ['*'],
            'filter' => $filter,
        ];
        if ($sort)
        {
            $params['order'] = $sort;
        }
        $results = NumeratorTable::getList($params)->fetchAll();
        foreach ($results as &$numerator)
        {
            $numerator['id'] = $numerator['ID'];
            $numerator['name'] = $numerator['NAME'];
            $numerator['template'] = $numerator['TEMPLATE'];
            $numerator['type'] = $numerator['TYPE'];
            $numerator['code'] = $numerator['CODE'];
        }
        return $results;
    }
 
    public static function saveNumerator($numeratorId, $numeratorFields)
    {
        $fields = [
            'NAME'       => $numeratorFields['NAME'],
            'TEMPLATE'   => $numeratorFields['TEMPLATE'],
            'TYPE'       => $numeratorFields['TYPE'],
            'SETTINGS'   => Json::encode($numeratorFields['SETTINGS']),
            'UPDATED_AT' => new DateTime(),
            'UPDATED_BY' => static::getCurrentUserId(),
            'CODE'       => $numeratorFields['CODE'] ?? null,
        ];
        if ($numeratorId)
        {
            if (!(Numerator::load($numeratorId)))
            {
                $result = new UpdateResult();
                $result->addError(new Error(Loc::getMessage('MAIN_NUMERATOR_EDIT_NUMERATOR_NOT_FOUND_ERROR')));
                return $result;
            }
 
            $updateRes = NumeratorTable::update($numeratorId, $fields);
 
            if ($updateRes->isSuccess())
            {
                $numerator = Numerator::load($numeratorId);
                $isNewNumSequential = $numerator->hasSequentialNumber();
                if (!$isNewNumSequential)
                {
                    NumeratorSequenceTable::deleteByNumeratorId($numeratorId);
                }
            }
            return $updateRes;
        }
        $fields['CREATED_AT'] = new DateTime();
        $fields['CREATED_BY'] = static::getCurrentUserId();
        return NumeratorTable::add($fields);
    }
 
    public static function loadSettings($numeratorId)
    {
        $numerator = static::getList([
            'select' => ['*',],
            'filter' => ['=ID' => $numeratorId],
        ])->fetch();
 
        if ($numerator)
        {
            $result = [];
            $result[Numerator::getType()] = [
                'idFromDb' => $numerator['ID'],
                'name'     => $numerator['NAME'],
                'template' => $numerator['TEMPLATE'],
                'type'     => $numerator['TYPE'],
                'code'     => $numerator['CODE'],
            ];
            $numeratorGenerators = Json::decode($numerator['SETTINGS']);
            $numberGeneratorFactory = new NumberGeneratorFactory();
            foreach ($numeratorGenerators as $generatorType => $numeratorGenerator)
            {
                $class = $numberGeneratorFactory->getClassByType($generatorType);
                if (in_array(Sequenceable::class, class_implements($class)))
                {
                    $numeratorGenerators[$generatorType]['numeratorId'] = $numeratorId;
                }
            }
            return array_merge($result, $numeratorGenerators);
        }
 
        return $numerator;
    }
 
    public static function getIdByCode($code): ?int
    {
        $code = (string)$code;
        if (empty($code))
        {
            return null;
        }
 
        $row =
            static::query()
                ->setSelect(['ID'])
                ->where('CODE', $code)
                ->setLimit(1)
                ->setCacheTtl(3600)
                ->fetch()
        ;
 
        if ($row && isset($row['ID']))
        {
            return (int)$row['ID'];
        }
 
        return null;
    }
}