Класс SessionComponent

check()source public

check( string $name )

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

В вашем контроллере: $this->Session->check('Controller.sessKey');

Параметры

строка $name

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

Возвращает

boolean
true, если переменная сессии установлена, false, если нет

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/components/sessions.html#SessionComponent::check

consume()source public

consume( string $name )

Читает и удаляет значение сессии для ключа.

В вашем контроллере: $this->Session->consume('Controller.sessKey');

Параметры

строка $name

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

Возвращает

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

delete()source public

delete( string $name )

Удаляет значение сессии для ключа.

В вашем контроллере: $this->Session->delete('Controller.sessKey');

Параметры

строка $name

имя ключа сессии, который вы хотите удалить

Возвращает

boolean
true, если переменная сессии установлена и может быть удалена, false, если переменная не была установлена.

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/components/sessions.html#SessionComponent::delete

destroy()source public

destroy( )

Используется для уничтожения сессий

В вашем контроллере: $this->Session->destroy();

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/components/sessions.html#SessionComponent::destroy

error()source public

error( )

Используется для определения последней ошибки в сессии.

В вашем контроллере: $this->Session->error();

Возвращает

string
Последняя ошибка сессии

id()source public

id( string $id null )

Получение/Установка идентификатора сессии.

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

Параметры

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

Используемый идентификатор (необязательно)

Возвращает

строка
Текущий идентификатор сессии.

read()source public

read( string $name null )

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

В вашем контроллере: $this->Session->read('Controller.sessKey'); Вызов метода без параметра вернет все переменные сессии

Параметры

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

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

Возвращает

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

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/components/sessions.html#SessionComponent::read

renew()source public

renew( )

Используется для обновления идентификатора сессии

В вашем контроллере: $this->Session->renew();

setFlash()source public

setFlash( string $message , string $element 'default' , array $params array() , string $key 'flash' )

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

В вашем контроллере: $this->Session->setFlash('Это было сохранено');

Дополнительные параметры ниже могут быть переданы для настройки вывода, или Message.[ключ]. Вы также можете задавать дополнительные параметры при отрисовке сообщений flash. Подробнее об этом см. SessionHelper::flash().

Устарело

3.0.0 С версии 2.7, используйте FlashComponent вместо этого.

Параметры

строка $message

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

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

Элемент для обертывания flash-сообщения.

массив $params необязательно array()

Параметры для передачи в макет в качестве переменных представления

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

Ключ сообщения, по умолчанию 'flash'

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/components/sessions.html#creating-notification-messages

started()source public

started( )

Возвращает булево значение, было ли начата сессия.

Возвращает

boolean

userAgent()source public

userAgent( string $userAgent null )

Получить/Установить userAgent

Параметры

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

Установить userAgent

Возвращает

строка
Текущий пользовательский агент.

valid()source public

valid( )

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

В вашем контроллере: $this->Session->valid();

Возвращает

boolean
true, если сессия валидна, false — если сессия невалидна

write()source public

write( string $name , string $value null )

Записывает значение в ключ сессии.

В вашем контроллере: $this->Session->write('Controller.sessKey', 'значение сессии');

Параметры

строка $name

Имя ключа, который вы устанавливаете в сессии. Для лучшей организации следует использовать формат Controller.key

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

Значение, которое вы хотите сохранить в сессии.

Возвращает

boolean
Успех

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/components/sessions.html#SessionComponent::write

__construct()source public

__construct( ComponentCollection $collection , array $settings array() )

Конструктор

Параметры

ComponentCollection $collection

A ComponentCollection, которую этот компонент может использовать для леничной загрузки своих компонентов

массив $settings необязательно array()

Массив настроек конфигурации.

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

CakeObject::__construct()

__get()source public

__get( string $name )

Магический метод для леничной загрузки $components.

Параметры

строка $name

Имя компонента для получения.

Возвращает

смешанный тип
Объект Component или null.

beforeRedirect()source public

beforeRedirect( Controller $controller , string|array $url , integer $status null , boolean $exit true )

Вызывается перед Controller::redirect(). Позволяет заменить URL, на который будет осуществлен перенаправление, новым URL. Возвращаемое значение этого метода может быть массивом или строкой.

Если возвращаемое значение является массивом и содержит ключ 'url'. Вы также можете указать следующие параметры:

• status Код состояния перенаправления
• exit Следует ли завершить перенаправление.

Если ваш ответ является строкой или массивом, не содержащим ключа 'url', он будет использован как новый URL для перенаправления.

Параметры

Controller $controller

Контроллер с компонентами для перед перенаправлением

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

Строка или массив URL, на который производится перенаправление.

целое число $status необязательно null

Код состояния перенаправления

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

Выполнять ли выход из скрипта.

Возвращает

массив|null
Массив или null.

Ссылка

http://book.cakephp.org/2.0/ru/controllers/components.html#Component::beforeRedirect

beforeRender()source public

beforeRender( Controller $controller )

Вызывается перед Controller::beforeRender(), до загрузки класса представления и перед Controller::render()

Параметры

Controller $controller

Контроллер с компонентами для перед рендерингом

Ссылка

http://book.cakephp.org/2.0/ru/controllers/components.html#Component::beforeRender

initialize()source public

initialize( Controller $controller )

Вызывается перед Controller::beforeFilter().

Параметры

Controller $controller

Контроллер с компонентами для инициализации

Ссылка

http://book.cakephp.org/2.0/ru/controllers/components.html#Component::initialize

shutdown()source public

shutdown( Controller $controller )

Вызывается после Controller::render() и перед выводом результата в браузер.

Параметры

Controller $controller

Контроллер с компонентами для завершения работы

Ссылка

http://book.cakephp.org/2.0/ru/controllers/components.html#Component::shutdown

startup()source public

startup( Controller $controller )

Вызывается после Controller::beforeFilter() и перед действием контроллера

Параметры

Controller $controller

Контроллер с компонентами для запуска

Ссылка

http://book.cakephp.org/2.0/ru/controllers/components.html#Component::startup

_mergeVars()source protected

_mergeVars( array $properties , string $class , boolean $normalize true )

Объединяет свойства $property этого объекта со свойствами в определении $class. Значение свойства этого класса будет объединено поверх значения свойства $class.

Это обеспечивает некоторые из функций DRY, предоставляемых CakePHP. Если вы хотите отключить эту функцию, переопределите этот метод как пустую функцию.

Параметры

массив $properties

Имя свойств для объединения.

строка $class

Класс для объединения свойства.

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

Установите в значение true, чтобы выполнить нормализацию свойств с помощью Hash::normalize() перед объединением.

_set()source protected

_set( array $properties array() )

Позволяет установить несколько свойств объекта в одной строке кода. Будут установлены только свойства, которые являются частью объявления класса.

Параметры

массив $properties необязательно array()

Ассоциативный массив, содержащий свойства и соответствующие значения.

_stop()source protected

_stop( integer|string $status 0 )

Останавливает выполнение текущего скрипта. Оборачивает exit(), что упрощает тестирование.

Параметры

целое число|строка $status необязательно 0

См. http://php.net/exit для значений

dispatchMethod()source public

dispatchMethod( string $method , array $params array() )

Вызывает метод этого объекта с заданными параметрами. Предоставляет ОО оболочку для call_user_func_array

Параметры

строка $method

Имя вызываемого метода

массив $params необязательно array()

Список параметров для использования при вызове $method

Возвращает

смешанный тип
Возвращает результат вызова метода

log()source public

log( string $msg , integer $type LOG_ERR , null|string|array $scope null )

Удобный метод для записи сообщения в CakeLog. Для получения дополнительной информации о записи в журналы, обратитесь к CakeLog::write().

Параметры

строка $msg

Сообщение журнала

целое число $type необязательный LOG_ERR

Константа типа ошибки. Определена в app/Config/core.php.

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

Область(и), в которой создается сообщение журнала. Для получения дополнительной информации о зонах ведения журнала, см. CakeLog::config().

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

boolean
Успешность записи в журнал

requestAction()source public

requestAction( string|array $url , array $extra array() )

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

Внутри этого метода используется Router::reverse() для преобразования параметра $url в строковый URL. Вы должны использовать форматы URL, совместимые с Router::reverse().

Передача данных POST и GET

Данные POST и GET могут быть смоделированы в requestAction. Используйте $extra['url'] для данных GET. Параметр $extra['data'] позволяет моделировать данные POST.

Параметры

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

URL на основе строки или массива. В отличие от других массивов URL в CakePHP, этот URL не будет автоматически обрабатывать переданные и именованные аргументы в параметре $url.

массив $extra необязательный array()

Если массив содержит ключ "return", он устанавливает AutoRender в true. Также может быть использован для отправки данных GET/POST и именованных/переданных аргументов.

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

смешанный

Логическое значение true или false при успехе/неудачи, или содержимое отрисованного действия, если в $extra установлен 'return'.

toString()source public

toString( )

Преобразование CakeObject в строку. Каждый класс может переопределить этот метод по необходимости.

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

строка
Имя этого класса