Класс FlashHelper

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

implementedEvents( )

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

Возвращает

массив

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

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

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

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