Class RssHelper

__construct()source public deprecated

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

Default Constructor

Parameters

Cake\View\View $view

The View this helper is being attached to.

array $settings optional []

$config Configuration settings for the helper.

Overrides

Cake\View\Helper::__construct()

channel()source public deprecated

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

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 null

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

Returns

string
An RSS <channel />

document()source public deprecated

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

Returns an RSS document wrapped in <rss /> tags

Parameters

array $attrib optional []

<rss /> tag attributes

string|null $content optional null

Tag content.

Returns

string
An RSS document

elem()source public deprecated

elem( string $name , array $attrib = [] , string|array|null $content = null , boolean $endTag = true )

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 null

XML element content

boolean $endTag optional true

Whether the end tag of the element should be printed

Returns

string
XML

implementedEvents()source public deprecated

implementedEvents( )

Event listeners.

Returns

array

Overrides

Cake\View\Helper::implementedEvents()

item()source public deprecated

item( array $att = [] , array $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()source public deprecated

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

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 null

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

Returns

string
A set of RSS <item /> elements

time()source public deprecated

time( integer|string|DateTime $time )

Converts a time in any format to an RSS time

Parameters

integer|string|DateTime $time

UNIX timestamp or valid time string or DateTime object.

Returns

string
An RSS-formatted timestamp

See

\Cake\View\Helper\TimeHelper::toRSS

__call()source public

__call( string $method , array $params )

Provide non fatal errors on missing method calls.

Parameters

string $method

Method to invoke

array $params

Array of params for the method.

__debugInfo()source public

__debugInfo( )

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

Returns

array

__get()source public

__get( string $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()source public

__set( string $name , mixed $value )

Magic setter for removed properties.

Parameters

string $name

Property name.

mixed $value

Value to set.

_cleanConfirmMessage()source protected

_cleanConfirmMessage( string $message )

Returns a string read to be used in confirm()

Parameters

string $message

The message to clean

Returns

mixed

_confirm()source protected

_confirm( string $message , string $okCode , string $cancelCode = '' , array $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()source public

addClass( array $options = [] , string|null $class = null , string $key = 'class' )

Adds the given class to the element options

Parameters

array $options optional []

Array options/attributes to add a class to

string|null $class optional null

The class name being added.

string $key optional 'class'

the key to use for class.

Returns

array
Array of options with $key set.

getView()source public

getView( )

Get the view instance this helper is bound to.

Returns

Cake\View\View
The bound view instance.

initialize()source 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.

_configDelete()source protected

_configDelete( string $key )

Deletes a single config key.

Parameters

string $key

Key to delete.

Throws

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

_configRead()source protected

_configRead( string|null $key )

Reads a config key.

Parameters

string|null $key

Key to read.

Returns

mixed

_configWrite()source protected

_configWrite( string|array $key , mixed $value , boolean|string $merge = false )

Writes a config key.

Parameters

string|array $key

Key to write to.

mixed $value

Value to write.

boolean|string $merge optional false

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

config()source public deprecated

config( string|array|null $key = null , mixed|null $value = null , boolean $merge = true )

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 null

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

mixed|null $value optional null

The value to set.

boolean $merge optional true

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()source public

configShallow( string|array $key , mixed|null $value = null )

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 null

The value to set.

Returns

$this

getConfig()source public

getConfig( string|null $key = null , mixed $default = null )

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 null

The key to get or null for the whole config.

mixed $default optional null

The return value when the key does not exist.

Returns

mixed
Config value being read.

setConfig()source public

setConfig( string|array $key , mixed|null $value = null , boolean $merge = true )

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 null

The value to set.

boolean $merge optional true

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.

['Url', 'Time']

[]

'2.0'