Класс SessionHelper

__construct()source public

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

Конструктор

Параметры

Cake\View\View $View

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

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

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

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

Cake\View\Helper::__construct()

check()source public

check( string $name )

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

В вашем представлении:

$this->Session->check('Controller.sessKey');

Параметры

строка $name

Ключ сессии для проверки.

Возвращает

логическое значение

implementedEvents()source public

implementedEvents( )

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

Возвращает

массив

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

Cake\View\Helper::implementedEvents()

read()source public

read( string|null $name null )

Читает значение сессии для ключа или возвращает значения для всех ключей.

В вашем представлении:

$this->Session->read('Controller.sessKey');

Вызов метода без параметра вернёт все переменные сессии

Параметры

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

Имя ключа сессии, которое вы хотите прочитать

Возвращает

смешанный тип
Значения из переменных сессии

__call()source public

__call( string $method , array $params )

Предоставляет ошибки при вызове отсутствующих методов.

Параметры

строка $method

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

массив $params

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

__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 для диалоговых окон confirm.

Параметры

строка $message

Сообщение, которое будет отображено

строка $okCode

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

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

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

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

Массив опций

Возвращает

строка
JS код onclick

addClass()source public

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

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

Параметры

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

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

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

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

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

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

Возвращает

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

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

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.

Возвращает

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

Выбрасывает

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 Объект самого себя.