Класс FlashHelper

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

render( string $key 'flash' , array $options array() )

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

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

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

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

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

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

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

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

echo $this->Flash->render('flash', array(
  'element' => 'MyPlugin.my_custom_element',
));

Параметры

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

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

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

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

Возвращает

string|null
Отображённое сообщение флэша или null, если ключ флэша отсутствует в сессии.

Выбрасывает

UnexpectedValueException
Если значение ключа настроек flash не является массивом.

__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.

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

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

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

Устарело

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

Параметры

строка $key

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

строка $value

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

булево $escape необязательно true

Указывает, нужно ли экранировать значение.

Возвращает

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

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

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

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

Параметры

строка $field

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

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

Массив параметров, используемых при инициализации поля ввода.

Возвращает

array
Параметры массива для поля формы.

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

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

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

Параметры

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

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

строка $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() для генерации идентификатора атрибута в формате CamelCase.

Параметры

массив|строка $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
Web-доступный путь к файлу.

_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() )

Вызывает метод этого объекта с заданными параметрами. Предоставляет оболочку OO для 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 при успехе/неудаче или содержимое отрисованного действия, если 'return' установлен в $extra.

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