Класс RssHelper

channel()source public

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

Возвращает элемент RSS канала.

Параметры

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

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

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

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

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

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

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

строка
Элемент RSS канала

Ссылка

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

document()source public

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

Возвращает документ RSS, обернутый в XML теги.

Параметры

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

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

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

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

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

строка
Документ RSS

Ссылка

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

elem()source 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

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

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

строка
XML

Ссылка

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

item()source public

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

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

Параметры

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

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

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

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

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

строка
Элемент RSS

Ссылка

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

items()source public

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

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

Параметры

массив $items

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

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

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

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

строка
Набор элементов RSS

Ссылка

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

time()source public

time( integer|string|DateTime $time )

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

Параметры

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

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

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

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

См. также

TimeHelper::toRSS

Ссылка

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

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

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

Параметры

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

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

строка $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' (строка)

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

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

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

Параметры

массив|строка $options optional null

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

строка $id optional 'id'

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

Возвращает

смешанное

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

entity()source public

entity( )

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

Возвращает

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

field()source public

field( )

Получает текущее поле модели контекста рендеринга. Удаляет суффиксы полей, такие как год, месяц, день, час, мин, меридиан, когда текущая сущность содержит более 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 optional false

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

url()source public

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

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

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

Параметры

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

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

логическое значение $full optional 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 optional array()

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

строка $field optional null

Имя поля.

строка $key optional '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 необязательно array()

Список параметров для использования при вызове $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 необязательно array()

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

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

mixed

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

toString()source public

toString( )

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

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

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

null

null

null

null

array('Time')

null

null

array()

'2.0'