Класс 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
<channel />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 - 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 - Код, который будет выполнен после выбора пользователем 'OK'
- строка
$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 - Значение для записи.
- boolean|строка
$mergeнеобязательно false Истина для рекурсивного слияния, 'shallow' для простого слияния, ложь для перезаписи, по умолчанию ложь.
Исключения
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 - Значение для установки.
- boolean
$mergeнеобязательно true - Выполнять рекурсивное слияние или перезаписывать существующую конфигурацию, по умолчанию 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–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.2/class-Cake.View.Helper.RssHelper.html