Класс RssHelper

__construct()source public deprecated

__construct( Cake\View\View $view , array $settings = [] )

Конструктор по умолчанию

Параметры

Cake\View\View $view

Просмотр, к которому прикреплён помощник.

массив $settings необязательно []

$config Параметры настройки помощника.

Переопределяет

Cake\View\Helper::__construct()

channel()source public deprecated

channel( array $attrib = [] , array $elements = [] , string|null $content = null )

Возвращает элемент RSS <channel />

Параметры

массив $attrib необязательно []

Атрибуты тега

массив $elements необязательно []

Элементы массива с именованными элементами, которые преобразуются в теги

строка|null $content необязательно null

Содержание (<item />, относящиеся к этому каналу)

Возвращает

строка
Элемент RSS %%%CODE_BLOCK_45%%;

document()source public deprecated

document( array $attrib = [] , string|null $content = null )

Возвращает документ RSS, заключённый в теги <rss />

Параметры

массив $attrib необязательно []

Атрибуты тега

строка|null $content необязательно null

Содержание тега.

Возвращает

строка
Документ RSS

elem()source public deprecated

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 deprecated

implementedEvents( )

Обработчики событий.

Возвращает

массив

Переопределяет

Cake\View\Helper::implementedEvents()

item()source public deprecated

item( array $att = [] , array $elements = [] )

Преобразует массив в элемент <item /> и его содержимое

Параметры

массив $att необязательно []

Атрибуты элемента <item />

массив $elements необязательно []

Список элементов, содержащихся в этом элементе <item />

Возвращает

строка
Элемент RSS <item />

items()source public deprecated

items( array $items , string|array|null $callback = null )

Преобразует массив данных с помощью необязательного обратного вызова и отображает его в набор тегов <item />

Параметры

массив $items

Список элементов для отображения

строка|массив|null $callback необязательно null

Имя строки-функции или массив, содержащий объект и имя строки метода

Возвращает

строка
Набор элементов RSS <item />

time()source public deprecated

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

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

__debugInfo()source public

__debugInfo( )

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

Возвращаемое значение

массив

__get()source public

__get( string $name )

Леничная загрузка хелперов.

Параметры

строка $name

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

Возвращаемое значение

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

__set()source public

__set( string $name , mixed $value )

Магический сеттер для удаленных свойств.

Параметры

строка $name

Имя свойства.

смешанный $value

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

_cleanConfirmMessage()source protected

_cleanConfirmMessage( string $message )

Возвращает строку, готовую для использования в confirm()

Параметры

строка $message

Сообщение для очистки

Возвращаемое значение

смешанный

_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.

getView()source public

getView( )

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

Возвращаемое значение

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

initialize()source public

initialize( array $config )

Метод-обработчик конструктора.

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

Параметры

массив $config

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

_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

True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.

Выбрасывает

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

config()source public deprecated

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->configShallow('key', $value);

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

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

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

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

Параметры

строка|массив $key

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

смешанный|null $value необязательно 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');

Параметры

строка|null $key необязательно null

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

смешанный $default необязательно null

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

Возвращаемое значение

смешанный
Данные конфигурации по указанному ключу или null, если ключ не существует.

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']);

Параметры

строка|массив $key

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

смешанный|null $value необязательно null

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

boolean $merge необязательно true

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

Возвращаемое значение

$this

Выбрасывает

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

['Url', 'Time']

[]

'2.0'