Класс FlashHelper

implementedEvents()исходный код public

implementedEvents( )

Обработчики событий.

Возвращает

array

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

Cake\View\Helper::implementedEvents()

render()исходный код public

render( string $key 'flash' , array $options [] )

Используется для рендеринга сообщения, установленного в FlashComponent::set()

В представлении: $this->Flash->render('somekey'); Будет использоваться flash по умолчанию, если параметр не передан

Вы можете передать дополнительную информацию для генерации сообщения всплывающего сообщения. Это позволяет объединить все параметры для определенного типа сообщения всплывающего сообщения в представлении.

echo $this->Flash->render('flash', ['params' => ['name' => $user['User']['name']]]);

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

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

echo $this->Flash->render('flash', ['element' => 'my_custom_element']);

Если вы хотите использовать элемент из плагина для рендеринга сообщения всплывающего сообщения, вы можете использовать точечную нотацию для имени элемента плагина:

echo $this->Flash->render('flash', [
  'element' => 'MyPlugin.my_custom_element',
]);

Если в сессии хранятся несколько сообщений, каждое сообщение будет отображаться в собственном элементе.

Параметры

строка $key необязательно 'flash'

Ключ [Flash.] который вы рендерите в представлении.

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

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

Возвращает

строка|null

Отображенное всплывающее сообщение или null, если ключ всплывающего сообщения не существует в сессии.

Выбрасывает

UnexpectedValueException
Если значение для ключа настроек всплывающих сообщений не является массивом.

__call()исходный код public

__call( string $method , array $params )

Предоставляет ошибки, не являющиеся фатальными, при вызовах отсутствующих методов.

Параметры

строка $method

Метод для вызова

массив $params

Массив параметров для метода.

__construct()исходный код public

__construct( Cake\View\View $View , array $config [] )

Конструктор по умолчанию

Параметры

Cake\View\View $View

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

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

Настройки конфигурации для хелпера.

__debugInfo()исходный код public

__debugInfo( )

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

Возвращает

массив

__get()исходный код public

__get( string $name )

Лениво загружает хелперы.

Параметры

строка $name

Имя свойства, к которому осуществляется доступ.

Возвращает

Cake\View\Helper|null
Экземпляр хелпера, если хелпер с указанным именем существует

_confirm()исходный код protected

_confirm( string $message , string $okCode , string $cancelCode '' , array $options [] )

Возвращает строку, которая используется в качестве обработчика onclick для диалоговых окон подтверждения.

Параметры

строка $message

Сообщение, которое должно быть отображено

строка $okCode

Код, который должен быть выполнен после того, как пользователь выбрал 'OK'

строка $cancelCode необязательно ''

Код, который должен быть выполнен после того, как пользователь выбрал 'Отмена'

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

Массив опций

Возвращает

строка
код onclick JS

addClass()исходный код public

addClass( array $options [] , string|null $class null , string $key 'class' )

Добавляет заданный класс к параметрам элемента.

Параметры

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

Массив параметров/атрибутов, к которым добавляется класс

строка|null $class необязательно null

Имя добавляемого класса.

строка $key необязательно 'class'

Ключ, который используется для класса.

Возвращает

массив
Массив параметров с установленным ключом.

initialize()исходный код public

initialize( array $config )

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

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

Параметры

массив $config

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

_configDelete()исходный код protected

_configDelete( string $key )

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

Параметры

строка $key

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

Выбрасывает

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

_configRead()исходный код protected

_configRead( string|null $key )

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

Параметры

строка|null $key

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

Возвращает

смешанный

_configWrite()исходный код 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']);

Параметры

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->config('key', $value);

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

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

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

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

Параметры

string|array $key

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

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

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

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

$this Объект сам по себе.