Класс RssHelper

channelsource public

channel( array $attrib array() , array $elements array() , string $content null )

Возвращает элемент RSS <channel />

Параметры

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

<channel /> атрибуты тега

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

Именованный массив элементов, которые преобразуются в теги

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

Содержание (<item />, относящиеся к этому каналу)

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

string
Элемент RSS <channel />

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/rss.html#RssHelper::channel

documentsource public

document( array $attrib array() , string $content null )

Возвращает документ RSS, заключенный в <rss /> теги

Параметры

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

<rss /> атрибуты тега

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

Содержимое тега.

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

string
Документ RSS

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/rss.html#RssHelper::document

elemsource public

elem( string $name , array $attrib array() , string|array $content null , boolean $endTag true )

Генерирует XML элемент

Параметры

строка $name

Имя XML элемента

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

Атрибуты XML элемента

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

Содержимое XML элемента

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

Нужно ли печатать закрывающий тег элемента

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

string
XML

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/rss.html#RssHelper::elem

itemsource public

item( array $att array() , array $elements array() )

Преобразует массив в элемент <item /> и его содержимое

Параметры

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

Атрибуты элемента <item />

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

Список элементов, содержащихся в этом элементе <item />

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

string
Элемент RSS <item />

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/rss.html#RssHelper::item

itemssource public

items( array $items , string|array $callback null )

Преобразует массив данных с помощью необязательного обратного вызова и отображает его в виде набора тегов <item />

Параметры

массив $items

Список элементов для отображения

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

Имя функции-строки или массив, содержащий объект и имя метода строки

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

string
Набор элементов RSS <item />

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/rss.html#RssHelper::items

timesource public

time( integer|string|DateTime $time )

Преобразует время в любом формате в RSS время

Параметры

целое число|строка|DateTime $time

Маркер времени Unix или допустимая строка времени или объект DateTime.

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

string
Маркер времени в формате RSS

См. также

TimeHelper::toRSS()

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/rss.html#RssHelper::time

__callsource public

__call( string $method , array $params )

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

Параметры

строка $method

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

массив $params

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

__constructsource public

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

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

Параметры

View $View

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

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

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

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

Object::__construct()

__getsource public

__get( string $name )

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

Устарело

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

Параметры

строка $name

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

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

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

__setsource public

__set( string $name , mixed $value )

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

Устарело

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

Параметры

строка $name

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

смешанное значение $value

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

_cleansource protected

_clean( )

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

_confirmsource protected

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

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

Параметры

строка $message

Сообщение, которое будет отображено

строка $okCode

Код, который будет выполнен после того, как пользователь выбрал 'ОК'

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

Код, который будет выполнен после того, как пользователь выбрал 'Отмена'

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

Массив опций

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

string
JS код onclick

_encodeUrlsource 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' )

Получает имя поля ввода для текущего тега. Создаёт атрибуты имени input с использованием формата 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' (строка)

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

'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 Ложное значение предотвратит обработку пути как плагина.

Возвращает

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() для генерации идентификатора с использованием верблюжьего регистра.

Параметры

массив|строка $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

Имя поля, например, "ИмяМодели.ИмяПоля" или "ИмяМодели.ИД.ИмяПоля"

логическое значение $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.

Это обеспечивает часть магической функциональности 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
Название этого класса

null

null

null

null

array('Time')

null

null

array()

'2.0'

'%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()

null

null

array()

array()

null