Класс SessionHelper

__constructsource public

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

Конструктор

Параметры

Cake\View\View $View

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

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

Параметры настройки помощника.

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

Cake\View\Helper::__construct()

checksource public

check( string $name )

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

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

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

Параметры

строка $name

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

Возвращает

boolean
bool

implementedEventssource public

implementedEvents( )

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

Возвращает

array
массив

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

Cake\View\Helper::implementedEvents()

readsource public

read( string|null $name null )

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

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

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

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

Параметры

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

Имя ключа сеанса, которое требуется прочитать

Возвращает

mixed
Значения из переменных сеанса

__callsource public

__call( string $method , array $params )

Предоставляет ошибки при отсутствии метода.

Параметры

строка $method

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

массив $params

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

__debugInfosource public

__debugInfo( )

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

Возвращает

array
массив

__getsource public

__get( string $name )

Лениво загружает помощников.

Параметры

строка $name

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

Возвращает

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

_confirmsource protected

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

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

Параметры

строка $message

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

строка $okCode

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

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

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

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

Массив параметров

Возвращает

string
JS-код onclick

addClasssource public

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

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

Параметры

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

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

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

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

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

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

Возвращает

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

_configDeletesource protected

_configDelete( string $key )

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

Параметры

строка $key

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

Выбрасывает

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

_configReadsource protected

_configRead( string|null $key )

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

Параметры

строка|null $key

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

Возвращает

mixed
смешанный тип

_configWritesource protected

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

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

Параметры

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

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

смешанный тип $value

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

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

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

Выбрасывает

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

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

Параметры

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

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

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

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

Возвращает

mixed
$this Объект сам по себе.

[]

[]

[]

[]

null

null

[]

null

[]

false