Класс FlashHelper

implementedEvents()source public

implementedEvents( )

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

Возвращает

array

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

Cake\View\Helper::implementedEvents()

render()source 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()source public

__call( string $method , array $params )

Обеспечивает некритические ошибки при вызовах отсутствующих методов.

Параметры

строка $method

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

массив $params

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

__construct()source public

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

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

Параметры

Cake\View\View $View

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

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

Параметры настройки для помощника.

__debugInfo()source public

__debugInfo( )

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

Возвращает

массив

__get()source public

__get( string $name )

Лениво загружает помощники.

Параметры

строка $name

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

Возвращает

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

__set()source public

__set( string $name , mixed $value )

Магический установщик для удалённых свойств.

Параметры

строка $name

Имя свойства.

смешанное $value

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

_cleanConfirmMessage()source protected

_cleanConfirmMessage( string $message )

Возвращает строку, готовую для использования в confirm()

Параметры

строка $message

Сообщение для очистки

Возвращает

смешанное

_confirm()source protected

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

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

Параметры

строка $message

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

строка $okCode

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

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

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

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

Массив опций

Возвращает

строка
код onclick JS

addClass()source public

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

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

Параметры

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

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

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

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

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

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

Возвращает

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

getView()source public

getView( )

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

Возвращает

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

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 )

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

Параметры

string|array $key

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

mixed $value

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

boolean|string $merge необязательно false

Истинно для рекурсивного объединения, «shallow» для простого объединения, ложно для перезаписи, по умолчанию ложно.

Исключения

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

config()source public deprecated

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

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

Возвращает

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

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

Возвращает

$this

Исключения

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