Класс 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.]key, который вы рендерите в представлении.

массив $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 для диалоговых окон confirm.

Параметры

строка $message

Сообщение для отображения

строка $okCode

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

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

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

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

Массив параметров

Возвращает

строка
код JS onclick

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

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

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

Параметры

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

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

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

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

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

ключ для использования в классе.

Возвращает

массив
Массив параметров с установленным $key.

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

getView( )

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

Возвращает

Cake\View\View
Экземпляр привязанного представления.

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

Устарело

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
При попытке установить недопустимый ключ.