Класс 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

True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию 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']);

Параметры

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'