Класс RssHelper

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

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

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

Возвращает

array

__get()source public

__get( string $name )

Ленично загружает помощники.

Параметры

string $name

Имя свойства, к которому осуществляется доступ.

Возвращает

Cake\View\Helper|null
Экземпляр помощника, если помощник с указанным именем существует

_confirm()source protected

_confirm( string $message , string $okCode , string $cancelCode '' , array $options [] )

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

Параметры

string $message

Сообщение, которое должно быть отображено

string $okCode

Код, который будет выполнен после того, как пользователь выбрал 'OK'

string $cancelCode optional ''

Код, который будет выполнен после того, как пользователь выбрал 'Отмена'

array $options optional []

Массив опций

Возвращает

string
JS-код onclick

addClass()source public

addClass( array $options [] , string|null $class null , string $key 'class' )

Добавляет указанный класс к опциям элемента.

Параметры

array $options optional []

Массив опций/атрибутов для добавления класса

string|null $class optional null

Имя добавляемого класса.

string $key optional 'class'

Ключ для использования класса.

Возвращает

array
Массив опций с установленным $key.

getView()source public

getView( )

Получить экземпляр представления, к которому привязан этот помощник.

Возвращает

Cake\View\View
Экземпляр привязанного представления.

initialize()source public

initialize( array $config )

Метод обратного вызова конструктора.

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

Параметры

array $config

Настройки конфигурации, предоставленные этому помощнику.

_configDelete()source protected

_configDelete( string $key )

Удаляет единственный ключ конфигурации.

Параметры

string $key

Ключ для удаления.

Выбрасывает

Cake\Core\Exception\Exception
если пытаетесь перезаписать существующую конфигурацию

_configRead()source protected

_configRead( string|null $key )

Читает ключ конфигурации.

Параметры

string|null $key

Ключ для чтения.

Возвращает

mixed

_configWrite()source protected

_configWrite( string|array $key , mixed $value , boolean|string $merge false )

Записывает ключ конфигурации.

Параметры

string|array $key

Ключ для записи.

mixed $value

Значение для записи.

boolean|string $merge optional 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']);

Параметры

string|array|null $key optional null

Ключ для получения/установки или весь массив конфигураций.

mixed|null $value optional null

Значение для установки.

boolean $merge optional true

Выполнять рекурсивное слияние или перезаписывать существующую конфигурацию, по умолчанию - true.

Возвращает

mixed
Значение конфигурации, которое считывается, или сам объект при операциях записи.

Выбрасывает

Cake\Core\Exception\Exception
При попытке установить недопустимый ключ.

configShallow()source public

configShallow( string|array $key , mixed|null $value null )

Объединить предоставленную конфигурацию с существующей конфигурацией. В отличие от config(), которая выполняет рекурсивное слияние для вложенных ключей, этот метод выполняет простое слияние.

Установка определенного значения:

$this->configShallow('key', $value);

Установка вложенного значения:

$this->configShallow('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->configShallow(['one' => 'value', 'another' => 'value']);

Параметры

string|array $key

Ключ для установки или весь массив конфигураций.

mixed|null $value optional null

Значение для установки.

Возвращает

$this

getConfig()source public

getConfig( string|null $key null , mixed $default null )

Возвращает конфигурацию.

Использование

Чтение всей конфигурации:

$this->getConfig();

Чтение определенного значения:

$this->getConfig('key');

Чтение вложенного значения:

$this->getConfig('some.nested.key');

Чтение со значением по умолчанию:

$this->getConfig('some-key', 'default-value');

Параметры

string|null $key optional null

Ключ для получения или null для всей конфигурации.

mixed $default optional null

Значение возврата, когда ключ не существует.

Возвращает

mixed
Значение конфигурации, которое считывается.

setConfig()source public

setConfig( string|array $key , mixed|null $value null , boolean $merge true )

Устанавливает конфигурацию.

Использование

Установка определенного значения:

$this->setConfig('key', $value);

Установка вложенного значения:

$this->setConfig('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->setConfig(['one' => 'value', 'another' => 'value']);

Параметры

string|array $key

Ключ для установки или весь массив конфигураций.

mixed|null $value optional null

Значение для установки.

boolean $merge optional true

Выполнять рекурсивное слияние или перезаписывать существующую конфигурацию, по умолчанию - true.

Возвращает

$this

Выбрасывает

Cake\Core\Exception\Exception
При попытке установить недопустимый ключ.

['Url', 'Time']

[]

'2.0'