Пресет настроек смарт-процесса

Класс находится в разработке и будет подвергнут рефакторингу. Не рекомендуется использовать напрямую.

Класс служит для доступа к данным о пресетах, а также для их запаковывания / распаковывания из json.

Каждый пресет состоит из двух "наборов" данных.

Первый набор относится к данным о самом пресете - его название, описание, иконка и т.д.

Второй набор - это собственно пресет настроек смарт-процесса.

Применение настроек смарт-процессов осуществляется на фронтенде через модель.

Класс воспроизводит интерфейс \JsonSerializable.

Пресеты не хранятся в базе данных. Набор предустановленных пресетов захардкожен прямо в брокере.

Методы

Метод	Описание	С версии
public function __construct(array $fields, array $data) $fields- данные о пресете. Массив имеет следующую структуру: title - название пресета; id - идентификатор пресета. Должен строиться по правилу `{venorName}:{code}`; disabled - флаг того, доступен пресет к использованию или нет; category - строковый идентификатор раздела пресетов; description - описание пресета; icon - абсолютный путь к иконке. $data- настройки смарт-процесса. Может содержать любые доступные к изменению поля в `camelCase` нотации.	Конструктор.
public static function createFromJson (string $json): ?TypePreset	Если строка $json имеет правильную структуру, то метод вернет новый объект пресета.
public function jsonSerialize(): array	Вернет описание пресета в виде json.
public function getTitle(): string	Вернет название пресета.
public function setTitle(string $title): self	Установит название пресета $title.
public function getCategory(): string	Вернет код раздела.
public function setCategory(string $category): self	Установит код раздела $category.
public function getDescription(): ?string	Вернет описание пресета.
public function setDescription(string $description): self	Установит описание пресета $description.
public function getIcon(): string	Вернет путь к иконке.
public function setIcon(string $icon): self	Установит путь к иконке $icon.
public function getData(): array	Вернет поля настроек смарт-процесса.
public function setData(array $data): self	Установит поля настроек смарт-процесса $data.
public function getId(): string	Вернет идентификатор пресета.
public function setId(string $id): self	Установит идентификатор пресета $id.
public function isDisabled(): bool	Вернет флаг доступности пресета.
public function setDisabled(bool $isDisabled): TypePreset	Установит флаг доступности пресета $isDisabled.

Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.

Наверх