Класс FlashComponent

__call()source public

__call( string $name , array $args )

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

Например: $this->Flash->success('Моё сообщение') будет использовать элемент 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 Булево значение, указывающее, следует ли очистить текущую стопку, чтобы начать новую

Параметры

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

Сообщение для flash. Если экземпляр \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

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

Исключения

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

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

Возвращает

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

Исключения

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 необязательно null

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

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

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

log()source public

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

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

Параметры

mixed $msg

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

integer|string $level необязательно LogLevel::ERROR

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

string|array $context необязательно []

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

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

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

error( string $message , array $options )

success( string $message , array $options )

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