Класс FlashComponent

__call()source public

__call( string $name , array $args )

Магический метод для методов flash с длинным названием, основанных на именах элементов.

Например: $this->Flash->success('My message') будет использовать элемент success.ctp в src/Template/Element/Flash для рендеринга сообщения flash.

Если вы делаете последовательные вызовы этого метода, сообщения будут накапливаться (если они заданы с одинаковым ключом flash).

Обратите внимание, что параметр element будет всегда перезаписываться. Для вызова определенного элемента из плагина, необходимо установить опцию plugin в $args.

Например: $this->Flash->warning('My message', ['plugin' => 'PluginName']) будет использовать элемент warning.ctp в plugins/PluginName/src/Template/Element/Flash для рендеринга сообщения flash.

Параметры

строка $name

Имя элемента для использования.

массив $args

Параметры для передачи при вызове FlashComponent::set().

Исключения

Cake\Network\Exception\InternalErrorException
Если отсутствует сообщение flash.

__construct()source public

__construct( Cake\Controller\ComponentRegistry $registry , array $config [] )

Конструктор

Параметры

Cake\Controller\ComponentRegistry $registry

ComponentRegistry для этого компонента

массив $config необязательно []

Массив конфигурации.

Переопределяет

Cake\Controller\Component::__construct()

set()source public

set( string|Exception $message , array $options [] )

Используется для задания переменной сессии, которая может быть использована для вывода сообщений в представлении. Если вы делаете последовательные вызовы этого метода, сообщения будут накапливаться (если они заданы с одинаковым ключом flash).

В контроллере: $this->Flash->set('Это сохранено');

Опции:

• key Ключ для задания в ключе Flash сессии
• element Элемент для рендеринга сообщения flash. По умолчанию 'default'.
• params Массив переменных, доступных при использовании элемента
• clear Логическое значение, указывающее, нужно ли очистить текущий стек для создания нового
• escape Установить в false, чтобы шаблоны могли выводить HTML-контент

Параметры

строка|Исключение $message

Сообщение, которое нужно отобразить. Если экземпляр \Exception, будет использовано сообщение исключения, а код будет задан в параметрах.

массив $options необязательно []

Массив опций

__debugInfo()source public

__debugInfo( )

Возвращает массив, который может быть использован для описания внутреннего состояния этого объекта.

Возвращает

массив

__get()source public

__get( string $name )

Магический метод для леничной загрузки $components.

Параметры

строка $name

Имя компонента для получения.

Возвращает

смешанный тип
Объект компонента или null.

implementedEvents()source public

implementedEvents( )

Получение обратных вызовов контроллера, в которых заинтересован этот компонент.

Использует соглашения для сопоставления событий контроллера со стандартными именами методов обратного вызова компонента. Если компонент определяет один из методов обратного вызова, считается, что он заинтересован в соответствующем событии.

Переопределите этот метод, если вам нужно добавить обработчики событий, не соответствующие соглашениям, или если вы хотите, чтобы компоненты прослушивали нестандартные события.

Возвращает

массив

Реализация

Cake\Event\EventListenerInterface::implementedEvents()

initialize()source public

initialize( array $config )

Метод обратного вызова инициализации.

Реализуйте этот метод, чтобы избежать необходимости переопределения конструктора и вызова родителя.

Параметры

массив $config

Настройки конфигурации, предоставленные этому компоненту.

_configDelete()source protected

_configDelete( string $key )

Удаление одного ключа конфигурации

Параметры

строка $key

Ключ для удаления.

Исключения

Cake\Core\Exception\Exception
при попытке переопределения существующей конфигурации

_configRead()source protected

_configRead( string|null $key )

Чтение переменной конфигурации

Параметры

строка|null $key

Ключ для чтения.

Возвращает

смешанный тип

_configWrite()source protected

_configWrite( string|array $key , mixed $value , boolean|string $merge false )

Запись переменной конфигурации

Параметры

строка|массив $key

Ключ для записи.

смешанный тип $value

Значение для записи.

boolean|строка $merge необязательно false

True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.

Исключения

Cake\Core\Exception\Exception
при попытке переопределения существующей конфигурации

config()source public

config( string|array|null $key null , mixed|null $value null , boolean $merge true )

Использование

Чтение всей конфигурации:

$this->config();

Чтение определенного значения:

$this->config('key');

Чтение вложенного значения:

$this->config('some.nested.key');

Запись определенного значения:

$this->config('key', $value);

Запись вложенного значения:

$this->config('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->config(['one' => 'value', 'another' => 'value']);

Параметры

строка|массив|null $key необязательно null

Ключ для получения/записи, или полный массив конфигураций.

смешанный тип|null $value необязательно null

Значение для записи.

boolean $merge необязательно true

Рекурсивное слияние или перезапись существующей конфигурации, по умолчанию true.

Возвращает

смешанный тип
Значение конфигурации, которое читается, или сам объект при операциях записи.

Исключения

Cake\Core\Exception\Exception
При попытке установить недопустимый ключ.

configShallow()source public

configShallow( string|array $key , mixed|null $value null )

Объединить предоставленную конфигурацию с существующей. В отличие от config(), которая выполняет рекурсивное объединение для вложенных ключей, этот метод выполняет простое объединение.

Установка определенного значения:

$this->config('key', $value);

Установка вложенного значения:

$this->config('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->config(['one' => 'value', 'another' => 'value']);

Параметры

string|array $key

Ключ для установки или полный массив конфигураций.

mixed|null $value optional null

Значение для установки.

Возвращает

$this Сам объект.

log()source public

log( mixed $msg , integer|string $level LogLevel::ERROR , string|array $context [] )

Удобный метод для записи сообщения в журнал. Для получения дополнительной информации о записи в журналы см. Log::write().

Параметры

mixed $msg

Сообщение журнала.

integer|string $level optional LogLevel::ERROR

Уровень ошибки.

string|array $context optional []

Дополнительные данные журнала, относящиеся к этому сообщению.

Возвращает

boolean
Успешность записи в журнал.

error( string $message , array $options )

success( string $message , array $options )

[
    'key' => 'flash',
    'element' => 'default',
    'params' => [],
    'clear' => false,
    'duplicate' => true
]