Класс SessionHelper

check()source public

check( string $name )

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

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

Параметры

строка $name

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

Возвращает

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

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/session.html#SessionHelper::check

consume()source public

consume( string $name )

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

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

Параметры

строка $name

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

Возвращает

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

error()source public

error( )

Возвращает последнюю ошибку, возникшую в сессии

В вашем представлении: $this->Session->error();

Возвращает

строка
последняя ошибка

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/session.html#displaying-notifications-or-flash-messages

flash()source public

flash( string $key 'flash' , array $attrs array() )

Используется для рендеринга сообщения, установленного в Controller::Session::setFlash()

В вашем представлении: $this->Session->flash('somekey'); По умолчанию используется flash, если параметр не передан

Вы можете передать дополнительную информацию в генерацию сообщения flash. Это позволяет объединить все параметры для данного типа сообщения flash в представлении.

echo $this->Session->flash('flash', array('params' => array('class' => 'new-flash')));

Это сгенерирует сообщение flash с пользовательским именем класса. Используя $attrs['params'], вы можете передавать дополнительные данные в рендеринг элемента, которые будут доступны как локальные переменные при рендеринге элемента:

echo $this->Session->flash('flash', array('params' => array('name' => $user['User']['name'])));

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

Наконец, вы можете выбрать элемент, который будет рендериться при создании сообщения flash. Наличие пользовательских элементов позволяет полностью настроить вывод сообщений flash.

echo $this->Session->flash('flash', array('element' => 'my_custom_element'));

Если вы хотите использовать элемент из плагина для рендеринга вашего сообщения flash, вы можете сделать это с помощью параметра плагина:

echo $this->Session->flash('flash', array(
    'element' => 'my_custom_element',
    'params' => array('plugin' => 'my_plugin')
));

Устарело

3.0.0 С версии 2.7 используйте FlashHelper::render() вместо этого.

Параметры

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

Ключ [Сообщения.]который вы рендерите в представлении.

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

Дополнительные атрибуты для создания этого сообщения flash. Поддерживает ключи 'params' и 'element', которые используются в помощнике.

Возвращает

строка

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/session.html#SessionHelper::flash

read()source public

read( string $name null )

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

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

Параметры

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

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

Возвращает

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

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/session.html#SessionHelper::read

valid()source public

valid( )

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

Возвращает

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

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/session.html#SessionHelper::valid

__call()source public

__call( string $method , array $params )

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

Параметры

строка $method

Вызываемый метод

массив $params

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

__construct()source public

__construct( View $View , array $settings array() )

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

Параметры

View $View

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

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

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

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

Object::__construct()

__get()source public

__get( string $name )

Лениво загружает помощники. Обеспечивает доступ к устаревшим свойствам запроса.

Устарело

3.0.0 Доступ к свойствам запроса через этот метод устарел и будет удален в версии 3.0.

Параметры

строка $name

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

Возвращает

смешанный тип
Помощник или свойство, найденное в $name

__set()source public

__set( string $name , mixed $value )

Обеспечивает обратную совместимость для установки значений в объект запроса.

Устарело

3.0.0 Этот метод будет удалён в версии 3.0

Параметры

строка $name

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

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

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

_clean()source protected

_clean( )

Удаляет вредный контент из вывода

_confirm()source protected

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

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

Параметры

строка $message

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

строка $okCode

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

строка $cancelCode опционально ''

Код, который будет выполнен после выбора пользователем «Отмена», также выполняется, когда okCode не возвращает значение

массив $options опционально array()

Массив опций

Возвращает

строка
JS-код onclick

_encodeUrl()source protected

_encodeUrl( string $url )

Кодирует URL для использования в атрибутах HTML.

Параметры

строка $url

URL для кодирования.

Возвращает

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

_formatAttribute()source protected

_formatAttribute( string $key , string $value , boolean $escape true )

Форматирует отдельный атрибут и возвращает строковое значение составленного атрибута. Работает с минимализированными атрибутами, которые имеют такое же значение, как их имя, например, «disabled» и «checked».

Устарело

3.0.0 Данный метод будет перенесен в HtmlHelper в версии 3.0

Параметры

строка $key

Имя атрибута, который нужно создать

строка $value

Значение атрибута, который нужно создать.

логическое значение $escape опционально true

Определяет, должно ли значение быть экранировано

Возвращает

строка
Составленный атрибут.

_initInputField()source protected

_initInputField( string $field , array $options array() )

Устанавливает значения по умолчанию для тега input. Установит атрибуты name, value и id для массива атрибутов html.

Параметры

строка $field

Имя поля для инициализации.

массив $options опционально array()

Массив опций для использования при инициализации поля ввода.

Возвращает

массив
Массив опций для поля ввода формы.

_name()source protected

_name( array|string $options array() , string $field null , string $key 'name' )

Получает имя поля ввода для текущего тега. Создает атрибуты имени ввода, используя форматирование CakePHP в формате data[Model][field].

Параметры

массив|строка $options опционально array()

Если массив, должен быть массивом атрибутов, к которым нужно добавить $key. Если строка или null, будет использоваться как сущность View.

строка $field опционально null

Имя поля.

строка $key опционально 'name'

Имя атрибута, который нужно установить, по умолчанию «name»

Возвращает

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

Если для $options был передан массив, будет возвращен массив с заданным $key. Если была передана строка, будет возвращена строка.

_parseAttributes()source protected

_parseAttributes( array $options , array $exclude null , string $insertBefore ' ' , string $insertAfter null )

Возвращает строку с разделенными пробелами элементами массива $options. Если ключ массива $options оказывается одним из перечисленных в Helper::$_minimizedAttributes,

и его значение равно:

• '1' (строка)
• 1 (целое число)
• true (логическое значение)
• 'true' (строка)

то значение будет сброшено, чтобы быть идентичным имени ключа. Если значение не является одним из этих 3, параметр не выводится.

«escape» — специальная опция, которая управляет преобразованием атрибутов в их эквиваленты с кодировкой HTML-сущностей. Установите в значение false, чтобы отключить кодировку HTML.

Если значение любого ключа опции установлено в null или false, эта опция будет исключена из вывода.

Устарело

3.0.0 Данный метод будет перенесен в HtmlHelper в версии 3.0

Параметры

массив $options

Массив опций.

массив $exclude опционально null

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

строка $insertBefore опционально ' '

Строка, которая должна вставляться перед опциями.

строка $insertAfter опционально null

Строка, которая должна вставляться после опций.

Возвращает

строка
Составленные атрибуты.

_reset()source protected

_reset( )

Сбрасывает переменные, используемые Helper::clean(), в значение null

_selectedArray()source protected

_selectedArray( string|array $data , string $key 'id' )

Преобразует набор записей из ассоциации hasAndBelongsToMany в список выбранных опций для элемента множественного выбора.

Параметры

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

Массив данных или имя модели.

строка $key опционально 'id'

Имя поля.

Возвращает

массив

addClass()source public

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

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

Параметры

массив $options опционально array()

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

строка $class опционально null

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

строка $key опционально 'class'

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

Возвращает

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

afterLayout()source public

afterLayout( string $layoutFile )

Обработчик после макета. afterLayout вызывается после отрисовки макета.

Переопределяется в подклассах.

Параметры

строка $layoutFile

Файл макета, который был отрисован.

afterRender()source public

afterRender( string $viewFile )

Обработчик после отрисовки. afterRender вызывается после отрисовки файла представления, но перед отрисовкой макета.

Переопределяется в подклассах.

Параметры

строка $viewFile

Файл представления, который был отрисован.

afterRenderFile()source public

afterRenderFile( string $viewFile , string $content )

Обработчик после отрисовки файла. Вызывается после отрисовки любого фрагмента представления.

Переопределяется в подклассах.

Параметры

строка $viewFile

Файл, который только что был отрисован.

строка $content

Контент, который был отрисован.

assetTimestamp()source public

assetTimestamp( string $path )

Добавляет отметку времени к файловому ресурсу на основе значения Asset.timestamp в Configure. Если Asset.timestamp имеет значение true и debug > 0, или Asset.timestamp === 'force', отметка времени будет добавлена.

Параметры

строка $path

Путь к файлу, к которому нужно добавить отметку времени, путь должен находиться внутри WWW_ROOT

Возвращает

строка
Путь с добавленной отметкой времени или без нее.

assetUrl()source public

assetUrl( string|array $path , array $options array() )

Генерирует URL для указанного файла ресурса. В зависимости от переданных опций предоставляет полный URL с именем домена. Также вызывает Helper::assetTimestamp() для добавления отметки времени к локальным файлам.

Параметры

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

Строка пути или массив URL

массив $options опционально array()

Массив опций. Возможные ключи: fullBase Возвращает полный URL с именем домена pathPrefix Префикс пути для относительных URL ext Расширение ресурса для добавления plugin Ложное значение предотвратит обработку пути как плагина

Возвращает

строка
Сгенерированный URL

beforeLayout()source public

beforeLayout( string $layoutFile )

Обратный вызов перед макетом. beforeLayout вызывается перед рендерингом макета.

Переопределяется в подклассах.

Параметры

строка $layoutFile

Макет, который будет рендериться.

beforeRender()source public

beforeRender( string $viewFile )

Обратный вызов перед рендерингом. beforeRender вызывается перед рендерингом файла представления.

Переопределяется в подклассах.

Параметры

строка $viewFile

Файл представления, который будет рендериться

beforeRenderFile()source public

beforeRenderFile( string $viewFile )

Обратный вызов перед рендерингом файла. Вызывается перед рендерингом любого фрагмента представления.

Переопределяется в подклассах.

Параметры

строка $viewFile

Файл, который будет рендериться.

clean()source public

clean( string|array $output )

Используется для удаления вредных тегов из содержимого. Удаляет ряд известных атак XSS из содержимого. Однако не гарантирует удаление всех возможностей. Лучшим способом предотвращения всех возможных атак является экранирование содержимого.

Устаревшее

3.0.0 Этот метод будет удален в версии 3.0

Параметры

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

Либо массив строк для очистки, либо одна строка для очистки.

Возвращает

строка|массив|null
Очищенное содержимое для вывода

domId()source public

domId( array|string $options null , string $id 'id' )

Генерирует идентификатор DOM для выбранного элемента, если он не задан. Использует текущие настройки View::entity() для генерации идентификатора атрибута в формате CamelCase.

Параметры

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

Либо массив HTML атрибутов, в который добавить $id, либо строка с путем к сущности представления для получения domId.

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

Имя атрибута 'id'.

Возвращает

смешанное

Если $options был массивом, будет возвращен массив с заданным $id. Если была предоставлена строка, будет возвращена строка.

entity()source public

entity( )

Возвращает ссылку на сущность текущего контекста в виде массива частей идентификатора.

Возвращает

массив
Массив, содержащий элементы идентификатора сущности

field()source public

field( )

Возвращает текущее используемое поле модели контекста рендеринга. Удаляет постфиксные суффиксы поля, такие как year, month, day, hour, min, meridian, когда текущая сущность содержит более 2 элементов.

Возвращает

строка

model()source public

model( )

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

Возвращает

строка

output()source public

output( string $str )

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

Этот метод может быть переопределён в подклассах для выполнения обобщённой обработки вывода после рендеринга.

Устаревшее

3.0.0 Этот метод будет удалён в будущих версиях.

Параметры

строка $str

Строка для вывода.

Возвращает

строка

setEntity()source public

setEntity( string $entity , boolean $setScope false )

Устанавливает свойства модели и поля помощника на значение, разделённое точкой, в $entity.

Параметры

строка $entity

Имя поля, например, "ModelName.fieldName" или "ModelName.ID.fieldName"

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

Устанавливает область представления на модель, указанную в $tagValue

url()source public

url( string|array $url null , boolean $full false )

Находит URL для указанного действия.

Возвращает URL, указывающий на предоставленные параметры.

Параметры

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

Либо относительный URL-адрес, например, /products/view/23, либо массив параметров URL. Использование массива для URL позволит использовать возможности обратной маршрутизации CakePHP.

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

Если true, полный базовый URL будет добавлен к результату

Возвращает

строка
Полный переведённый URL с базовым путём.

Ссылка

http://book.cakephp.org/2.0/ru/views/helpers.html

value()source public

value( array|string $options array() , string $field null , string $key 'value' )

Получает данные для текущего тега

Параметры

массив|строка $options необязательно array()

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

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

Имя поля.

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

Имя атрибута для установки, по умолчанию 'value'

Возвращает

смешанное

Если для $options был задан массив, будет возвращен массив с заданным $key. Если была предоставлена строка, будет возвращена строка.

webroot()source public

webroot( string $file )

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

Параметры

строка $file

Файл, для которого нужно создать путь webroot.

Возвращает

строка
Веб-доступный путь к файлу.

_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 необязательно массив()

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

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

mixed
Результат вызова метода

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 необязательно массив()

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

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

mixed

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

toString()source public

toString( )

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

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

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