Класс FlashComponent

__callsource 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 отсутствует.

__constructsource public

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

Конструктор

Параметры

Cake\Controller\ComponentRegistry $registry

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

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

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

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

Cake\Controller\Component::__construct()

setsource public

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

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

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

Опции:

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

Параметры

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

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

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

Массив опций

__debugInfosource public

__debugInfo( )

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

Возвращает

array
массив

__getsource public

__get( string $name )

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

Параметры

строка $name

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

Возвращает

mixed
Объект компонента или null.

implementedEventssource public

implementedEvents( )

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

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

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

Возвращает

array
массив

Реализация

Cake\Event\EventListenerInterface::implementedEvents()

initializesource public

initialize( array $config )

Метод обратного вызова конструктора.

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

Параметры

массив $config

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

_configDeletesource protected

_configDelete( string $key )

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

Параметры

строка $key

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

Исключения

Cake\Core\Exception\Exception
при попытке перезаписать существующую конфигурацию

_configReadsource protected

_configRead( string|null $key )

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

Параметры

строка|null $key

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

Возвращает

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

_configWritesource protected

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

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

Параметры

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

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

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

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

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

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

Исключения

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

configsource 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

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

логическое значение $merge необязательно true

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

Возвращает

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

Исключения

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

configShallowsource 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']);

Параметры

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

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

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

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

Возвращает

mixed
Сам объект.

logsource 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
]

[]

[]

[]

false