Класс SessionHelper

checkисходный код public

check( string $name )

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

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

Параметры

строка $name

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

Возвращает

boolean
bool

Ссылка

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

consumeисходный код public

consume( string $name )

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

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

Параметры

строка $name

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

Возвращает

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

errorисходный код public

error( )

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

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

Возвращает

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

Ссылка

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

flashисходный код public

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

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

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

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

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

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

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

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

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

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

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

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

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

Возвращает

string
строка

Ссылка

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

readисходный код public

read( string $name null )

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

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

Параметры

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

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

Возвращает

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

Ссылка

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

validисходный код public

valid( )

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

Возвращает

boolean
bool

Ссылка

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

__callисходный код public

__call( string $method , array $params )

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

Параметры

строка $method

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

массив $params

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

__constructисходный код public

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

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

Параметры

View $View

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

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

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

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

Object::__construct()

__getисходный код public

__get( string $name )

Лениво загружает помощников. Предоставляет доступ к устаревшим свойствам запроса также.

Устаревшее

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

Параметры

строка $name

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

Возвращает

mixed
Помощник или найденное свойство в $name

__setисходный код public

__set( string $name , mixed $value )

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

Устаревшее

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

Параметры

строка $name

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

смешанный $value

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

_cleanисходный код protected

_clean( )

Удаляет вредное содержимое из вывода

_confirmисходный код protected

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

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

Параметры

строка $message

Сообщение, которое должно отображаться

строка $okCode

Код, который должен выполняться после того, как пользователь нажал «OK»

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

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

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

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

Возвращает

string
JS код onclick

_encodeUrlисходный код protected

_encodeUrl( string $url )

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

Параметры

строка $url

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

Возвращает

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

_formatAttributesource protected

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

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

Устаревший

3.0.0 Этот метод будет перенесен в HtmlHelper в версии 3.0

Параметры

строка $key

Имя атрибута для создания

строка $value

Значение атрибута для создания.

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

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

Возвращает

string
Составной атрибут.

_initInputFieldsource protected

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

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

Параметры

строка $field

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

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

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

Возвращает

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

_namesource 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'

Возвращает

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

_parseAttributessource 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

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

Возвращает

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

_resetsource protected

_reset( )

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

_selectedArraysource protected

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

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

Параметры

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

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

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

Имя поля.

Возвращает

array
массив

addClasssource public

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

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

Параметры

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

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

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

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

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

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

Возвращает

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

afterLayoutsource public

afterLayout( string $layoutFile )

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

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

Параметры

строка $layoutFile

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

afterRendersource public

afterRender( string $viewFile )

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

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

Параметры

строка $viewFile

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

afterRenderFilesource public

afterRenderFile( string $viewFile , string $content )

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

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

Параметры

строка $viewFile

Только что отрисованный файл.

строка $content

Содержимое, которое было отрисовано.

assetTimestampsource public

assetTimestamp( string $path )

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

Параметры

строка $path

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

Возвращает

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

assetUrlsource public

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

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

Параметры

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

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

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

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

Возвращает

string
Сгенерированный URL

beforeLayoutsource public

beforeLayout( string $layoutFile )

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

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

Параметры

строка $layoutFile

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

beforeRendersource public

beforeRender( string $viewFile )

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

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

Параметры

строка $viewFile

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

beforeRenderFilesource public

beforeRenderFile( string $viewFile )

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

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

Параметры

строка $viewFile

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

cleansource public

clean( string|array $output )

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

Устарело

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

Параметры

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

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

Возвращает

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

domIdsource public

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

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

Параметры

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

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

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

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

Возвращает

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

entitysource public

entity( )

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

Возвращает

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

fieldsource public

field( )

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

Возвращает

string
строка

modelsource public

model( )

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

Возвращает

string
строка

outputsource public

output( string $str )

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

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

Устарело

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

Параметры

строка $str

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

Возвращает

string
строка

setEntitysource public

setEntity( string $entity , boolean $setScope false )

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

Параметры

строка $entity

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

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

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

urlsource public

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

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

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

Параметры

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

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

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

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

Возвращает

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

Ссылка

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

valuesource public

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

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

Параметры

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

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

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

Имя поля.

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

Имя атрибута, который нужно установить, по умолчанию 'value'.

Возвращает

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

webrootsource public

webroot( string $file )

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

Параметры

строка $file

Файл для создания пути к файлу webroot.

Возвращает

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

_mergeVarssource protected

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

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

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

Параметры

массив $properties

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

строка $class

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

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

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

_setsource protected

_set( array $properties array() )

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

Параметры

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

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

_stopsource protected

_stop( integer|string $status 0 )

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

Параметры

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

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

dispatchMethodsource public

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

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

Параметры

строка $method

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

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

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

Возвращает

mixed
Возвращает результат вызова метода

logsource 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
Успешность записи в журнал

requestActionsource 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, а также именованных/переданных аргументов.

Возвращает

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

toStringsource public

toString( )

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

Возвращает

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

'%s="%s"'

null

array(
    'year', 'month', 'day', 'hour', 'min', 'second', 'meridian'
)

array()

'%s="%s"'

array(
    'allowfullscreen',
    'async',
    'autofocus',
    'autoplay',
    'checked',
    'compact',
    'controls',
    'declare',
    'default',
    'defaultchecked',
    'defaultmuted',
    'defaultselected',
    'defer',
    'disabled',
    'enabled',
    'formnovalidate',
    'hidden',
    'indeterminate',
    'inert',
    'ismap',
    'itemscope',
    'loop',
    'multiple',
    'muted',
    'nohref',
    'noresize',
    'noshade',
    'novalidate',
    'nowrap',
    'open',
    'pauseonexit',
    'readonly',
    'required',
    'reversed',
    'scoped',
    'seamless',
    'selected',
    'sortable',
    'spellcheck',
    'truespeed',
    'typemustmatch',
    'visible'
)

null

array()

array()

null

null

array()

array()

null