Class RssHelper

RSS Helper class for easy output RSS structures.

Namespace: Cake\View\Helper

Properties summary

  • $Time public
    \Cake\View\Helper\TimeHelper
  • $Url public
    \Cake\View\Helper\UrlHelper
  • $_View protected
    \Cake\View\View

    The View instance this helper is attached to

  • $_config protected
    array

    Runtime config

  • $_configInitialized protected
    bool

    Whether the config property has already been configured with defaults

  • $_defaultConfig protected
    array

    Default config for this helper.

  • $_helperMap protected
    array

    A helper lookup table used to lazy load helper objects.

  • $action public
    string

    Current action.

  • $base public
    string

    Base URL

  • $data public
    array

    POSTed model data

  • $field public
    string

    Name of the current field

  • $fieldset public
    array

    Unused.

  • $helpers public
    array

    Helpers used by RSS Helper

  • $here public
    string

    URL to current action.

  • $model public
    string

    Name of the current model

  • $params public
    array

    Parameter array.

  • $tags public
    array

    Unused.

  • $version public
    string

    Default spec version of generated RSS

Method Summary

  • __call() public

    Provide non fatal errors on missing method calls.

  • __construct() public

    Default Constructor

  • __debugInfo() public

    Returns an array that can be used to describe the internal state of this object.

  • __get() public

    Lazy loads helpers.

  • __set() public

    Magic setter for removed properties.

  • _cleanConfirmMessage() protected

    Returns a string read to be used in confirm()

  • _configDelete() protected

    Deletes a single config key.

  • _configRead() protected

    Reads a config key.

  • _configWrite() protected

    Writes a config key.

  • _confirm() protected

    Returns a string to be used as onclick handler for confirm dialogs.

  • addClass() public

    Adds the given class to the element options

  • channel() public

    Returns an RSS <channel /> element

  • config() public

    Gets/Sets the config.

  • configShallow() public

    Merge provided config with existing config. Unlike config() which does a recursive merge for nested keys, this method does a simple merge.

  • document() public

    Returns an RSS document wrapped in <rss /> tags

  • elem() public

    Generates an XML element

  • getConfig() public

    Returns the config.

  • getConfigOrFail() public

    Returns the config for this specific key.

  • getView() public

    Get the view instance this helper is bound to.

  • implementedEvents() public

    Event listeners.

  • initialize() public

    Constructor hook method.

  • item() public

    Converts an array into an <item /> element and its contents

  • items() public

    Transforms an array of data using an optional callback, and maps it to a set of <item /> tags

  • setConfig() public

    Sets the config.

  • time() public

    Converts a time in any format to an RSS time

Method Detail

__call() public 

__call(mixed $method, mixed $params)

Provide non fatal errors on missing method calls.

Parameters

string $method

Method to invoke

array $params

Array of params for the method.

Returns

mixed|void

__construct() public 

__construct(\Cake\View\View $View, array $config)

Default Constructor

Parameters

\Cake\View\View $View

The View this helper is being attached to.

array $config optional

Configuration settings for the helper.

__debugInfo() public 

__debugInfo()

Returns an array that can be used to describe the internal state of this object.

Returns

array

__get() public 

__get(mixed $name)

Lazy loads helpers.

Parameters

string $name

Name of the property being accessed.

Returns

\Cake\View\Helper|null

Helper instance if helper with provided name exists

__set() public 

__set(mixed $name, mixed $value)

Magic setter for removed properties.

Parameters

string $name

Property name.

mixed $value

Value to set.

_cleanConfirmMessage() protected 

_cleanConfirmMessage(mixed $message)

Returns a string read to be used in confirm()

Parameters

string $message

The message to clean

Returns

mixed

_configDelete() protected 

_configDelete(mixed $key)

Deletes a single config key.

Parameters

string $key

Key to delete.

Throws

Cake\Core\Exception\Exception
if attempting to clobber existing config

_configRead() protected 

_configRead(mixed $key)

Reads a config key.

Parameters

string|null $key

Key to read.

Returns

mixed

_configWrite() protected 

_configWrite(mixed $key, mixed $value, mixed $merge)

Writes a config key.

Parameters

string|array $key

Key to write to.

mixed $value

Value to write.

bool|string $merge optional

True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.

Throws

Cake\Core\Exception\Exception
if attempting to clobber existing config

_confirm() protected 

_confirm(mixed $message, mixed $okCode, mixed $cancelCode, mixed $options)

Returns a string to be used as onclick handler for confirm dialogs.

Parameters

string $message

Message to be displayed

string $okCode

Code to be executed after user chose 'OK'

string $cancelCode optional

Code to be executed after user chose 'Cancel'

array $options optional

Array of options

Returns

string

onclick JS code

addClass() public 

addClass(array $options, mixed $class, mixed $key)

Adds the given class to the element options

Parameters

array $options optional

Array options/attributes to add a class to

string|null $class optional

The class name being added.

string $key optional

the key to use for class. Defaults to 'class'.

Returns

array

Array of options with $key set.

channel() public 

channel(mixed $attrib, mixed $elements, mixed $content)

Returns an RSS <channel /> element

Parameters

array $attrib optional

<channel /> tag attributes

array $elements optional

Named array elements which are converted to tags

string|null $content optional

Content (<item />'s belonging to this channel

Returns

string

An RSS <channel />

config() public 

config(mixed $key, mixed $value, mixed $merge)

Gets/Sets the config.

Usage

Reading the whole config:

$this->config();

Reading a specific value:

$this->config('key');

Reading a nested value:

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

Setting a specific value:

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

Setting a nested value:

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

Updating multiple config settings at the same time:

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

Parameters

string|array|null $key optional

The key to get/set, or a complete array of configs.

mixed|null $value optional

The value to set.

bool $merge optional

Whether to recursively merge or overwrite existing config, defaults to true.

Returns

mixed

Config value being read, or the object itself on write operations.

Throws

Cake\Core\Exception\Exception
When trying to set a key that is invalid.

configShallow() public 

configShallow(mixed $key, mixed $value)

Merge provided config with existing config. Unlike config() which does a recursive merge for nested keys, this method does a simple merge.

Setting a specific value:

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

Setting a nested value:

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

Updating multiple config settings at the same time:

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

Parameters

string|array $key

The key to set, or a complete array of configs.

mixed|null $value optional

The value to set.

Returns

$this

document() public 

document(mixed $attrib, mixed $content)

Returns an RSS document wrapped in <rss /> tags

Parameters

array $attrib optional

<rss /> tag attributes

string|null $content optional

Tag content.

Returns

string

An RSS document

elem() public 

elem(mixed $name, mixed $attrib, mixed $content, mixed $endTag)

Generates an XML element

Parameters

string $name

The name of the XML element

array $attrib optional

The attributes of the XML element

string|array|null $content optional

XML element content

bool $endTag optional

Whether the end tag of the element should be printed

Returns

string

XML

getConfig() public 

getConfig(mixed $key, mixed $default)

Returns the config.

Usage

Reading the whole config:

$this->getConfig();

Reading a specific value:

$this->getConfig('key');

Reading a nested value:

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

Reading with default value:

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

Parameters

string|null $key optional

The key to get or null for the whole config.

mixed|null $default optional

The return value when the key does not exist.

Returns

mixed|null

Configuration data at the named key or null if the key does not exist.

getConfigOrFail() public 

getConfigOrFail(mixed $key)

Returns the config for this specific key.

The config value for this key must exist, it can never be null.

Parameters

string|null $key

The key to get.

Returns

mixed

Configuration data at the named key

Throws

InvalidArgumentException

getView() public 

getView()

Get the view instance this helper is bound to.

Returns

\Cake\View\View

The bound view instance.

implementedEvents() public 

implementedEvents()

Event listeners.

Returns

array

initialize() public 

initialize(array $config)

Constructor hook method.

Implement this method to avoid having to overwrite the constructor and call parent.

Parameters

array $config

The configuration settings provided to this helper.

item() public 

item(mixed $att, mixed $elements)

Converts an array into an <item /> element and its contents

Parameters

array $att optional

The attributes of the <item /> element

array $elements optional

The list of elements contained in this <item />

Returns

string

An RSS <item /> element

items() public 

items(mixed $items, mixed $callback)

Transforms an array of data using an optional callback, and maps it to a set of <item /> tags

Parameters

array $items

The list of items to be mapped

string|array|null $callback optional

A string function name, or array containing an object and a string method name

Returns

string

A set of RSS <item /> elements

setConfig() public 

setConfig(mixed $key, mixed $value, mixed $merge)

Sets the config.

Usage

Setting a specific value:

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

Setting a nested value:

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

Updating multiple config settings at the same time:

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

Parameters

string|array $key

The key to set, or a complete array of configs.

mixed|null $value optional

The value to set.

bool $merge optional

Whether to recursively merge or overwrite existing config, defaults to true.

Returns

$this

Throws

Cake\Core\Exception\Exception
When trying to set a key that is invalid.

time() public 

time(mixed $time)

Converts a time in any format to an RSS time

Parameters

int|string|\DateTime $time

UNIX timestamp or valid time string or DateTime object.

Returns

string

An RSS-formatted timestamp

See Also

\Cake\View\Helper\TimeHelper::toRSS

Property Detail

$Time public

Type

\Cake\View\Helper\TimeHelper

$Url public

Type

\Cake\View\Helper\UrlHelper

$_View protected

The View instance this helper is attached to

Type

\Cake\View\View

$_config protected

Runtime config

Type

array

$_configInitialized protected

Whether the config property has already been configured with defaults

Type

bool

$_defaultConfig protected

Default config for this helper.

Type

array

$_helperMap protected

A helper lookup table used to lazy load helper objects.

Type

array

$action public

Current action.

Type

string

$base public

Base URL

Type

string

$data public

POSTed model data

Type

array

$field public

Name of the current field

Type

string

$fieldset public

Unused.

Type

array

$helpers public

Helpers used by RSS Helper

Type

array

$here public

URL to current action.

Type

string

$model public

Name of the current model

Type

string

$params public

Parameter array.

Type

array

$tags public

Unused.

Type

array

$version public

Default spec version of generated RSS

Type

string

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.9/class-Cake.View.Helper.RssHelper.html