Класс 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
Экземпляр помощника, если помощник с заданным именем существует

_confirm()source protected

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

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

Параметры

строка $message

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

строка $okCode

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

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

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

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

Массив опций

Возвращает

строка
JS код onclick

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 )

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

Параметры

строка|массив $key

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

смешанное $value

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

логическое значение|строка $merge необязательно false

True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.

Исключение

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

Выполнять рекурсивное слияние или перезапись существующей конфигурации, по умолчанию — 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
При попытке установить недопустимый ключ.