base.php

<?php
 
namespace Bitrix\Catalog\Product\SystemField;
 
use Bitrix\Main;
use Bitrix\Main\Loader;
use Bitrix\Main\Localization\LanguageTable;
use Bitrix\Main\Localization\Loc;
use Bitrix\Catalog\Grid\Panel\ProductGroupAction;
 
abstract class Base
{
    public const FIELD_ID = '';
 
    public const TYPE_ID = '';
 
    protected const FIELD_PREFIX = 'UF_';
 
    protected static ?bool $bitrix24Include = null;
 
    protected static ?array $languages = null;
 
    private static ?array $fields = null;
 
    protected static ?array $allowedProductTypeList = null;
 
    protected static ?array $allowedOperations = null;
 
    public static function getDescription(): ?array
    {
        if (!static::isAllowed())
        {
            return null;
        }
 
        return [
            'ID' => static::getFieldId(),
            'TYPE' => static::getTypeId(),
            'TITLE' => static::getTitle(),
        ];
    }
 
    abstract public static function getConfig(): ?array;
 
    abstract public static function isAllowed(): bool;
 
    public static function getTitle(): string
    {
        $result = static::getTitleInternal();
 
        return ($result ?? static::getUserFieldName(static::getFieldId()));
    }
 
    abstract protected static function getTitleInternal(): ?string;
 
    abstract public static function getUserFieldBaseParam(): array;
 
    public static function isExists(): bool
    {
        $row = static::load();
        return !empty($row);
    }
 
    public static function create(): Main\Result
    {
        if (!static::isAllowed())
        {
            return static::getCommonError('CATALOG_SYSTEMFIELD_ERR_DISALLOWED_FIELD');
        }
 
        $description = static::getDescription();
        if (
            $description === null
            || empty($description['TYPE'])
            || empty($description['ID'])
        )
        {
            return static::getCommonError('CATALOG_SYSTEMFIELD_ERR_BAD_FIELD_DESCRIPTION');
        }
        if (!is_a($description['TYPE'], Type\Base::class, true))
        {
            return static::getCommonError('CATALOG_SYSTEMFIELD_ERR_BAD_FIELD_TYPE');
        }
 
        $className = $description['TYPE'];
 
        $config = static::getConfig();
        if ($config === null)
        {
            return static::getCommonError('CATALOG_SYSTEMFIELD_ERR_BAD_CONFIG_DESCRIPTION');
        }
 
        $result = $className::create($config);
        if ($result->isSuccess())
        {
            static::updateProductFormConfiguration();
        }
 
        return $result;
    }
 
    public static function updateProductFormConfiguration(): void {}
 
    public static function getTypeId(): string
    {
        return static::TYPE_ID;
    }
 
    public static function getFieldId(): string
    {
        return static::FIELD_ID;
    }
 
    protected static function isBitrix24(): bool
    {
        if (self::$bitrix24Include === null)
        {
            self::$bitrix24Include = Loader::includeModule('bitrix24');
        }
 
        return self::$bitrix24Include;
    }
 
    protected static function getUserFieldName(string $id): string
    {
        return self::FIELD_PREFIX.$id;
    }
 
    protected static function getLanguages(): array
    {
        if (self::$languages === null)
        {
            self::$languages = [];
            $iterator = LanguageTable::getList([
                'select' => ['ID'],
                'filter' => ['=ACTIVE' => 'Y']
            ]);
            while ($row = $iterator->fetch())
            {
                self::$languages[] = $row['ID'];
            }
            unset($row, $iterator);
        }
 
        return self::$languages;
    }
 
    protected static function getMessages(string $file, array $messageIds): array
    {
        $messageList = array_fill_keys(array_keys($messageIds), []);
        $languages = self::getLanguages();
        foreach ($languages as $languageId)
        {
            $mess = Loc::loadLanguageFile($file, $languageId);
            foreach ($messageIds as $index => $phrase)
            {
                $message = (string)($mess[$phrase] ?? null);
                if ($message !== '')
                {
                    $messageList[$index][$languageId] = $message;
                }
            }
        }
        unset($message, $languageId, $languages);
 
        return $messageList;
    }
 
    protected static function getCommonError(string $errorCode): Main\Result
    {
        $result = new Main\Result();
        $result->addError(new Main\Error(
            Loc::getMessage(
                $errorCode,
                ['#TITLE#' => static::getTitle()]
            )
        ));
        return $result;
    }
 
    public static function getGridAction(ProductGroupAction $panel): ?array
    {
        if (!static::isAllowed())
        {
            return null;
        }
 
        $description = static::getDescription();
        if (
            $description === null
            || empty($description['TYPE'])
            || empty($description['ID'])
        )
        {
            return null;
        }
        if (
            !class_exists($description['TYPE'])
            || !is_a($description['TYPE'], Type\Base::class, true))
        {
            return null;
        }
 
        $actionConfig = static::getGridActionConfig($panel);
        if ($actionConfig === null)
        {
            return null;
        }
 
        $className = $description['TYPE'];
 
        return $className::getGridAction($actionConfig);
    }
 
    protected static function getGridActionConfig(ProductGroupAction $panel): ?array
    {
        return null;
    }
 
    public static function load(): ?array
    {
        if (self::$fields === null)
        {
            self::$fields = [];
        }
        $className = get_called_class();
        if (!array_key_exists($className, self::$fields))
        {
            self::$fields[$className] = self::loadInternal($className);
        }
 
        return self::$fields[$className];
    }
 
    public static function clearCache(): void
    {
        self::$languages = null;
        self::$fields = null;
        self::$allowedProductTypeList = null;
        self::$allowedOperations = null;
    }
 
    private static function loadInternal(string $className): ?array
    {
        $config = $className::getUserFieldBaseParam();
        if (empty($config))
        {
            return null;
        }
        if ($config['USER_TYPE_ID'] === null)
        {
            return null;
        }
 
        $iterator = Main\UserFieldTable::getList([
            'select' => array_merge(
                ['*'],
                Main\UserFieldTable::getLabelsSelect()
            ),
            'filter' => [
                '=ENTITY_ID' => $config['ENTITY_ID'],
                '=FIELD_NAME' => $config['FIELD_NAME'],
                '=USER_TYPE_ID' => $config['USER_TYPE_ID'],
            ],
            'runtime' => [
                Main\UserFieldTable::getLabelsReference('', Loc::getCurrentLang()),
            ],
        ]);
        $row = $iterator->fetch();
        unset($iterator, $config);
 
        if (!empty($row))
        {
            return static::afterLoadInternalModify($row);
        }
 
        return null;
    }
 
    protected static function afterLoadInternalModify(array $row): array
    {
        $row['ID'] = (int)$row['ID'];
        $row['SORT'] = (int)$row['SORT'];
 
        foreach (Main\UserFieldTable::getLabelFields() as $fieldName)
        {
            if ($fieldName === 'LANGUAGE_ID')
            {
                unset($row[$fieldName]);
            }
            else
            {
                if (isset($row[$fieldName]) && $row[$fieldName] === '')
                {
                    $row[$fieldName] = null;
                }
            }
        }
 
        return $row;
    }
 
    public static function checkAllowedProductType(int $type): bool
    {
        if (self::$allowedProductTypeList === null)
        {
            self::$allowedProductTypeList = [];
        }
        $className = get_called_class();
        if (!isset(self::$allowedProductTypeList[$className]))
        {
            self::$allowedProductTypeList[$className] = static::getAllowedProductTypeList();
        }
 
        return in_array($type, self::$allowedProductTypeList[$className], true);
    }
 
    public static function getAllowedProductTypeList(): array
    {
        return [];
    }
 
    public static function checkRestictions(array $restrictions): bool
    {
        if (isset($restrictions['TYPE']))
        {
            if (!static::checkAllowedProductType($restrictions['TYPE']))
            {
                return false;
            }
        }
 
        return true;
    }
 
    public static function getGroupActionRequest(ProductGroupAction $panel): ?array
    {
        $field = static::getUserFieldBaseParam();
        $requestName = $panel->getFormRowFieldName($field['FIELD_NAME']);
        $value = Main\Context::getCurrent()->getRequest()->get($requestName);
 
        if ($value === null)
        {
            return null;
        }
        if ($field['MULTIPLE'] === 'Y' && !is_array($value))
        {
            $value = [$value];
        }
 
        return [$field['FIELD_NAME'] => $value];
    }
 
    public static function checkAllowedOperation(string $operation): bool
    {
        if (self::$allowedOperations === null)
        {
            self::$allowedOperations = [];
        }
        $className = get_called_class();
        if (!isset(self::$allowedOperations[$className]))
        {
            self::$allowedOperations[$className] = array_fill_keys(static::getAllowedOperations(), true);
        }
 
        return isset(self::$allowedOperations[$className][$operation]);
    }
 
    public static function getAllowedOperations(): array
    {
        return [];
    }
 
    public static function getOperationSelectFieldList(string $operation): array
    {
        return [];
    }
 
    public static function prepareValue(string $operation, array $productRow): array
    {
        return $productRow;
    }
 
    public static function renderAdminFormControl(array $field, array $product, array $config): ?string
    {
        if (!static::isAllowed())
        {
            return null;
        }
        if (!static::checkRestictions($product))
        {
            return null;
        }
        if (!static::isExists())
        {
            return null;
        }
 
        $userFieldManager = Main\UserField\Internal\UserFieldHelper::getInstance()->getManager();
        $request = Main\Context::getCurrent()->getRequest();
 
        return $userFieldManager->GetEditFormHTML(
            $config['FROM_FORM'],
            $request->getPost($field['FIELD_NAME']) ?? '',
            $field
        );
    }
 
    public static function getUiDescription(array $restrictions): ?array
    {
        if (
            static::isAllowed()
            && static::checkRestictions($restrictions)
            && static::isExists()
        )
        {
            $userField = static::load();
            if ($userField === null)
            {
                return null;
            }
 
            $description = [
                'entity' => 'product',
                'name' => $userField['FIELD_NAME'],
                'originalName' => $userField['FIELD_NAME'],
                'title' => $userField['EDIT_FORM_LABEL'] ?? $userField['FIELD_NAME'],
                'hint' => $userField['HELP_MESSAGE'],
                'editable' => true,
                'required' => $userField['MANDATORY'] === 'Y',
                'multiple' => $userField['MULTIPLE'] === 'Y',
                'placeholders' => null,
                'defaultValue' => $userField['SETTINGS']['DEFAULT_VALUE'] ?? '',
                'optionFlags' => 1, // showAlways */
                'options' => [
                    'showCode' => 'true',
                ],
                'data' => [],
            ];
 
            return static::getUiDescriptionInternal($description, $userField, $restrictions);
        }
 
        return null;
    }
 
    protected static function getUiDescriptionInternal(array $description, array $userField, array $restrictions): ?array
    {
        return $description;
    }
}