babaev-an / ANB PHP COMPONENTS PACK

classes/ActionState.md

Класс ActionState

Пространство имён: goodboyalex\php_components_pack\classes
Полное имя класса: goodboyalex\php_components_pack\classes\ActionState
Тип: финальный класс
Реализует: ISerializable
Версия: 1.1
Доступно с: 1.0

Описание

Класс представляет состояние действия — контейнер для хранения:

  • значения действия ($value);
  • списка сообщений (ошибок, предупреждений, информационных сообщений).

Предназначен для отслеживания результатов выполнения операций, накопления сообщений и проверки успешности выполнения.

Автор

  • Имя: Александр Бабаев
  • Email: contact_with_us@babaev-an.ru

Метаданные

  • PSR‑4: goodboyalex/php_components_pack
  • Модификатор класса: final
  • Ключевой функционал: накопление и анализ сообщений о состоянии действия

Зависимости

  • Интерфейс: goodboyalex\php_components_pack\interfaces\ISerializable
  • Модели: goodboyalex\php_components_pack\models\ActionStateMessage
  • Трейты:
    • goodboyalex\php_components_pack\traits\ActionState\ActionStateAddTrait
    • goodboyalex\php_components_pack\traits\ActionState\ActionStateGetTrait
    • goodboyalex\php_components_pack\traits\ActionState\ActionStateHasTrait
    • goodboyalex\php_components_pack\traits\ActionState\ActionStateStaticTrait
  • Типы: goodboyalex\php_components_pack\types\ObjectArray

Свойства

$value

  • Тип: mixed|null
  • Доступность: публичное
  • Описание: значение, связанное с состоянием действия.

Конструктор

public function __construct(mixed $defValue = null)

Описание:
Создаёт экземпляр класса с заданным значением по умолчанию.

Параметры:

  • $defValue (mixed|null) — значение по умолчанию (опционально, по умолчанию null).

Возвращаемое значение:
Не возвращает значение (void).

Статические методы

GET_STRING_ERROR_ONLY()

public static function GET_STRING_ERROR_ONLY(): Closure

Описание:
Возвращает функцию-предикат для фильтрации только ошибок при выводе сообщений.

Возвращаемое значение:

  • Closure — функция-предикат.

GET_STRING_ERROR_AND_WARNING()

public static function GET_STRING_ERROR_AND_WARNING(): Closure

Описание:
Возвращает функцию-предикат для фильтрации ошибок и предупреждений при выводе сообщений.

Возвращаемое значение:

  • Closure — функция-предикат.

GET_STRING_ALL()

public static function GET_STRING_ALL(): Closure

Описание:
Возвращает функцию-предикат для вывода всех сообщений без фильтрации.

Возвращаемое значение:

  • Closure — функция-предикат.

Методы добавления сообщений

addMessage()

public function addMessage(ActionStateMessage $message): void

Описание:
Добавляет сообщение в список.

Параметры:

  • $message (ActionStateMessage) — сообщение.

Возвращаемое значение:
Не возвращает значение (void).

addState()

public function addState(ActionState $state, bool $clearAllBefore = false): void

Описание:
Добавляет другое состояние действия в текущее.

Параметры:

  • $state (ActionState) — другое состояние.
  • $clearAllBefore (bool) — очищать сообщения перед добавлением (true) или добавлять к текущим (false, по умолчанию).

Возвращаемое значение:
Не возвращает значение (void).

addRange()

public function addRange(ObjectArray | array $messages): void

Описание:
Добавляет список сообщений.

Параметры:

  • $messages (ObjectArray|array) — список сообщений.

Возвращаемое значение:
Не возвращает значение (void).

add()

public function add(MessageType $messageType, string $message, ?Dictionary $flags = null): void

Описание:
Добавляет сообщение заданного типа.

Параметры:

  • $messageType (MessageType) — тип сообщения.
  • $message (string) — текст сообщения.
  • $flags (Dictionary|null) — флаги (опционально, по умолчанию null).

Возвращаемое значение:
Не возвращает значение (void).

addError()

public function addError(string $message, ?Dictionary $flags = null): void

Описание:
Добавляет сообщение об ошибке.

Параметры:

  • $message (string) — текст сообщения.
  • $flags (Dictionary|null) — флаги (опционально, по умолчанию null).

Возвращаемое значение:
Не возвращает значение (void).

addWarning()

public function addWarning(string $message, ?Dictionary $flags = null): void

Описание:
Добавляет предупреждение.

Параметры:

  • $message (string) — текст сообщения.
  • $flags (Dictionary|null) — флаги (опционально, по умолчанию null).

Возвращаемое значение:
Не возвращает значение (void).

addInfo()

public function addInfo(string $message, ?Dictionary $flags = null): void

Описание:
Добавляет информационное сообщение.

Параметры:

  • $message (string) — текст сообщения.
  • $flags (Dictionary|null) — флаги (опционально, по умолчанию null).

Возвращаемое значение:
Не возвращает значение (void).

Методы проверки состояния

count()

public function count(callable $predicate): int

Описание:
Возвращает количество сообщений, удовлетворяющих условию.

Параметры:

  • $predicate (callable) — условие выборки.

Возвращаемое значение:

  • int — число сообщений.

hasInfos()

public function hasInfos(): bool

Описание:
Проверяет, есть ли информационные сообщения.

Возвращаемое значение:

  • bool — true, если есть информационные сообщения, иначе false.

hasWarnings()

public function hasWarnings(): bool

Описание:
Проверяет, есть ли предупреждения.

Возвращаемое значение:

  • bool — true, если есть предупреждения, иначе false.

hasErrors()

public function hasErrors(): bool

Описание:
Проверяет, есть ли ошибки.

Возвращаемое значение:

  • bool — true, если есть ошибки, иначе false.

isSuccess()

public function isSuccess(bool $ignoreWarnings = false): bool

Описание:
Проверяет, успешно ли завершилась операция.

Параметры:

  • $ignoreWarnings (bool) — игнорировать предупреждения (false по умолчанию).

Возвращаемое значение:

  • bool — true, если операция успешна, иначе false.

Методы получения данных

getStringMessages()

public function getStringMessages(callable $predicate, string $separator = '\n'): string

Описание:
Возвращает список сообщений (параметр message у каждого сообщения) в виде строки.

Параметры:

  • $predicate (callable) — условие выборки.
  • $separator (string) — разделитель (по умолчанию — новая строка \n).

Возвращаемое значение:

  • string — список сообщений, объединённых разделителем.

getMessages()

public function getMessages(callable $predicate): ObjectArray

Описание:
Выбирает сообщения по условию.

Параметры:

  • $predicate (callable) — условие выборки.

Возвращаемое значение:

  • ObjectArray — список отобранных сообщений.

Метод очистки

clear()

public function clear(callable $predicate): void

На главную | Содержание

Назад