Deprecated Class Cake\View\Helper\RssHelper

Properties summary

$action public

string

Current action.
$base public

string

Base URL
$data public

array

POSTed model data
$field public

string

Name of the current field
$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.
$version public

string

Default spec version of generated RSS

Magic properties summary

$Time public

Cake\View\Helper\TimeHelper
$Url public

Cake\View\Helper\UrlHelper

Inherited Properties

_View, _defaultConfig, _helperMap, fieldset, tags _config, _configInitialized

Method Summary

__construct() public

Default Constructor
channel() public

Returns an RSS <channel /> element
document() public

Returns an RSS document wrapped in <rss /> tags
elem() public

Generates an XML element
implementedEvents() public

Event listeners.
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
time() public

Converts a time in any format to an RSS time

Method Detail

__construct() public ¶

__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() 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 />

document() 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

elem() public ¶

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

implementedEvents( )

Event listeners.

Returns

array

Overrides

Cake\View\Helper::implementedEvents()

item() 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

items() 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

time() 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

\Cake\View\Helper\TimeHelper::toRSS

Methods inherited from Cake\View\Helper

__call() 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() public ¶

__debugInfo( )

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

Returns

array

__get() 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() public ¶

__set( string $name , mixed $value )

Magic setter for removed properties.

Parameters

string $name: Property name.
mixed $value: Value to set.

_cleanConfirmMessage() protected ¶

_cleanConfirmMessage( string $message )

Returns a string read to be used in confirm()

Parameters

string $message: The message to clean

Returns

mixed

_confirm() 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() 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() public ¶

getView( )

Get the view instance this helper is bound to.

Returns

Cake\View\View
The bound view instance.

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.

Methods used from Cake\Core\InstanceConfigTrait

_configDelete() 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() protected ¶

_configRead( string|null $key )

Reads a config key.

Parameters

string|null $key: Key to read.

Returns

mixed

_configWrite() 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() public ¶

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

Properties detail

`$action` ¶

public string

Current action.

`$base` ¶

public string

Base URL

`$data` ¶

public array

POSTed model data

`$field` ¶

public string

Name of the current field

`$helpers` ¶

public array

Helpers used by RSS Helper

['Url', 'Time']

`$here` ¶

public string

URL to current action.

`$model` ¶

public string

Name of the current model

`$params` ¶

public array

Parameter array.

[]

`$version` ¶

public string

Default spec version of generated RSS

'2.0'

Magic properties detail

`$Time` ¶

public Cake\View\Helper\TimeHelper

`$Url` ¶

public Cake\View\Helper\UrlHelper

Namespaces

Classes

Traits

Class RssHelper

Properties summary

Magic properties summary

Inherited Properties

Method Summary

__construct() public

channel() public

document() public

elem() public

implementedEvents() public

item() public

items() public

time() public

Method Detail

__construct() public ¶

Parameters

Overrides

channel() public ¶

Parameters

Returns

document() public ¶

Parameters

Returns

elem() public ¶

Parameters

Returns

implementedEvents() public ¶

Returns

Overrides

item() public ¶

Parameters

Returns

items() public ¶

Parameters

Returns

time() public ¶

Parameters

Returns

See

Methods inherited from Cake\View\Helper

__call() public ¶

Parameters

__debugInfo() public ¶

Returns

__get() public ¶

Parameters

Returns

__set() public ¶

Parameters

_cleanConfirmMessage() protected ¶

Parameters

Returns

_confirm() protected ¶

Parameters

Returns

addClass() public ¶

Parameters

Returns

getView() public ¶

Returns

initialize() public ¶

Parameters

Methods used from Cake\Core\InstanceConfigTrait

_configDelete() protected ¶

Parameters

Throws

_configRead() protected ¶

Parameters

Returns

_configWrite() protected ¶

Parameters

Throws

config() public ¶

Usage

Parameters

Returns

Throws