Spec-Zone.ru › CakePHP 3.3

Класс RssHelper

Класс RSS Helper для удобного вывода структур RSS.

Cake\View\Helper реализует Cake\Event\EventListenerInterface использует Cake\Core\InstanceConfigTrait
Расширяется Cake\View\Helper\RssHelper
Пространство имён: Cake\View\Helper
Ссылка: http://book.cakephp.org/3.0/ru/views/helpers/rss.html
Расположение: View/Helper/RssHelper.php

Краткое описание свойств

  • $action public
    string
    Текущее действие.
  • $base public
    string
    Базовый URL
  • $data public
    array
    Данные модели, переданные методом POST
  • $field public
    string
    Имя текущего поля
  • $helpers public
    array
    Помощники, используемые RSS Helper
  • $here public
    string
    URL текущего действия.
  • $model public
    string
    Имя текущей модели
  • $params public
    array
    Массив параметров.
  • $version public
    string
    Установленная версия спецификации сгенерированного RSS

Краткое описание магических свойств

  • $Time public
    Cake\View\Helper\TimeHelper
  • $Url public
    Cake\View\Helper\UrlHelper

Унаследованные свойства

  • _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( )

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

Возвращает

массив
END_OF_DOCUMENT_MARKER

__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 Объект самого себя.

Подробности свойств

$actionsource

public строка

Текущее действие.

null

$basesource

public строка

Базовый URL

null

$datasource

public массив

Данные модели, отправленные методом POST

null

$fieldsource

public строка

Имя текущего поля

null

$helperssource

public массив

Помощники, используемые помощником RSS

['Url', 'Time']

$heresource

public строка

URL текущего действия.

null

$modelsource

public строка

Имя текущей модели

null

$paramssource

public массив

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

[]

$versionsource

public строка

Версия спецификации по умолчанию сгенерированного RSS

'2.0'

Подробности магических свойств

$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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API