Класс SessionHelper

__construct()source public deprecated

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

Конструктор

Параметры

Cake\View\View $View

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

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

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

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

Cake\View\Helper::__construct()

check()source public deprecated

check( string $name )

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

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

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

Параметры

строка $name

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

Возвращает

boolean

implementedEvents()source public deprecated

implementedEvents( )

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

Возвращает

массив

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

Cake\View\Helper::implementedEvents()

read()source public deprecated

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

__set()source public

__set( string $name , mixed $value )

Магический установщик для удалённых свойств.

Параметры

строка $name

Имя свойства.

смешанное $value

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

_cleanConfirmMessage()source protected

_cleanConfirmMessage( string $message )

Возвращает строку, предназначенную для использования в confirm()

Параметры

строка $message

Сообщение для очистки

Возвращает

смешанное

_confirm()source protected

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

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

Параметры

строка $message

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

строка $okCode

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

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

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

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

Массив опций

Возвращает

строка
код onclick JS

addClass()source public

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

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

Параметры

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

Массив опций/атрибутов, к которым нужно добавить класс

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

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

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

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

Возвращает

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

getView()source public

getView( )

Получить экземпляр представления, к которому привязан этот помощник.

Возвращает

Cake\View\View
Экземпляр привязанного представления.

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

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

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

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

Исключения

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

config()source public deprecated

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

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

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

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

Возвращаемое значение

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

Исключения

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

Параметры

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

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

смешанный|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');

Параметры

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

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

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

Возвращаемое значение, когда ключ не существует.

Возвращаемое значение

смешанный
Данные конфигурации по указанному ключу или null, если ключ не существует.

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

Параметры

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

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

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

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

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

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

Возвращаемое значение

$this

Исключения

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