Класс 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.

Параметры

string $name

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

array $args

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

Исключения

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

__construct()source public

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

Конструктор

Параметры

Cake\Controller\ComponentRegistry $registry

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

array $config optional []

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

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

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-контент

Параметры

string|Exception $message

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

array $options optional []

Массив опций

__debugInfo()source public

__debugInfo( )

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

Возвращает

массив

__get()source public

__get( string $name )

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

Параметры

string $name

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

Возвращает

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

getController()source public

getController( )

Получить контроллер, к которому привязан этот компонент.

Возвращает

Cake\Controller\Controller
Связанный контроллер.

implementedEvents()source public

implementedEvents( )

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

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

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

Возвращает

массив

Реализация

Cake\Event\EventListenerInterface::implementedEvents()

initialize()source public

initialize( array $config )

Метод-обработчик конструктора.

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

Параметры

array $config

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

_configDelete()source protected

_configDelete( string $key )

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

Параметры

string $key

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

Исключения

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

_configRead()source protected

_configRead( string|null $key )

Читает ключ конфигурации.

Параметры

string|null $key

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

Возвращает

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

_configWrite()source protected

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

Записывает ключ конфигурации.

Параметры

string|array $key

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

mixed $value

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

boolean|string $merge optional 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']);

Устарело

3.4.0 используйте setConfig()/getConfig() вместо этого.

Параметры

string|array|null $key необязательно null

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

mixed|null $value необязательно null

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

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

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

Возвращает

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

Выбрасывает

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

configShallow()source public

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

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

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

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

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

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

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

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

Параметры

string|array $key

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

mixed|null $value необязательно null

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

Возвращает

$this

getConfig()source public

getConfig( string|null $key null , mixed $default null )

Возвращает конфигурацию.

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

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

$this->getConfig();

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

$this->getConfig('key');

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

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

Чтение со значением по умолчанию:

$this->getConfig('some-key', 'default-value');

Параметры

string|null $key необязательно null

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

mixed $default необязательно null

Значение, возвращаемое, если ключ не существует.

Возвращает

mixed
Значение конфигурации.

setConfig()source public

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

Устанавливает конфигурацию.

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

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

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

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

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

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

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

Параметры

string|array $key

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

mixed|null $value необязательно null

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

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

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

Возвращает

$this

Выбрасывает

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

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,
    'duplicate' => true
]