Class RssHelper

RSS Helper class for easy output RSS structures.

Cake\View\Helper implements Cake\Event\EventListenerInterface uses Cake\Core\InstanceConfigTrait
Extended by Cake\View\Helper\RssHelper

Method Detail

channelsource public

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 />

documentsource public

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

elemsource public

elem( string $name , array $attrib [] , string|array $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 $content optional null
XML element content
boolean $endTag optional true
Whether the end tag of the element should be printed

Returns

string
XML

implementedEventssource public

implementedEvents( )

Event listeners.

Returns

array
array

Overrides

Cake\View\Helper::implementedEvents()

itemsource public

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

itemssource public

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

timesource public

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

TimeHelper::toRSS

Methods inherited from Cake\View\Helper

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

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

__debugInfosource public

__debugInfo( )

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

Returns

array
array

__getsource 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

_confirmsource 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

addClasssource public

addClass( array $options [] , string $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 $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.

Methods used from Cake\Core\InstanceConfigTrait

_configDeletesource protected

_configDelete( string $key )

Delete a single config key

Parameters

string $key
Key to delete.

Throws

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

_configReadsource protected

_configRead( string|null $key )

Read a config variable

Parameters

string|null $key
Key to read.

Returns

mixed
mixed

_configWritesource protected

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

Write a config variable

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

configsource public

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

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.

configShallowsource 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->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 $key
The key to set, or a complete array of configs.
mixed|null $value optional null
The value to set.

Returns

mixed
$this The object itself.

Properties summary

$actionsource

public string

Current action.

null

$basesource

public string

Base URL

null

$datasource

public array

POSTed model data

null

$fieldsource

public string

Name of the current field

null

$helperssource

public array

Helpers used by RSS Helper

['Url', 'Time']

$heresource

public string

URL to current action.

null

$modelsource

public string

Name of the current model

null

$paramssource

public array

Parameter array.

[]

$versionsource

public string

Default spec version of generated RSS

'2.0'

Properties inherited from Cake\View\Helper

$_Viewsource

protected Cake\View\View

The View instance this helper is attached to

$_defaultConfigsource

protected array

Default config for this helper.

[]

$_helperMapsource

protected array

A helper lookup table used to lazy load helper objects.

[]

$fieldsetsource

public array

Holds the fields ['field_name' => ['type' => 'string', 'length' => 100]], primaryKey and validates ['field_name']

[]

$pluginsource

public string

Plugin path

null

$requestsource

public Cake\Network\Request

Request object

null

$tagssource

public array

Holds tag templates.

[]

$themesource

public string

The current theme name if any.

null

Properties used from Cake\Core\InstanceConfigTrait

$_configsource

protected array

Runtime config

[]

$_configInitializedsource

protected boolean

Whether the config property has already been configured with defaults

false

Magic properties summary

© 2005–2016 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.
http://api.cakephp.org/3.1/class-Cake.View.Helper.RssHelper.html