basetype.php

<?php
 
namespace Bitrix\Main\UserField\Types;
 
abstract class BaseType
{
    public const
        MODE_EDIT = 'main.edit',
        MODE_VIEW = 'main.view';
 
    private const
        MODE_ADMIN_SETTINGS = 'main.admin_settings',
        MODE_EDIT_FORM = 'main.edit_form',
        MODE_FILTER_HTML = 'main.filter_html',
        MODE_ADMIN_LIST_VIEW_HTML = 'main.admin_list_view_html',
        MODE_ADMIN_LIST_EDIT_HTML = 'main.admin_list_edit_html',
        MODE_PUBLIC_TEXT = 'main.public_text';
 
    protected const
        USER_TYPE_ID = null,
        RENDER_COMPONENT = null; // component name, sample bitrix:main.field.string
 
    public static function getUserTypeDescription(): array
    {
        return array_merge(static::getBaseUserTypeDescription(), static::getDescription());
    }
 
    protected static function getDescription(): array
    {
        return [];
    }
 
    protected static function getBaseUserTypeDescription(): array
    {
        return [
            'USER_TYPE_ID' => static::USER_TYPE_ID,
            'CLASS_NAME' => static::class,
            'EDIT_CALLBACK' => [static::class, 'renderEdit'],
            'VIEW_CALLBACK' => [static::class, 'renderView'],
            'USE_FIELD_COMPONENT' => true,
        ];
    }
 
    public static function renderField(array $userField, ?array $additionalParameters = []): string
    {
        return self::getHtml($userField, $additionalParameters);
    }
 
    public static function renderView(array $userField, ?array $additionalParameters = []): string
    {
        $additionalParameters['mode'] = self::MODE_VIEW;
        return self::getHtml($userField, $additionalParameters);
    }
 
    public static function renderEdit(array $userField, ?array $additionalParameters = []): string
    {
        $additionalParameters['mode'] = self::MODE_EDIT;
        return self::getHtml($userField, $additionalParameters);
    }
 
    public static function renderSettings($userField, ?array $additionalParameters, $varsFromForm): string
    {
        $additionalParameters['mode'] = self::MODE_ADMIN_SETTINGS;
        $additionalParameters['bVarsFromForm'] = $varsFromForm;
        return self::getHtml($userField, $additionalParameters);
    }
 
    public static function renderEditForm(array $userField, ?array $additionalParameters): string
    {
        $additionalParameters['mode'] = self::MODE_EDIT_FORM;
        $userField['USE_COMPONENT'] = 'Y';
        return self::getHtml($userField, $additionalParameters);
    }
 
    public static function renderAdminListView(array $userField, ?array $additionalParameters): string
    {
        $additionalParameters['mode'] = self::MODE_ADMIN_LIST_VIEW_HTML;
        return self::getHtml($userField, $additionalParameters);
    }
 
    public static function renderAdminListEdit(array $userField, ?array $additionalParameters)
    {
        $additionalParameters['mode'] = self::MODE_ADMIN_LIST_EDIT_HTML;
        return self::getHtml($userField, $additionalParameters);
    }
 
    public static function renderFilter(array $userField, ?array $additionalParameters): string
    {
        $additionalParameters['mode'] = self::MODE_FILTER_HTML;
        return self::getHtml($userField, $additionalParameters);
    }
 
    public static function renderText(array $userField): string
    {
        $additionalParameters = [];
        $additionalParameters['mode'] = self::MODE_PUBLIC_TEXT;
        return self::getHtml($userField, $additionalParameters);
    }
 
    private static function getHtml($userField, $additionalParameters): string
    {
        global $APPLICATION;
        ob_start();
        $APPLICATION->IncludeComponent(
            self::getComponentName(),
            '',
            [
                'userField' => $userField,
                'additionalParameters' => $additionalParameters,
            ]
        );
        return ob_get_clean();
    }
 
    private static function getComponentName(): string
    {
        if (str_contains(static::RENDER_COMPONENT, ':'))
        {
            return static::RENDER_COMPONENT;
        }
        return 'bitrix:' . static::RENDER_COMPONENT;
    }
 
    public static function getSettingsHtml($userField, ?array $additionalParameters, $varsFromForm): string
    {
        return static::renderSettings($userField, $additionalParameters, $varsFromForm);
    }
 
    public static function getPublicView(array $userField, ?array $additionalParameters = []): string
    {
        return static::renderView($userField, $additionalParameters);
    }
 
    public static function getPublicEdit(array $userField, ?array $additionalParameters = []): string
    {
        return static::renderEdit($userField, $additionalParameters);
    }
 
    public static function getEditFormHtml(array $userField, ?array $additionalParameters): string
    {
        return static::renderEditForm($userField, $additionalParameters);
    }
 
    public static function getAdminListViewHtml(array $userField, ?array $additionalParameters)
    {
        return static::renderAdminListView($userField, $additionalParameters);
    }
 
    public static function getAdminListEditHTML(array $userField, ?array $additionalParameters)
    {
        return static::renderAdminListEdit($userField, $additionalParameters);
    }
 
    public static function getFilterHtml(array $userField, ?array $additionalParameters): string
    {
        return static::renderFilter($userField, $additionalParameters);
    }
 
    public static function getPublicText(array $userField): string
    {
        return static::renderText($userField);
    }
 
    public static function getDefaultValue(array $userField, array $additionalParameters = [])
    {
        $value = ($userField['SETTINGS']['DEFAULT_VALUE'] ?? null);
        return ($userField['MULTIPLE'] === 'Y' ? [$value] : $value);
    }
 
    abstract public static function getDbColumnType(): string;
 
    public static function isMandatorySupported(): bool
    {
        return true;
    }
 
    public static function isMultiplicitySupported(): bool
    {
        return true;
    }
}