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

Возвращает

string|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( )

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

Возвращает

array
массив

__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 необязательно []

Массив опций

Возвращает

string
JS код onclick

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

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

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

Параметры

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

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

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

Название добавляемого класса.

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

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

Возвращает

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

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

_configDelete( string $key )

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

Параметры

строка $key

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

Исключение

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

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

_configRead( string|null $key )

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

Параметры

строка|null $key

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

Возвращает

mixed
смешанное

_configWriteисходный код protected

_configWrite( string|array $key , mixed $value , boolean|string $merge false )

Запись переменной конфигурации

Параметры

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

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

смешанное $value

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

булево|строка $merge необязательно false

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

Исключение

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

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

Параметры

строка|массив|null $key необязательно null

Ключ для получения/установки, или массив с полной конфигурацией.

смешанное|null $value необязательно null

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

булево $merge необязательно true

Выполнять рекурсивное слияние или перезаписывать существующую конфигурацию, по умолчанию true.

Возвращает

mixed
Значение конфигурации, которое считывается, или сам объект при операциях записи.

Исключение

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

configShallowsource 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

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

Возвращает

mixed
$this Сам объект.

[]

[]

[]

[]

null

null

[]

null

[]

false