stringtype.php

<?php
 
namespace Bitrix\Main\UserField\Types;
 
use Bitrix\Main\Localization\Loc;
use Bitrix\Main\Text\HtmlFilter;
use CUserTypeManager;
 
Loc::loadMessages(__FILE__);
 
class StringType extends BaseType
{
    public const
        USER_TYPE_ID = 'string',
        RENDER_COMPONENT = 'bitrix:main.field.string';
 
    public static function getDescription(): array
    {
        return [
            'DESCRIPTION' => Loc::getMessage('USER_TYPE_STRING_DESCRIPTION'),
            'BASE_TYPE' => CUserTypeManager::BASE_TYPE_STRING,
        ];
    }
 
    public static function getDbColumnType(): string
    {
        $connection = \Bitrix\Main\Application::getConnection();
        $helper = $connection->getSqlHelper();
        return $helper->getColumnTypeByField(new \Bitrix\Main\ORM\Fields\TextField('x'));
    }
 
    public static function prepareSettings(array $userField): array
    {
        $size = (int)($userField['SETTINGS']['SIZE'] ?? 0);
        $rows = (int)($userField['SETTINGS']['ROWS'] ?? 0);
        $min = (int)($userField['SETTINGS']['MIN_LENGTH'] ?? 0);
        $max = (int)($userField['SETTINGS']['MAX_LENGTH'] ?? 0);
 
        $regExp = '';
        if (
            is_array($userField['SETTINGS'])
            && !empty($userField['SETTINGS']['REGEXP'])
            //Checking the correctness of the regular expression entered by the user
            && @preg_match($userField['SETTINGS']['REGEXP'], null) !== false
        )
        {
            $regExp = $userField['SETTINGS']['REGEXP'];
        }
 
        return [
            'SIZE' => ($size <= 1 ? 20 : ($size > 255 ? 225 : $size)),
            'ROWS' => ($rows <= 1 ? 1 : ($rows > 50 ? 50 : $rows)),
            'REGEXP' => $regExp,
            'MIN_LENGTH' => $min,
            'MAX_LENGTH' => $max,
            'DEFAULT_VALUE' => is_array($userField['SETTINGS']) ? $userField['SETTINGS']['DEFAULT_VALUE'] : '',
        ];
    }
 
    public static function getFilterData(?array $userField, array $additionalSettings): array
    {
        return [
            'id' => $additionalSettings['ID'],
            'name' => $additionalSettings['NAME'],
            'filterable' => ''
        ];
    }
 
    public static function checkFields(array $userField, $value): array
    {
        $fieldName = HtmlFilter::encode(
            $userField['EDIT_FORM_LABEL'] <> ''
                ? $userField['EDIT_FORM_LABEL'] : $userField['FIELD_NAME']
        );
 
        $msg = [];
        if($value != '' && mb_strlen($value) < $userField['SETTINGS']['MIN_LENGTH'])
        {
            $msg[] = [
                'id' => $userField['FIELD_NAME'],
                'text' => Loc::GetMessage('USER_TYPE_STRING_MIN_LEGTH_ERROR',
                    [
                        '#FIELD_NAME#' => $fieldName,
                        '#MIN_LENGTH#' => $userField['SETTINGS']['MIN_LENGTH']
                    ]
                )
            ];
        }
        if(
            $userField['SETTINGS']['MAX_LENGTH'] > 0
            && mb_strlen($value) > $userField['SETTINGS']['MAX_LENGTH']
        )
        {
            $msg[] = [
                'id' => $userField['FIELD_NAME'],
                'text' => Loc::GetMessage('USER_TYPE_STRING_MAX_LEGTH_ERROR',
                    [
                        '#FIELD_NAME#' => $fieldName,
                        '#MAX_LENGTH#' => $userField['SETTINGS']['MAX_LENGTH']
                    ]
                ),
            ];
        }
        if(
            !empty($userField['SETTINGS']['REGEXP'])
            && (string) $value !== ''
            && !preg_match($userField['SETTINGS']['REGEXP'], $value)
        )
        {
            $msg[] = [
                'id' => $userField['FIELD_NAME'],
                'text' => ($userField['ERROR_MESSAGE'] != '' ?
                    $userField['ERROR_MESSAGE'] :
                    Loc::GetMessage('USER_TYPE_STRING_REGEXP_ERROR',
                        [
                            '#FIELD_NAME#' => $fieldName
                        ]
                    )
                ),
            ];
        }
        return $msg;
    }
 
    public static function onSearchIndex(array $userField): ?string
    {
        if(is_array($userField['VALUE']))
        {
            $result = implode('\r\n', $userField['VALUE']);
        }
        else
        {
            $result = $userField['VALUE'];
        }
 
        return $result;
    }
 
    //<editor-fold desc="Events and methods..."  defaultstate="collapsed">
    /*
        public static function onBeforeGetPublicView($event)
        {
            $params = $event->getParameters();
            $arUserField = &$params[0];
            $arAdditionalParameters = &$params[1];
            if ($arUserField['USER_TYPE_ID'] == 'string')
            {
                $arUserField['VIEW_COMPONENT_NAME'] = 'my:system.field.view';
                $arUserField['VIEW_COMPONENT_TEMPLATE'] = 'string';
            }
        }
    */
 
    /*
        public static function onGetPublicView($event)
        {
            $params = $event->getParameters();
            $arUserField = $params[0];
            $arAdditionalParameters = $params[1];
            if ($arUserField['USER_TYPE_ID'] == 'string')
            {
                $html = 'demo string';
                return new \Bitrix\Main\EventResult(\Bitrix\Main\EventResult::SUCCESS, $html);
            }
        }
    */
 
    /*
        public static function onAfterGetPublicView($event)
        {
            $params = $event->getParameters();
            $arUserField = $params[0];
            $arAdditionalParameters = $params[1];
            $html = &$params[2];
            if ($arUserField['USER_TYPE_ID'] == 'string')
            {
                $html .= '!';
            }
        }
    */
 
    /*  static function OnBeforeSave($arUserField, $value)
    {
        if(strlen($value)>0)
            return ''.round(doubleval($value), $arUserField['SETTINGS']['PRECISION']);
    }*/
    //</editor-fold>
}