Класс Helper

__call()source public

__call( string $method , array $params )

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

Параметры

строка $method

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

массив $params

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

__construct()source public

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

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

Параметры

Cake\View\View $View

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

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

Настройки конфигурации для helper.

__debugInfo()source public

__debugInfo( )

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

Возвращает

массив

__get()source public

__get( string $name )

Лениво загружает helper.

Параметры

строка $name

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

Возвращает

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

_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.

implementedEvents()source public

implementedEvents( )

Получить View обратные вызовы, в которых заинтересован этот helper.

Определяя один из методов обратного вызова, предполагается, что helper заинтересован в связанном событии.

Переопределите этот метод, если вам нужно добавить слушатели событий, отличные от стандартных. Или если вы хотите, чтобы helpers прослушивали нестандартные события.

Возвращает

массив

Реализация

Cake\Event\EventListenerInterface::implementedEvents()

initialize()source public

initialize( array $config )

Метод привязки конструктора.

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

Параметры

массив $config

Настройки конфигурации, предоставленные этому helper.

_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

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

Исключения

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

Параметры

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

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

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

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

логический $merge необязательно true

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

Возвращает

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

Исключения

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

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

Параметры

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

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

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

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

Возвращает

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

[]

[]

[]

[]

null

null

[]

null