Класс RssHelper
Класс RSS Helper для удобного вывода структур RSS.
- Cake\View\Helper реализует Cake\Event\EventListenerInterface использует Cake\Core\InstanceConfigTrait
-
Cake\View\Helper\RssHelper
Ссылка: http://book.cakephp.org/3.0/ru/views/helpers/rss.html
Расположение: View/Helper/RssHelper.php
Краткое описание свойств
-
$actionpublicТекущее действие.string -
$basepublicБазовый URLstring -
$datapublicДанные модели, переданные методом POSTarray -
$fieldpublicИмя текущего поляstring -
$helperspublicПомощники, используемые RSS Helperarray -
$herepublicURL текущего действия.string -
$modelpublicИмя текущей моделиstring -
$paramspublicМассив параметров.array -
$versionpublicУстановленная версия спецификации сгенерированного RSSstring
Краткое описание магических свойств
Унаследованные свойства
-
_View,_defaultConfig,_helperMap,fieldset,plugin,request,tags,theme_config,_configInitialized
Краткое описание методов
- channel() publicВозвращает элемент RSS
<channel /> - document() publicВозвращает документ RSS, заключённый в теги
<rss /> - elem() publicГенерирует XML элемент
- implementedEvents() publicОбработчики событий.
- item() publicПреобразует массив в элемент
<item />и его содержимое - items() public
Преобразует массив данных с помощью необязательного обратного вызова и отображает его в наборе тегов
<item /> - time() publicПреобразует время в любом формате в время RSS
Подробное описание методов
channel()source public
channel( array $attrib [] , array $elements [] , string|null $content null )
Возвращает элемент RSS <channel />
Параметры
- массив
$attribнеобязательно [] -
<channel />атрибуты тега - массив
$elementsнеобязательно [] - Именованные элементы массива, которые преобразуются в теги
- строка|null
$contentнеобязательно null - Содержимое (
<item />, относящиеся к этому каналу)
Возвращает
строкаЭлемент RSS %%%CODE_BLOCK_43%%+
document()source public
document( array $attrib [] , string|null $content null )
Возвращает документ RSS, заключённый в теги <rss />
Параметры
- массив
$attribнеобязательно [] -
<rss />атрибуты тега - строка|null
$contentнеобязательно null - Содержимое тега.
Возвращает
строкаДокумент RSS
elem()source public
elem( string $name , array $attrib [] , string|array|null $content null , boolean $endTag true )
Генерирует XML элемент
Параметры
- строка
$name - Имя XML элемента
- массив
$attribнеобязательно [] - Атрибуты XML элемента
- строка|массив|null
$contentнеобязательно null - Содержимое XML элемента
- логическое
$endTagнеобязательно true - Нужно ли выводить закрывающий тег элемента
Возвращает
строкаXML
implementedEvents()source public
implementedEvents( )
Обработчики событий.
Возвращает
массивПереопределяет
Cake\View\Helper::implementedEvents() item()source public
item( array $att [] , array $elements [] )
Преобразует массив в элемент <item /> и его содержимое
Параметры
- массив
$attнеобязательно [] - Атрибуты элемента
<item /> - массив
$elementsнеобязательно [] - Список элементов, содержащихся в этом элементе
<item />
Возвращает
строкаЭлемент RSS
<item />items()source public
items( array $items , string|array|null $callback null )
Преобразует массив данных с помощью необязательного обратного вызова и отображает его в наборе тегов <item />
Параметры
- массив
$items - Список элементов для отображения
- строка|массив|null
$callbackнеобязательно null Имя строки функции или массив, содержащий объект и имя метода строки
Возвращает
строкаНабор элементов RSS
<item />time()source public
time( integer|string|DateTime $time )
Преобразует время в любом формате в время RSS
Параметры
- целое число|строка|DateTime
$time - Маркер времени Unix или корректная строка времени или объект DateTime.
Возвращает
строкаОтформатированный по RSS маркер времени
См.
\Cake\View\Helper\TimeHelper::toRSSМетоды унаследованные от Cake\View\Helper
__call()source public
__call( string $method , array $params )
Обеспечивает некритичные ошибки при вызове отсутствующих методов.
Параметры
- строка
$method - Метод для вызова
- массив
$params - Массив параметров для метода.
__construct()source public
__construct( Cake\View\View $View , array $config [] )
Конструктор по умолчанию
Параметры
-
Cake\View\View$View - Представление, к которому прикреплён помощник.
- массив
$configнеобязательно [] - Параметры настройки помощника.
__debugInfo()source public
__debugInfo( )
Возвращает массив, который можно использовать для описания внутреннего состояния объекта.
Возвращает
массив__get()source public
__get( string $name )
Ленично загружает помощники.
Параметры
- строка
$name - Имя свойства, к которому осуществляется доступ.
Возвращает
Cake\View\Helper|nullЭкземпляр помощника, если помощник с заданным именем существует
_confirm()source protected
_confirm( string $message , string $okCode , string $cancelCode '' , array $options [] )
Возвращает строку, которая будет использоваться в качестве обработчика onclick для диалоговых окон подтверждения.
Параметры
- строка
$message - Сообщение, которое должно отображаться
- строка
$okCode - Код, который будет выполнен после того, как пользователь выбрал 'ОК'
- строка
$cancelCodeнеобязательно '' - Код, который будет выполнен после того, как пользователь выбрал 'Отмена'
- массив
$optionsнеобязательно [] - Массив опций
Возвращает
строкаJS-код onclick
addClass()source public
addClass( array $options [] , string|null $class null , string $key 'class' )
Добавляет заданный класс к опциям элемента
Параметры
- массив
$optionsнеобязательно [] - Массив опций/атрибутов для добавления класса
- строка|null
$classнеобязательно null - Имя добавляемого класса.
- строка
$keyнеобязательно 'class' - Ключ, используемый для класса.
Возвращает
массивМассив опций со значением $key.
initialize()source public
initialize( array $config )
Метод обратного вызова конструктора.
Реализуйте этот метод, чтобы избежать необходимости перезаписывать конструктор и вызывать родительский.
Параметры
- массив
$config - Настройки конфигурации, предоставленные этому помощнику.
Методы, используемые из Cake\Core\InstanceConfigTrait
_configDelete()source protected
_configDelete( string $key )
Удаление одного ключа конфигурации
Параметры
- строка
$key - Ключ для удаления.
Выбрасывает
Cake\Core\Exception\Exceptionесли пытаетесь перезаписать существующую конфигурацию
_configRead()source protected
_configRead( string|null $key )
Чтение переменной конфигурации
Параметры
- строка|null
$key - Ключ для чтения.
Возвращает
смешанное_configWrite()source protected
_configWrite( string|array $key , mixed $value , boolean|string $merge false )
Запись переменной конфигурации
Параметры
- строка|массив
$key - Ключ для записи.
- смешанное
$value - Значение для записи.
- логическое|строка
$mergeнеобязательно false Истина для рекурсивного слияния, 'поверхностное' для простого слияния, ложь для перезаписи, по умолчанию ложь.
Выбрасывает
Cake\Core\Exception\Exceptionесли пытаетесь перезаписать существующую конфигурацию
config()source 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']);
Параметры
- строка|массив|null
$keyнеобязательно null - Ключ для получения/установки или полный массив конфигураций.
- смешанное|null
$valueнеобязательно null - Значение для установки.
- логическое
$mergeнеобязательно true - Является ли рекурсивное слияние или перезапись существующей конфигурации, по умолчанию истинно.
Возвращает
смешанноеЧтение значения конфигурации или самого объекта при операциях записи.
Выбрасывает
Cake\Core\Exception\ExceptionПри попытке установить недопустимый ключ.
configShallow()source 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']);
Параметры
- строка|массив
$key - Ключ для установки или полный массив конфигураций.
- смешанное|null
$valueнеобязательно null - Значение для установки.
Возвращает
$this Объект самого себя.
Подробности свойств
Подробности магических свойств
$Timesource
public Cake\View\Helper\TimeHelper
$Urlsource
public Cake\View\Helper\UrlHelper
© 2005–2017 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.
https://api.cakephp.org/3.3/class-Cake.View.Helper.RssHelper.html