Класс 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\Http\Exception\InternalErrorException
Если сообщение flash отсутствует.

__construct()source public

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

Конструктор

Параметры

Cake\Controller\ComponentRegistry $registry

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

массив $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.

getController()source public

getController( )

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

Возвращает

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

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

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

булево|строка $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']);

Устаревший

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
]