Class RssHelper
RSS Helper class for easy output RSS structures.
Property Summary
-
$Time public @property
TimeHelper -
$Url public @property
UrlHelper -
$_View protected
Cake\View\ViewThe View instance this helper is attached to
-
$_config protected
arrayRuntime config
-
$_configInitialized protected
boolWhether the config property has already been configured with defaults
-
$_defaultConfig protected
arrayDefault config for this helper.
-
$_helperMap protected
arrayA helper lookup table used to lazy load helper objects.
-
$action public
stringCurrent action.
-
$base public
stringBase URL
-
$data public
arrayPOSTed model data
-
$field public
stringName of the current field
-
$fieldset public
arrayHolds the fields ['field_name' => ['type' => 'string', 'length' => 100]], primaryKey and validates ['field_name']
-
$helpers public
arrayHelpers used by RSS Helper
-
$here public
stringURL to current action.
-
$model public
stringName of the current model
-
$params public
arrayParameter array.
-
$plugin public
stringPlugin path
-
$request public
Cake\Network\RequestRequest object
-
$tags public
arrayHolds tag templates.
-
$theme public
stringThe current theme name if any.
-
$version public
stringDefault 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
Delete a single config key
-
_configRead() protected
Read a config variable
-
_configWrite() protected
Write a config variable
-
_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
Usage
-
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
-
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 -
time() public
Converts a time in any format to an RSS time
Method Detail
__call() ¶ public
__call(string $method, array $params): voidProvide 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(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(): arrayReturns an array that can be used to describe the internal state of this object.
Returns
array__get() ¶ public
__get(string $name): Cake\View\Helper|nullLazy loads helpers.
Parameters
-
string$name Name of the property being accessed.
Returns
Cake\View\Helper|nullHelper instance if helper with provided name exists
_configDelete() ¶ protected
_configDelete(string $key): voidDelete a single config key
Parameters
-
string$key Key to delete.
Returns
voidThrows
Cake\Core\Exception\Exceptionif attempting to clobber existing config
_configRead() ¶ protected
_configRead(string|null $key): mixedRead a config variable
Parameters
-
string|null$key Key to read.
Returns
mixed_configWrite() ¶ protected
_configWrite(string|array $key, mixed $value, bool|string $merge = false): voidWrite a config variable
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
voidThrows
Cake\Core\Exception\Exceptionif attempting to clobber existing config
_confirm() ¶ protected
_confirm(string $message, string $okCode, string $cancelCode = '', array $options = []): stringReturns 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
stringonclick JS code
addClass() ¶ public
addClass(array $options = [], string|null $class = null, string $key = 'class'): arrayAdds 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
arrayArray of options with $key set.
channel() ¶ public
channel(array $attrib = [], array $elements = [], string|null $content = null): stringReturns 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
stringAn RSS <channel />
config() ¶ public
config(string|array|null $key = null, mixed|null $value = null, bool $merge = true): mixedUsage
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
mixedConfig value being read, or the object itself on write operations.
Throws
Cake\Core\Exception\ExceptionWhen trying to set a key that is invalid.
configShallow() ¶ public
configShallow(string|array $key, mixed|null $value = null): $thisMerge 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 The value to set.
Returns
$thisThe object itself.
document() ¶ public
document(array $attrib = [], string|null $content = null): stringReturns an RSS document wrapped in <rss /> tags
Parameters
-
array$attrib optional <rss />tag attributes-
string|null$content optional Tag content.
Returns
stringAn RSS document
elem() ¶ public
elem(string $name, array $attrib = [], string|array|null $content = null, bool $endTag = true): stringGenerates 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
stringXML
implementedEvents() ¶ public
implementedEvents(): arrayEvent 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
arrayinitialize() ¶ public
initialize(array $config): voidConstructor 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
voiditem() ¶ public
item(array $att = [], array $elements = []): stringConverts 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
stringAn RSS <item /> element
items() ¶ public
items(array $items, string|array|null $callback = null): stringTransforms 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
stringA set of RSS <item /> elements
time() ¶ public
time(int|string|DateTime $time): stringConverts a time in any format to an RSS time
Parameters
-
int|string|DateTime$time UNIX timestamp or valid time string or DateTime object.
Returns
stringAn RSS-formatted timestamp