configuration.php

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

<?php
 
namespace Bitrix\Sender\Message;
 
use Bitrix\Main\ArgumentException;
use Bitrix\Main\Error;
use Bitrix\Main\Localization\Loc;
use Bitrix\Main\Result;
 
Loc::getMessage(__FILE__);
 
class Configuration
{
    protected $id;

    protected $data = [];

    protected $view;

    protected $options = [];

    public function __construct(array $data = [])
    {
        if ($data)
        {
            $this->data = $data;
        }
    }

    public function getId()
    {
        return $this->id;
    }

    public function setId($id)
    {
        $this->id = $id;
    }

    public function getView()
    {
        if (!is_callable($this->view))
        {
            return null;
        }
 
        return call_user_func_array($this->view, []);
    }

    public function setView($view)
    {
        $this->view = $view;
    }

    public function set($key, $value)
    {
        $this->data[$key] = $value;
        $option = $this->getOption($key);
        if ($option)
        {
            $option->setValue($value);
        }
 
        return $value;
    }

    public function get($key, $defaultValue = null)
    {
        if (isset ($this->data[$key]))
        {
            if ($this->data[$key] instanceof \Closure)
            {
                return $this->data[$key]();
            }
 
            return $this->data[$key];
        }
 
        $option = $this->getOption($key);
        if ($option)
        {
            return $option->getValue();
        }
 
        return $defaultValue;
    }

    public function getReadonlyView($key, $defaultValue = null)
    {
        $value = $this->get($key, $defaultValue);
        $option = $this->getOption($key);

        if (!empty($option->getItems()))
        {
            foreach ($option->getItems() as $item)
            {
                if (!empty($value) && isset($item['code']) && $item['code'] == $value)
                {
                    return $item['value'];
                }
            }
        }
 
        if ($option)
        {
            return $option->getReadonlyView($value);
        }
 
        return $value;
    }

    public function getOption($key)
    {
        foreach ($this->options as $option)
        {
            if ($option->getCode() == $key)
            {
                return $option;
            }
        }
 
        return null;
    }

    public function hasOptions()
    {
        return count($this->options) > 0;
    }

    public function getOptions()
    {
        return $this->options;
    }

    public function getArrayOptions()
    {
        return self::convertToArray($this->options);
    }

    public static function convertToArray(array $options)
    {
        $list = [];
        foreach ($options as $option)
        {
            $list[] = $option->getArray();
        }
 
        return $list;
    }

    public function addOption(ConfigurationOption $option, $targetOptionCode = null, $isInsertAfter = true)
    {
        if ($option->isTemplated() && $this->hasTemplatedOption())
        {
            throw new ArgumentException('Templated option already exists.');
        }
 
        $uniqueTypes = [
            ConfigurationOption::TYPE_TEMPLATE_TYPE,
            ConfigurationOption::TYPE_TEMPLATE_ID,
        ];
        if (in_array($option->getType(), $uniqueTypes, true) && $this->hasOptionsOfType($option->getType()))
        {
            throw new ArgumentException('Option with type \'' . $option->getType() . '\' already exists.');
        }
 
        if ($targetOptionCode)
        {
            $index = array_search($this->getOption($targetOptionCode), $this->options);
            if ($isInsertAfter)
            {
                $index++;
            }
            $this->options = array_merge(
                array_slice($this->options, 0, $index),
                [$option],
                array_slice($this->options, $index)
            );
        }
        else
        {
            $this->options[] = $option;
        }
    }

    public function setArrayOptions(array $options)
    {
        foreach ($options as $option)
        {
            $this->addOption(new ConfigurationOption($option));
        }
    }

    public function getTemplatedOption()
    {
        foreach ($this->options as $option)
        {
            if ($option->isTemplated())
            {
                return $option;
            }
        }
 
        return null;
    }

    public function hasTemplatedOption()
    {
        return $this->getTemplatedOption() !== null;
    }

    public function getOptionsByGroup($group)
    {
        $result = [];
        foreach ($this->options as $option)
        {
            if ($option->getGroup() == $group)
            {
                $result[] = $option;
            }
        }
 
        return $result;
    }

    public function getOptionsByType($type)
    {
        $result = [];
        foreach ($this->options as $option)
        {
            if ($option->getType() == $type)
            {
                $result[] = $option;
            }
        }
 
        return $result;
    }

    public function getOptionByType($type)
    {
        return current($this->getOptionsByType($type));
    }

    public function hasOptionsOfType($type)
    {
        return count($this->getOptionsByType($type)) > 0;
    }

    public function checkOptions()
    {
        $result = new Result();
        $this->checkRequiredOptions($result);
 
        return $result;
    }

    protected function checkRequiredOptions(Result $result = null)
    {
        if (is_null($result))
        {
            $result = new Result;
        }
 
        foreach ($this->getOptions() as $option)
        {
            if (!$option->isRequired())
            {
                continue;
            }
 
            if ($option->hasValue())
            {
                continue;
            }
 
            $result->addError(new Error(
                Loc::getMessage(
                    'SENDER_MESSAGE_CONFIG_ERROR_EMPTY_REQUIRED_FIELD',
                    ['%name%' => $option->getName()]
                )
            ));
        }
 
        return $result;
    }
}