globalvartable.php

<?php
 
namespace Bitrix\Bizproc\Workflow\Type\Entity;
 
use Bitrix\Bizproc\FieldType;
use Bitrix\Main;
use Bitrix\Main\ORM\Event;
 
\Bitrix\Bizproc\Workflow\Type\GlobalsManager::loadLanguageFile();
 
class GlobalVarTable extends Main\ORM\Data\DataManager
{
    public static function getTableName(): string
    {
        return 'b_bp_global_var';
    }
 
    public static function getMap(): array
    {
        return [
            'ID' => [
                'data_type' => 'string',
                'primary' => true,
                'title' => Main\Localization\Loc::getMessage('BIZPROC_WF_TYPE_GLOBALS_MANAGER_COLUMN_ID_TITLE'),
            ],
            'NAME' => [
                'data_type' => 'string',
                'title' => Main\Localization\Loc::getMessage('BIZPROC_WF_TYPE_GLOBALS_MANAGER_COLUMN_NAME_TITLE'),
            ],
            'DESCRIPTION' => [
                'data_type' => 'string',
                'title' => Main\Localization\Loc::getMessage('BIZPROC_WF_TYPE_GLOBALS_MANAGER_COLUMN_DESCRIPTION_TITLE'),
            ],
            'PROPERTY_TYPE' => [
                'data_type' => 'string',
                'title' => Main\Localization\Loc::getMessage('BIZPROC_WF_TYPE_GLOBALS_MANAGER_COLUMN_PROPERTY_TYPE_TITLE'),
            ],
            'IS_REQUIRED' => [
                'data_type' => 'boolean',
                'values' => ['N', 'Y'],
                'title' => Main\Localization\Loc::getMessage('BIZPROC_WF_TYPE_GLOBALS_MANAGER_COLUMN_IS_REQUIRED_TITLE'),
            ],
            'IS_MULTIPLE' => [
                'data_type' => 'boolean',
                'values' => ['N', 'Y'],
                'title' => Main\Localization\Loc::getMessage('BIZPROC_WF_TYPE_GLOBALS_MANAGER_COLUMN_IS_MULTIPLE_TITLE'),
            ],
            'PROPERTY_OPTIONS' => [
                'data_type' => 'string',
                'serialized' => true,
                'validation' => [__CLASS__, 'validateTextField'],
                'title' => Main\Localization\Loc::getMessage('BIZPROC_WF_TYPE_GLOBALS_MANAGER_COLUMN_PROPERTY_OPTIONS_TITLE'),
            ],
            'PROPERTY_SETTINGS' => [
                'data_type' => 'string',
                'serialized' => true,
                'title' => Main\Localization\Loc::getMessage('BIZPROC_WF_TYPE_GLOBALS_MANAGER_COLUMN_PROPERTY_SETTINGS_TITLE'),
            ],
            'PROPERTY_VALUE' => [
                'data_type' => 'string',
                'serialized' => true,
                'validation' => [__CLASS__, 'validateTextField'],
                'title' => Main\Localization\Loc::getMessage('BIZPROC_WF_TYPE_GLOBALS_MANAGER_COLUMN_PROPERTY_VALUE_TITLE'),
            ],
            'CREATED_DATE' => [
                'data_type' => 'datetime',
                'title' => Main\Localization\Loc::getMessage('BIZPROC_WF_TYPE_GLOBALS_MANAGER_COLUMN_CREATED_DATE_TITLE'),
            ],
            'CREATED_BY' => [
                'data_type' => 'integer',
                'title' => Main\Localization\Loc::getMessage('BIZPROC_WF_TYPE_GLOBALS_MANAGER_COLUMN_CREATED_BY_TITLE'),
            ],
            'VISIBILITY' => [
                'data_type' => 'string',
                'title' => Main\Localization\Loc::getMessage('BIZPROC_WF_TYPE_GLOBALS_MANAGER_COLUMN_VISIBILITY_TITLE'),
            ],
            'MODIFIED_DATE' => [
                'data_type' => 'datetime',
                'title' => Main\Localization\Loc::getMessage('BIZPROC_WF_TYPE_GLOBALS_MANAGER_COLUMN_MODIFIED_DATE_TITLE'),
            ],
            'MODIFIED_BY' => [
                'data_type' => 'integer',
                'title' => Main\Localization\Loc::getMessage('BIZPROC_WF_TYPE_GLOBALS_MANAGER_COLUMN_MODIFIED_BY_TITLE'),
            ],
        ];
    }
 
    public static function validateTextField()
    {
        return [
            function($value, $primary, $row, \Bitrix\Main\ORM\Fields\Field $field)
            {
                $errorMsg = Main\Localization\Loc::getMessage(
                    'BIZPROC_WF_TYPE_GLOBALS_MANAGER_COLUMN_PROPERTIES_TEXT_FIELD_LENGTH_ERROR',
                    ['#FIELD_TITLE#' => $field->getTitle()]
                );
 
                return strlen(serialize($value)) < 65535 ? true : $errorMsg;
            }
        ];
    }
 
    public static function upsertByProperty(string $varId, array $property, int $userId = null)
    {
        $property = static::normalizePropertyForUpsert($property, $userId);
 
        // PROPERTY_SETTINGS ?
        $fields = [
            'NAME' => trim($property['Name']),
            'DESCRIPTION' => $property['Description'],
            'PROPERTY_TYPE' => $property['Type'],
            'IS_REQUIRED' => $property['Required'] ? 'Y' : 'N',
            'IS_MULTIPLE' => $property['Multiple'] ? 'Y' : 'N',
            'PROPERTY_OPTIONS' => $property['Options'],
            'PROPERTY_VALUE' => $property['Default'],
            'VISIBILITY' => $property['Visibility'],
            'CREATED_BY' => $property['CreatedBy'],
            'CREATED_DATE' => $property['CreatedDate'],
            'MODIFIED_DATE' => $property['ModifiedDate'],
            'MODIFIED_BY' => $property['ModifiedBy'],
        ];
 
        if ($userId === null) // update by robot
        {
            unset($fields['CREATED_BY'], $fields['CREATED_DATE'], $fields['MODIFIED_BY'], $fields['MODIFIED_DATE']);
        }
 
        $oldProperty = static::getByPrimary($varId)->fetch();
        if ($oldProperty)
        {
            if (isset($oldProperty['CREATED_BY']))
            {
                unset($fields['CREATED_BY'], $fields['CREATED_DATE']);
            }
 
            $result = static::update($varId, $fields);
        }
        else
        {
            $fields['ID'] = $varId;
            $result = static::add($fields);
        }
 
        return $result;
    }
 
    public static function convertToProperty(array $fields): array
    {
        // Settings ?
        return [
            'Name' => $fields['NAME'],
            'Description' => $fields['DESCRIPTION'],
            'Type' => $fields['PROPERTY_TYPE'],
            'Required' => \CBPHelper::getBool($fields['IS_REQUIRED']),
            'Multiple' => \CBPHelper::getBool($fields['IS_MULTIPLE']),
            'Options' => $fields['PROPERTY_OPTIONS'],
            'Default' => $fields['PROPERTY_VALUE'],
            'CreatedBy' => (int)$fields['CREATED_BY'],
            'CreatedDate' => $fields['CREATED_DATE'],
            'Visibility' => $fields['VISIBILITY'],
            'ModifiedBy' => (int)$fields['MODIFIED_BY'],
            'ModifiedDate' => $fields['MODIFIED_DATE'],
        ];
    }
 
    private static function normalizePropertyForUpsert($property, int $userId = null): array
    {
        $normalized = [];
        $normalizedAsField = FieldType::normalizeProperty($property);
 
        $normalized['Visibility'] = isset($property['Visibility']) ? (string)$property['Visibility'] : 'GLOBAL';
        $normalized['ModifiedBy'] = $userId;
        $normalized['CreatedBy'] = $userId;
        $normalized['ModifiedDate'] = new Main\Type\DateTime();
        $normalized['CreatedDate'] = $normalized['ModifiedDate'];
 
        return array_merge($normalized, $normalizedAsField);
    }
 
    public static function onBeforeUpdate(Event $event)
    {
        $result = new Main\ORM\EventResult();
        $result->unsetFields(['PROPERTY_TYPE', 'IS_REQUIRED', 'IS_MULTIPLE', 'VISIBILITY']);
 
        return $result;
    }
}