Класс RssHelper
Класс RSS Helper для удобной выдачи структур RSS.
- Cake\View\Helper реализует Cake\Event\EventListenerInterface использует Cake\Core\InstanceConfigTrait
-
Cake\View\Helper\RssHelper
Ссылка: http://book.cakephp.org/3.0/en/views/helpers/rss.html
Расположено в View/Helper/RssHelper.php
Подробное описание методов
channelsource public
channel( array $attrib [] , array $elements [] , string|null $content null )
Возвращает элемент RSS <channel />
Параметры
- массив
$attribнеобязательно [] -
<channel />атрибуты тега - массив
$elementsнеобязательно [] - Элементы массива с именами, которые преобразуются в теги
- строка|null
$contentнеобязательно null - Содержание (
<item />принадлежащие этому каналу)
Возвращает
stringЭлемент RSS
<channel />documentsource public
document( array $attrib [] , string|null $content null )
Возвращает документ RSS, заключённый в теги <rss />
Параметры
- массив
$attribнеобязательно [] -
<rss />атрибуты тега - строка|null
$contentнеобязательно null - Содержимое тега.
Возвращает
stringДокумент RSS
elemsource public
elem( string $name , array $attrib [] , string|array $content null , boolean $endTag true )
Генерирует XML-элемент
Параметры
- строка
$name - Имя XML-элемента
- массив
$attribнеобязательно [] - Атрибуты XML-элемента
- строка|массив
$contentнеобязательно null - Содержимое XML-элемента
- логическое значение
$endTagнеобязательно true - Нужно ли выводить закрывающий тег элемента
Возвращает
stringXML
implementedEventssource public
implementedEvents( )
Обработчики событий.
Возвращает
arrayмассив
Переопределяет
Cake\View\Helper::implementedEvents() itemsource public
item( array $att [] , array $elements [] )
Преобразует массив в элемент <item /> и его содержимое
Параметры
- массив
$attнеобязательно [] - Атрибуты элемента
<item /> - массив
$elementsнеобязательно [] - Список элементов, содержащихся в этом элементе
<item />
Возвращает
stringЭлемент RSS
<item />itemssource public
items( array $items , string|array|null $callback null )
Преобразует массив данных с помощью необязательного обратного вызова и отображает его как набор тегов <item />
Параметры
- массив
$items - Список элементов для отображения
- строка|массив|null
$callbackнеобязательно null - Имя функции-строки или массив, содержащий объект и имя метода-строки
Возвращает
stringНабор элементов RSS
<item />timesource public
time( integer|string|DateTime $time )
Преобразует время в любом формате в формат времени RSS
Параметры
- целое число|строка|DateTime
$time - Маркер времени Unix или допустимая строка времени или объект DateTime.
Возвращает
stringМаркер времени в формате RSS
См. также
TimeHelper::toRSSНаследованные методы из Cake\View\Helper
__callsource public
__call( string $method , array $params )
Предоставляет некритические ошибки при вызовах отсутствующих методов.
Параметры
- строка
$method - Вызываемый метод
- массив
$params - Массив параметров для метода.
__constructsource public
__construct( Cake\View\View $View , array $config [] )
Конструктор по умолчанию
Параметры
-
Cake\View\View$View - Представление, к которому прикреплён помощник.
- массив
$configнеобязательно [] - Настройки конфигурации помощника.
__debugInfosource public
__debugInfo( )
Возвращает массив, который можно использовать для описания внутреннего состояния объекта.
Возвращает
arrayмассив
__getsource public
__get( string $name )
Загружает помощников по мере необходимости.
Параметры
- строка
$name - Имя свойства, к которому осуществляется доступ.
Возвращает
Cake\View\Helper|nullЭкземпляр помощника, если помощник с заданным именем существует
_confirmsource protected
_confirm( string $message , string $okCode , string $cancelCode '' , array $options [] )
Возвращает строку, используемую в качестве обработчика onclick для диалоговых окон подтверждения.
Параметры
- строка
$message - Сообщение для отображения
- строка
$okCode - Код, который выполняется после выбора пользователем «ОК»
- строка
$cancelCodeнеобязательно '' - Код, который выполняется после выбора пользователем «Отмена»
- массив
$optionsнеобязательно [] - Массив параметров
Возвращает
stringJS-код onclick
addClasssource public
addClass( array $options [] , string $class null , string $key 'class' )
Добавляет указанный класс к параметрам элемента
Параметры
- массив
$optionsнеобязательно [] - Массив параметров/атрибутов, к которому добавляется класс
- строка
$classнеобязательно null - Имя добавляемого класса.
- строка
$keyнеобязательно 'class' - Ключ для использования класса.
Возвращает
arrayМассив параметров с установленным $key.
Методы, используемые из Cake\Core\InstanceConfigTrait
_configDeletesource protected
_configDelete( string $key )
Удаляет единственный ключ конфигурации
Параметры
- строка
$key - Ключ для удаления.
Выбрасывает
Cake\Core\Exception\Exceptionесли пытаетесь переписать существующую конфигурацию
_configReadsource protected
_configRead( string|null $key )
Читает переменную конфигурации
Параметры
- строка|null
$key - Ключ для чтения.
Возвращает
mixedсмешанный тип
_configWritesource protected
_configWrite( string|array $key , mixed $value , boolean|string $merge false )
Запись переменной конфигурации
Параметры
- string|array
$key - Ключ для записи.
- mixed
$value - Значение для записи.
- boolean|string
$mergeнеобязательно false - Истина для рекурсивного слияния, 'shallow' для простого слияния, ложь для перезаписи, по умолчанию ложь.
Исключения
Cake\Core\Exception\Exceptionпри попытке перезаписать существующую конфигурацию
configsource public
config( string|array|null $key null , mixed|null $value null , boolean $merge true )
Использование
Чтение всей конфигурации:
$this->config();
Чтение определённого значения:
$this->config('key');
Чтение вложенного значения:
$this->config('some.nested.key');
Установка определённого значения:
$this->config('key', $value);
Установка вложенного значения:
$this->config('some.nested.key', $value);
Обновление нескольких параметров конфигурации одновременно:
$this->config(['one' => 'value', 'another' => 'value']);
Параметры
- string|array|null
$keyнеобязательно null - Ключ для получения/установки, или полный массив конфигураций.
- mixed|null
$valueнеобязательно null - Значение для установки.
- boolean
$mergeнеобязательно true - Выполнять ли рекурсивное слияние или перезапись существующей конфигурации, по умолчанию истина.
Возвращает
mixedЗначение конфигурации, которое читается, или сам объект при операциях записи.
Исключения
Cake\Core\Exception\ExceptionПри попытке установить недопустимый ключ.
configShallowsource public
configShallow( string|array $key , mixed|null $value null )
Слияние предоставленной конфигурации с существующей конфигурацией. В отличие от config() , которая выполняет рекурсивное слияние для вложенных ключей, этот метод выполняет простое слияние.
Установка определённого значения:
$this->config('key', $value);
Установка вложенного значения:
$this->config('some.nested.key', $value);
Обновление нескольких параметров конфигурации одновременно:
$this->config(['one' => 'value', 'another' => 'value']);
Параметры
- string|array
$key - Ключ для установки или полный массив конфигураций.
- mixed|null
$valueнеобязательно null - Значение для установки.
Возвращает
mixed$this Сам объект.
Резюме свойств
Наследуемые свойства из Cake\View\Helper
$_helperMapsource
protected array
Таблица поиска помощников, используемая для ленивой загрузки объектов помощников.
[]
$fieldsetsource
public array
Содержит поля ['имя_поля' => ['тип' => 'строка', 'длина' => 100]], первичный ключ и валидирует ['имя_поля']
[]
Используемые свойства из Cake\Core\InstanceConfigTrait
$_configInitializedsource
protected boolean
Указатель, был ли объект конфигурации предварительно сконфигурирован со значениями по умолчанию
false Резюме магических свойств
$Timesource
public Cake\View\Helper\TimeHelper
$Urlsource
public Cake\View\Helper\UrlHelper
© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
http://api.cakephp.org/3.1/class-Cake.View.Helper.RssHelper.html