Class
RssHelper
RSS Helper class for easy output RSS structures.
Deprecated: 3.5.0 RssHelper is deprecated and will be removed in 4.0.0
Link: https://book.cakephp.org/3.0/en/views/helpers/rss.html
Property Summary
-
$Time public @property
Cake\View\Helper\TimeHelper
-
$Url public @property
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
Holds the fields ['field_name' => ['type' => 'string', 'length' => 100]], primaryKey and validates ['field_name']
-
$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.
-
$plugin public
string
Plugin path
-
$request public
Cake\Http\ServerRequest
Request object
-
$tags public
array
Holds tag templates.
-
$theme public
string
The current theme name if any.
-
$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.
-
_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 deprecated
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.
-
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(string $method, array $params): void
Provide non fatal errors on missing method calls.
Parameters
-
string
$method Method to invoke
-
array
$params Array of params for the method.
Returns
void
__construct() ¶ public
__construct(View $view, array $settings = [])
Default Constructor
Parameters
-
View
$view -
array
$settings optional
__debugInfo() ¶ public
__debugInfo(): array
Returns an array that can be used to describe the internal state of this object.
Returns
array
__get() ¶ public
__get(string $name): Cake\View\Helper|null
Lazy loads helpers.
Parameters
-
string
$name Name of the property being accessed.
Returns
Cake\View\Helper|null
_configDelete() ¶ protected
_configDelete(string $key): void
Deletes a single config key.
Parameters
-
string
$key Key to delete.
Returns
void
Throws
Cake\Core\Exception\Exception
if attempting to clobber existing config
_configRead() ¶ protected
_configRead(string|null $key): mixed
Reads a config key.
Parameters
-
string|null
$key Key to read.
Returns
mixed
_configWrite() ¶ protected
_configWrite(string|array $key, mixed $value, bool|string $merge = false): void
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.
Returns
void
Throws
Cake\Core\Exception\Exception
if attempting to clobber existing config
_confirm() ¶ protected
_confirm(string $message, string $okCode, string $cancelCode = '', array $options = []): string
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
addClass() ¶ public
addClass(array $options = [], string|null $class = null, string $key = 'class'): array
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.
Returns
array
channel() ¶ public
channel(array $attrib = [], array $elements = [], string|null $content = null): string
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
config() ¶ public
config(string|array|null $key = null, mixed|null $value = null, bool $merge = true): mixed
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
Throws
Cake\Core\Exception\Exception
When trying to set a key that is invalid.
configShallow() ¶ public
configShallow(string|array $key, mixed|null $value = null): $this
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(array $attrib = [], string|null $content = null): string
Returns an RSS document wrapped in <rss />
tags
Parameters
-
array
$attrib optional <rss />
tag attributes-
string|null
$content optional Tag content.
Returns
string
elem() ¶ public
elem(string $name, array $attrib = [], string|array|null $content = null, bool $endTag = true): string
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
getConfig() ¶ public
getConfig(string|null $key = null, mixed $default = null): mixed
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
$default optional The return value when the key does not exist.
Returns
mixed
getView() ¶ public
getView(): Cake\View\View
Get the view instance this helper is bound to.
Returns
Cake\View\View
implementedEvents() ¶ public
implementedEvents(): array
Event listeners.
By defining one of the callback methods a helper is assumed to be interested in the related event.
Override this method if you need to add non-conventional event listeners. Or if you want helpers to listen to non-standard events.
Returns
array
initialize() ¶ public
initialize(array $config): void
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.
Returns
void
item() ¶ public
item(array $att = [], array $elements = []): string
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
items() ¶ public
items(array $items, string|array|null $callback = null): string
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
setConfig() ¶ public
setConfig(string|array $key, mixed|null $value = null, bool $merge = true): $this
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(int|string|DateTime $time): string
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