Класс 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 необязательно []

<channel /> атрибуты тега

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

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

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

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

Возвращает

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

document()source public deprecated

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

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

Параметры

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

<rss /> атрибуты тега

строка|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

Параметры

integer|string|DateTime $time

Маркер временной метки Unix или допустимая строка времени или объект DateTime.

Возвращает

string
Отформатированное по стандарту RSS временное значение

См. также

\Cake\View\Helper\TimeHelper::toRSS

__call()source public

__call( string $method , array $params )

Предоставляет некритичные ошибки при вызовах отсутствующих методов.

Параметры

string $method

Метод для вызова

array $params

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

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

Параметры

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'