base.php

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

<?php
 
namespace Bitrix\Bizproc\BaseType;
 
use Bitrix\Main;
use Bitrix\Main\Localization\Loc;
use Bitrix\Bizproc\FieldType;

class Base
{
    public static function getName(): string
    {
        return static::getType();
    }

    public static function getType()
    {
        return FieldType::STRING;
    }

    protected static $formats = [
        'printable' => [
            'callable' => 'formatValuePrintable',
            'separator' => ', ',
        ],
    ];

    protected static function getFormatCallable($format)
    {
        $format = mb_strtolower($format);
        $formats = static::getFormats();
        if (isset($formats[$format]['callable']))
        {
            $callable = $formats[$format]['callable'];
            if (is_string($callable))
            {
                $callable = [get_called_class(), $callable];
            }
 
            return $callable;
        }
 
        return null;
    }

    protected static function getFormatSeparator($format)
    {
        $format = mb_strtolower($format);
        $separator = ', '; //default - coma
        $formats = static::getFormats();
        if (isset($formats[$format]['separator']))
        {
            $separator = $formats[$format]['separator'];
        }
 
        return $separator;
    }

    public static function addFormat($name, array $options)
    {
        $name = mb_strtolower($name);
        if (empty($options['callable']))
        {
            throw new Main\ArgumentException('Callable property in format options is not set.');
        }
 
        static::$formats[$name] = $options;
    }

    public static function getFormats()
    {
        return static::$formats;
    }

    public static function toSingleValue(FieldType $fieldType, $value)
    {
        return $value;
    }

    public static function formatValueMultiple(FieldType $fieldType, $value, $format = 'printable')
    {
        $value = (array)$value;
 
        foreach ($value as $k => $v)
        {
            $value[$k] = static::formatValueSingle($fieldType, $v, $format);
        }
 
        return implode(static::getFormatSeparator($format), $value);
    }

    public static function formatValueSingle(FieldType $fieldType, $value, $format = 'printable')
    {
        $callable = static::getFormatCallable($format);
        $value = static::toSingleValue($fieldType, $value);
 
        if (is_callable($callable))
        {
            return call_user_func($callable, $fieldType, $value);
        }
 
        //return original value if format not found
        return $value;
    }

    protected static function formatValuePrintable(FieldType $fieldType, $value)
    {
        return static::convertValueSingle(clone $fieldType, $value, StringType::class);
    }

    public static function convertValueMultiple(FieldType $fieldType, $value, $toTypeClass)
    {
        $value = (array)$value;
        foreach ($value as $k => $v)
        {
            $value[$k] = static::convertValueSingle($fieldType, $v, $toTypeClass);
        }
 
        return $value;
    }

    public static function convertValueSingle(FieldType $fieldType, $value, $toTypeClass)
    {
        $value = static::toSingleValue($fieldType, $value);
        $result = static::convertTo($fieldType, $value, $toTypeClass);
        if ($result === null)
            $result = $toTypeClass::convertFrom($fieldType, $value, get_called_class());
 
        if ($result !== null)
            $fieldType->setTypeClass($toTypeClass);
 
        return $result !== null ? $result : $value;
    }

    public static function convertTo(FieldType $fieldType, $value, $toTypeClass)
    {
        return null;
    }

    public static function convertFrom(FieldType $fieldType, $value, $fromTypeClass)
    {
        return null;
    }

    public static function getConversionMap()
    {
        return [
            //to
            [],
            //from
            [],
        ];
    }

    public static function mergeValue(FieldType $fieldType, array $baseValue, $appendValue): array
    {
        if (\CBPHelper::isEmptyValue($baseValue))
        {
            return (array)$appendValue;
        }
 
        if (!is_array($appendValue))
        {
            $baseValue[] = $appendValue;
 
            return $baseValue;
        }
 
        $isSimple = !\CBPHelper::isAssociativeArray($baseValue) && !\CBPHelper::isAssociativeArray($appendValue);
        $result = $isSimple ? array_merge($baseValue, $appendValue) : $baseValue + $appendValue;
 
        if ($isSimple)
        {
            $result = array_values(array_unique($result));
        }
 
        return $result;
    }

    protected static $errors = [];

    public static function addError($error)
    {
        static::$errors[] = $error;
    }

    public static function addErrors(array $errors)
    {
        static::$errors = array_merge(static::$errors, $errors);
    }

    public static function getErrors()
    {
        return static::$errors;
    }

    protected static function cleanErrors()
    {
        static::$errors = [];
    }

    protected static function generateControlId(array $field)
    {
        $id = 'id_' . $field['Field'];
        $index = isset($field['Index']) ? $field['Index'] : null;
        if ($index !== null)
        {
            $id .= '__n' . $index . '_';
        }
 
        return $id;
    }

    protected static function generateControlName(array $field)
    {
        $name = $field['Field'];
        $index = isset($field['Index']) ? $field['Index'] : null;
        if ($index !== null)
        {
            //new multiple name style
            $name .= '[]';
        }
 
        return $name;
    }
 
    protected static function generateControlClassName(FieldType $fieldType, array $field)
    {
        $prefix = 'bizproc-type-control';
        $classes = [$prefix];
        $classes[] = $prefix . '-' . static::getType();
 
        if ($fieldType->isMultiple())
        {
            $classes[] = $prefix . '-multiple';
        }
        if ($fieldType->isRequired())
        {
            $classes[] = $prefix . '-required';
        }
 
        return implode(' ', $classes);
    }

    protected static function wrapCloneableControls(array $controls, $wrapperId)
    {
        $wrapperId = (string)$wrapperId;
        $renderResult = '<table width="100%" border="0" cellpadding="2" cellspacing="2" id="BizprocCloneable_'
            . htmlspecialcharsbx($wrapperId) . '">';
 
        foreach ($controls as $control)
        {
            $renderResult .= '<tr><td>' . $control . '</td></tr>';
        }
        $renderResult .= '</table>';
        $renderResult .= sprintf(
            '<input type="button" value="%s" onclick="BX.Bizproc.cloneTypeControl(\'BizprocCloneable_%s\')"/><br />',
            Loc::getMessage('BPDT_BASE_ADD'),
            htmlspecialcharsbx($wrapperId)
        );
 
        return $renderResult;
    }

    protected static function renderPublicMultipleWrapper(FieldType $fieldType, array $field, array $controls)
    {
        $messageAdd = Loc::getMessage('BPDT_BASE_ADD');
 
        $name = Main\Text\HtmlFilter::encode(\CUtil::jsEscape(static::generateControlName($field)));
        $property = Main\Text\HtmlFilter::encode(Main\Web\Json::encode($fieldType->getProperty()));
 
        $renderResult = implode('', $controls) . <<<HTML
                <div>
                    <a onclick="BX.Bizproc.FieldType.cloneControl({$property}, '{$name}', this.parentNode); return false;"
                        class="bizproc-type-control-clone-btn">
                        {$messageAdd}
                    </a>
                </div>
HTML;
 
        return $renderResult;
    }

    protected static function renderControl(FieldType $fieldType, array $field, $value, $allowSelection, $renderMode)
    {
        $name = static::generateControlName($field);
        $controlId = static::generateControlId($field);
        $className = static::generateControlClassName($fieldType, $field);
 
        if ($renderMode&FieldType::RENDER_MODE_PUBLIC)
        {
            $selectorAttributes = '';
            if ($allowSelection)
            {
                $selectorAttributes = sprintf(
                    'data-role="inline-selector-target" data-property="%s" ',
                    htmlspecialcharsbx(Main\Web\Json::encode($fieldType->getProperty()))
                );
            }
 
            return sprintf(
                '<input type="text" class="%s" name="%s" value="%s" placeholder="%s" %s/>',
                htmlspecialcharsbx($className),
                htmlspecialcharsbx($name),
                htmlspecialcharsbx((string)$value),
                htmlspecialcharsbx($fieldType->getDescription()),
                $selectorAttributes
            );
        }
 
        // example: control rendering
        return sprintf(
            '<input type="text" class="%s" size="40" id="%s" name="%s" value="%s"/>',
            htmlspecialcharsbx($className),
            htmlspecialcharsbx($controlId),
            htmlspecialcharsbx($name),
            htmlspecialcharsbx((string)$value)
        );
    }

    public static function canRenderControl($renderMode)
    {
        if ($renderMode&FieldType::RENDER_MODE_MOBILE)
        {
            return false;
        }
 
        return true;
    }

    public static function renderControlSingle(FieldType $fieldType, array $field, $value, $allowSelection, $renderMode)
    {
        $value = static::toSingleValue($fieldType, $value);
        $selectorValue = null;
        if ($allowSelection && \CBPActivity::isExpression($value))
        {
            $selectorValue = $value;
            $value = null;
        }
 
        $renderResult = static::renderControl($fieldType, $field, $value, $allowSelection, $renderMode);
 
        if ($allowSelection)
        {
            $renderResult .= static::renderControlSelector($field, $selectorValue, true, '', $fieldType);
        }
 
        return $renderResult;
    }

    public static function renderControlMultiple(FieldType $fieldType, array $field, $value, $allowSelection, $renderMode)
    {
        $selectorValue = null;
        $typeValue = [];
        if (!is_array($value) || is_array($value) && \CBPHelper::isAssociativeArray($value))
        {
            $value = [$value];
        }
 
        foreach ($value as $v)
        {
            if (\CBPActivity::isExpression($v))
            {
                $selectorValue = $v;
            }
            else
            {
                $typeValue[] = $v;
            }
        }
        // need to show at least one control
        if (empty($typeValue))
        {
            $typeValue[] = null;
        }
 
        $controls = [];
 
        foreach ($typeValue as $k => $v)
        {
            $singleField = $field;
            $singleField['Index'] = $k;
            $controls[] = static::renderControl(
                $fieldType,
                $singleField,
                $v,
                $allowSelection,
                $renderMode
            );
        }
 
        if ($renderMode&FieldType::RENDER_MODE_PUBLIC)
        {
            $renderResult = static::renderPublicMultipleWrapper($fieldType, $field, $controls);
        }
        else
        {
            $renderResult = static::wrapCloneableControls($controls, static::generateControlName($field));
        }
 
        if ($allowSelection)
        {
            $renderResult .= static::renderControlSelector($field, $selectorValue, true, '', $fieldType);
        }
 
        return $renderResult;
    }

    protected static function renderControlSelector(array $field, $value = null, $showInput = false, $selectorMode = '', FieldType $fieldType = null)
    {
        $html = '';
        $controlId = static::generateControlId($field);
        $name = static::generateControlName($field);
 
        if ($showInput)
        {
            if ($showInput !== 'combine')
            {
                $controlId = $controlId . '_text';
                $name = static::generateControlName($field) . '_text';
            }
 
            $cols = 70;
            $rows = max((static::getType() === FieldType::TEXT ? 5 : 1), min(5, ceil(mb_strlen((string)$value)) / $cols));
            $html = '<table cellpadding="0" cellspacing="0" border="0" width="100%" style="margin: 2px 0"><tr><td valign="top"><textarea ';
            $html .= 'rows="' . $rows . '" ';
            $html .= 'cols="' . $cols . '" ';
            $html .= 'name="' . htmlspecialcharsbx($name) . '" ';
            $html .= 'id="' . htmlspecialcharsbx($controlId) . '" ';
            $html .= 'style="width: 100%"';
            $html .= '>' . htmlspecialcharsbx((string)$value);
            $html .= '</textarea></td>';
            $html .= '<td valign="top" style="padding-left:4px" width="30">';
        }
        $html .= static::renderControlSelectorButton($controlId, $fieldType, $selectorMode);
 
        if ($showInput)
        {
            $html .= '</td></tr></table>';
        }
 
        return $html;
    }
 
    protected static function renderControlSelectorButton($controlId, FieldType $fieldType, $selectorMode = '')
    {
        $baseType = $fieldType ? $fieldType->getBaseType() : null;
        $selectorProps = Main\Web\Json::encode([
            'controlId' => $controlId,
            'baseType' => $baseType,
            'type' => $fieldType ? $fieldType->getType() : null,
            'documentType' => $fieldType ? $fieldType->getDocumentType() : null,
            'documentId' => $fieldType ? $fieldType->getDocumentId() : null,
        ]);
 
        return sprintf(
            '<input type="button" value="..." onclick="BPAShowSelector(\'%s\', \'%s\', %s, null, %s);" data-role="bp-selector-button" data-bp-selector-props="%s">',
            \CUtil::jsEscape(htmlspecialcharsbx($controlId)),
            \CUtil::jsEscape(htmlspecialcharsbx($baseType)),
            $selectorMode ? '\'' . \CUtil::jsEscape(htmlspecialcharsbx($selectorMode)) . '\'' : 'null',
            htmlspecialcharsbx(Main\Web\Json::encode($fieldType ? $fieldType->getDocumentType() : null)),
            htmlspecialcharsbx($selectorProps)
        );
    }

    public static function renderControlOptions(FieldType $fieldType, $callbackFunctionName, $value)
    {
        return '';
    }

    protected static function extractValue(FieldType $fieldType, array $field, array $request)
    {
        $name = $field['Field'];
        $value = isset($request[$name]) ? $request[$name] : null;
        $fieldIndex = isset($field['Index']) ? $field['Index'] : null;
        if (is_array($value) && !\CBPHelper::isAssociativeArray($value))
        {
            if ($fieldIndex !== null)
            {
                $value = isset($value[$fieldIndex]) ? $value[$fieldIndex] : null;
            }
            else
            {
                reset($value);
                $value = current($value);
            }
        }
 
        return $value;
    }

    public static function extractValueSingle(FieldType $fieldType, array $field, array $request)
    {
        static::cleanErrors();
        $result = static::extractValue($fieldType, $field, $request);
        if ($result === null || $result === '')
        {
            $nameText = $field['Field'] . '_text';
            $text = isset($request[$nameText]) ? $request[$nameText] : null;
            if (\CBPActivity::isExpression($text))
                $result = $text;
        }
 
        return $result;
    }

    public static function extractValueMultiple(FieldType $fieldType, array $field, array $request)
    {
        static::cleanErrors();
 
        $name = $field['Field'];
        $value = isset($request[$name]) ? $request[$name] : [];
 
        if (!is_array($value) || is_array($value) && \CBPHelper::isAssociativeArray($value))
        {
            $value = [$value];
        }
 
        foreach ($value as $k => $v)
        {
            $field['Index'] = $k;
            $result = static::extractValue($fieldType, $field, $request);
            if ($result === null || $result === '')
            {
                unset($value[$k]);
            }
            else
            {
                $value[$k] = $result;
            }
        }
 
        //append selector value
        $nameText = $field['Field'] . '_text';
        $text = isset($request[$nameText]) ? $request[$nameText] : null;
        if (\CBPActivity::isExpression($text))
        {
            $value[] = $text;
        }
 
        return array_values($value);
    }

    public static function clearValueSingle(FieldType $fieldType, $value)
    {
        //Method fires when workflow was complete
    }

    public static function clearValueMultiple(FieldType $fieldType, $value)
    {
        if (!is_array($value) || is_array($value) && \CBPHelper::isAssociativeArray($value))
        {
            $value = [$value];
        }
 
        foreach ($value as $v)
        {
            static::clearValueSingle($fieldType, $v);
        }
    }

    public static function internalizeValue(FieldType $fieldType, $context, $value)
    {
        return $value;
    }

    public static function internalizeValueSingle(FieldType $fieldType, $context, $value)
    {
        return static::internalizeValue($fieldType, $context, $value);
    }

    public static function internalizeValueMultiple(FieldType $fieldType, $context, $value)
    {
        if (is_array($value))
        {
            foreach ($value as $k => $v)
            {
                $value[$k] = static::internalizeValue($fieldType, $context, $v);
            }
        }
 
        return $value;
    }

    public static function externalizeValue(FieldType $fieldType, $context, $value)
    {
        if (is_object($value) && method_exists($value, '__toString'))
        {
            return (string)$value;
        }
 
        return $value;
    }

    public static function externalizeValueSingle(FieldType $fieldType, $context, $value)
    {
        return static::externalizeValue($fieldType, $context, $value);
    }

    public static function externalizeValueMultiple(FieldType $fieldType, $context, $value)
    {
        if (!is_array($value) || \CBPHelper::isAssociativeArray($value))
        {
            $value = [$value];
        }
 
        foreach ($value as $k => $v)
        {
            $value[$k] = static::externalizeValue($fieldType, $context, $v);
        }
 
        return $value;
    }

    public static function compareValues($valueA, $valueB)
    {
        if ($valueA > $valueB)
        {
            return 1;
        }
 
        if ($valueA < $valueB)
        {
            return -1;
        }
 
        return 0;
    }
 
    public static function validateValueSingle($value, FieldType $fieldType)
    {
        return static::toSingleValue($fieldType, $value);
    }
 
    public static function validateValueMultiple($value, FieldType $fieldType): array
    {
        if (!is_array($value))
        {
            $value = [$value];
        }
 
        foreach ($value as $k => $v)
        {
            $value[$k] = static::validateValueSingle($v, $fieldType);
        }
 
        return $value;
    }
 
    public static function convertPropertyToView(FieldType $fieldType, int $viewMode, array $property): array
    {
        return $property;
    }
}