Класс RssHelper

__construct()source public deprecated

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

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

Параметры

Cake\View\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

Параметры

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

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

логическое|строка $merge необязательно false

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

Исключения

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

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

логическое $merge необязательно 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

Значение по умолчанию, если ключ не существует.

Возвращает

смешанный
Значение считываемой конфигурации.

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 необязательно null

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

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

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

Возвращает

$this

Исключения

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

['Url', 'Time']

[]

'2.0'