Class RssHelper

RSS Helper class for easy output RSS structures.

Object

Helper

AppHelper

RssHelper

Package: Cake\View\Helper
Link: http://book.cakephp.org/2.0/en/core-libraries/helpers/rss.html
Copyright: Copyright 2005-2011, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: License (http://www.opensource.org/licenses/mit-license.php)
Location: Cake/View/Helper/RssHelper.php

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

TimeHelper

Inherited Properties

_View, _association, _cleaned, _entityPath, _fieldSuffixes, _helperMap, _modelScope, _tainted, fieldset, plugin, request, tags, theme

Method Summary

channel() public

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

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

Generates an XML element
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

channel() public ¶

channel( array $attrib = array() , mixed $elements = array() , mixed $content = null )

Returns an RSS <channel /> element

Parameters

array $attrib optional array(): <channel /> tag attributes
mixed $elements optional array(): Named array elements which are converted to tags
mixed $content optional null: Content (<item />'s belonging to this channel

Returns

string
An RSS <channel />

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/rss.html#RssHelper::channel

document() public ¶

document( array $attrib = array() , string $content = null )

Returns an RSS document wrapped in <rss /> tags

Parameters

array $attrib optional array(): <rss /> tag attributes
string $content optional null

Returns

string
An RSS document

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/rss.html#RssHelper::document

elem() public ¶

elem( string $name , array $attrib = array() , mixed $content = null , boolean $endTag = true )

Generates an XML element

Parameters

string $name: The name of the XML element
array $attrib optional array(): The attributes of the XML element
mixed $content optional null: XML element content
boolean $endTag optional true: Whether the end tag of the element should be printed

Returns

string
XML

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/rss.html#RssHelper::elem

item() public ¶

item( array $att = array() , array $elements = array() )

Converts an array into an <item /> element and its contents

Parameters

array $att optional array(): The attributes of the <item /> element
array $elements optional array(): The list of elements contained in this <item />

Returns

string
An RSS <item /> element

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/rss.html#RssHelper::item

items() public ¶

items( array $items , mixed $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
mixed $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

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/rss.html#RssHelper::items

time() public ¶

time( mixed $time )

Converts a time in any format to an RSS time

Parameters

mixed $time

Returns

string
An RSS-formatted timestamp

See

TimeHelper::toRSS

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/rss.html#RssHelper::time

Methods inherited from 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.

__construct() public ¶

__construct( View $View , array $settings = array() )

Default Constructor

Parameters

View $View: The View this helper is being attached to.
array $settings optional array(): Configuration settings for the helper.

Overrides

Object::__construct()

__get() public ¶

__get( string $name )

Lazy loads helpers. Provides access to deprecated request properties as well.

Parameters

string $name: Name of the property being accessed.

Returns

mixed
Helper or property found at $name

__set() public ¶

__set( string $name , mixed $value )

Provides backwards compatibility access for setting values to the request object.

Parameters

string $name: Name of the property being accessed.
mixed $value

Returns

mixed
Return the $value

_clean() protected ¶

_clean( )

Removes harmful content from output

_formatAttribute() protected deprecated ¶

_formatAttribute( string $key , string $value , boolean $escape = true )

Formats an individual attribute, and returns the string value of the composed attribute. Works with minimized attributes that have the same value as their name such as 'disabled' and 'checked'

Deprecated

This method will be moved to HtmlHelper in 3.0

Parameters

string $key: The name of the attribute to create
string $value: The value of the attribute to create.
boolean $escape optional true: Define if the value must be escaped

Returns

string
The composed attribute.

_initInputField() protected ¶

_initInputField( string $field , array $options = array() )

Sets the defaults for an input tag. Will set the name, value, and id attributes for an array of html attributes. Will also add a 'form-error' class if the field contains validation errors.

Parameters

string $field: The field name to initialize.
array $options optional array(): Array of options to use while initializing an input field.

Returns

array
Array options for the form input.

_name() protected ¶

_name( mixed $options = array() , string $field = null , string $key = 'name' )

Gets the input field name for the current tag. Creates input name attributes using CakePHP's data[Model][field] formatting.

Parameters

mixed $options optional array(): If an array, should be an array of attributes that $key needs to be added to. If a string or null, will be used as the View entity.
string $field optional null
string $key optional 'name': The name of the attribute to be set, defaults to 'name'

Returns

mixed

If an array was given for $options, an array with $key set will be returned. If a string was supplied a string will be returned.

_parseAttributes() protected deprecated ¶

_parseAttributes( array $options , array $exclude = null , string $insertBefore = ' ' , string $insertAfter = null )

Returns a space-delimited string with items of the $options array. If a key of $options array happens to be one of:

'compact'
'checked'
'declare'
'readonly'
'disabled'
'selected'
'defer'
'ismap'
'nohref'
'noshade'
'nowrap'
'multiple'
'noresize'

And its value is one of:

'1' (string)
1 (integer)
true (boolean)
'true' (string)

Then the value will be reset to be identical with key's name. If the value is not one of these 3, the parameter is not output.

'escape' is a special option in that it controls the conversion of attributes to their html-entity encoded equivalents. Set to false to disable html-encoding.

If value for any option key is set to null or false, that option will be excluded from output.

Deprecated

This method will be moved to HtmlHelper in 3.0

Parameters

array $options: Array of options.
array $exclude optional null: Array of options to be excluded, the options here will not be part of the return.
string $insertBefore optional ' ': String to be inserted before options.
string $insertAfter optional null: String to be inserted after options.

Returns

string
Composed attributes.

_reset() protected ¶

_reset( )

Resets the vars used by Helper::clean() to null

_selectedArray() protected ¶

_selectedArray( mixed $data , string $key = 'id' )

Transforms a recordset from a hasAndBelongsToMany association to a list of selected options for a multiple select element

Parameters

mixed $data
string $key optional 'id'

Returns

array

addClass() public ¶

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

Adds the given class to the element options

Parameters

array $options optional array(): Array options/attributes to add a class to
string $class optional null: The classname being added.
string $key optional 'class': the key to use for class.

Returns

array
Array of options with $key set.

afterLayout() public ¶

afterLayout( string $layoutFile )

After layout callback. afterLayout is called after the layout has rendered.

Overridden in subclasses.

Parameters

string $layoutFile: The layout file that was rendered.

afterRender() public ¶

afterRender( string $viewFile )

After render callback. afterRender is called after the view file is rendered but before the layout has been rendered.

Overridden in subclasses.

Parameters

string $viewFile: The view file that was rendered.

assetTimestamp() public ¶

assetTimestamp( string $path )

Adds a timestamp to a file based resource based on the value of Asset.timestamp in Configure. If Asset.timestamp is true and debug > 0, or Asset.timestamp == 'force' a timestamp will be added.

Parameters

string $path: The file path to timestamp, the path must be inside WWW_ROOT

Returns

string
Path with a timestamp added, or not.

beforeLayout() public ¶

beforeLayout( string $layoutFile )

Before layout callback. beforeLayout is called before the layout is rendered.

Overridden in subclasses.

Parameters

string $layoutFile: The layout about to be rendered.

beforeRender() public ¶

beforeRender( string $viewFile )

Before render callback. beforeRender is called before the view file is rendered.

Overridden in subclasses.

Parameters

string $viewFile: The view file that is going to be rendered

Used to remove harmful tags from content. Removes a number of well known XSS attacks from content. However, is not guaranteed to remove all possibilities. Escaping content is the best way to prevent all possible attacks.

Parameters

mixed $output: Either an array of strings to clean or a single string to clean.

Returns

string|array
cleaned content for output

domId() public ¶

domId( mixed $options = null , string $id = 'id' )

Generates a DOM ID for the selected element, if one is not set. Uses the current View::entity() settings to generate a CamelCased id attribute.

Parameters

mixed $options optional null: Either an array of html attributes to add $id into, or a string with a view entity path to get a domId for.
string $id optional 'id': The name of the 'id' attribute.

Returns

mixed

If $options was an array, an array will be returned with $id set. If a string was supplied, a string will be returned.

entity() public ¶

entity( )

Returns the entity reference of the current context as an array of identity parts

Returns

array
An array containing the identity elements of an entity

field() public ¶

field( )

Gets the currently-used model field of the rendering context. Strips off field suffixes such as year, month, day, hour, min, meridian when the current entity is longer than 2 elements.

Returns

string

model() public ¶

model( )

Gets the currently-used model of the rendering context.

Returns

string

output() public deprecated ¶

output( string $str )

Returns a string generated by a helper method

This method can be overridden in subclasses to do generalized output post-processing

Deprecated

This method will be removed in future versions.

Parameters

string $str: String to be output.

Returns

string

setEntity() public ¶

setEntity( mixed $entity , boolean $setScope = false )

Sets this helper's model and field properties to the dot-separated value-pair in $entity.

Parameters

mixed $entity: A field name, like "ModelName.fieldName" or "ModelName.ID.fieldName"
boolean $setScope optional false: Sets the view scope to the model specified in $tagValue

url() public ¶

url( mixed $url = null , boolean $full = false )

Finds URL for specified action.

Returns a URL pointing at the provided parameters.

Parameters

mixed $url optional null: Either a relative string url like /products/view/23 or an array of url parameters. Using an array for urls will allow you to leverage the reverse routing features of CakePHP.
boolean $full optional false: If true, the full base URL will be prepended to the result

Returns

string
Full translated URL with base path.

Link

http://book.cakephp.org/2.0/en/views/helpers.html

value() public ¶

value( mixed $options = array() , string $field = null , string $key = 'value' )

Gets the data for the current tag

Parameters

mixed $options optional array(): If an array, should be an array of attributes that $key needs to be added to. If a string or null, will be used as the View entity.
string $field optional null
string $key optional 'value': The name of the attribute to be set, defaults to 'value'

Returns

mixed

If an array was given for $options, an array with $key set will be returned. If a string was supplied a string will be returned.

webroot() public ¶

webroot( string $file )

Checks if a file exists when theme is used, if no file is found default location is returned

Parameters

string $file: The file to create a webroot path to.

Returns

string
Web accessible path to file.

Methods inherited from Object

_mergeVars() protected ¶

_mergeVars( array $properties , string $class , boolean $normalize = true )

Merges this objects $property with the property in $class' definition. This classes value for the property will be merged on top of $class'

This provides some of the DRY magic CakePHP provides. If you want to shut it off, redefine this method as an empty function.

Parameters

array $properties: The name of the properties to merge.
string $class: The class to merge the property with.
boolean $normalize optional true: Set to true to run the properties through Set::normalize() before merging.

_set() protected ¶

_set( array $properties = array() )

Allows setting of multiple properties of the object in a single line of code. Will only set properties that are part of a class declaration.

Parameters

array $properties optional array(): An associative array containing properties and corresponding values.

_stop() protected ¶

_stop( integer|string $status = 0 )

Stop execution of the current script. Wraps exit() making testing easier.

Parameters

integer|string $status optional 0: see http://php.net/exit for values

dispatchMethod() public ¶

dispatchMethod( string $method , array $params = array() )

Calls a method on this object with the given parameters. Provides an OO wrapper for call_user_func_array

Parameters

string $method: Name of the method to call
array $params optional array(): Parameter list to use when calling $method

Returns

mixed
Returns the result of the method call

log() public ¶

log( string $msg , integer $type = LOG_ERROR )

Convenience method to write a message to CakeLog. See CakeLog::write() for more information on writing to logs.

Parameters

string $msg: Log message
integer $type optional LOG_ERROR: Error type constant. Defined in app/Config/core.php.

Returns

boolean
Success of log write

requestAction() public ¶

requestAction( mixed $url , array $extra = array() )

Calls a controller's method from any location. Can be used to connect controllers together or tie plugins into a main application. requestAction can be used to return rendered views or fetch the return value from controller actions.

Under the hood this method uses Router::reverse() to convert the $url parameter into a string URL. You should use URL formats that are compatible with Router::reverse()

Passing POST and GET data

POST and GET data can be simulated in requestAction. Use $extra['url'] for GET data. The $extra['data'] parameter allows POST data simulation.

Parameters

mixed $url: String or array-based url. Unlike other url arrays in CakePHP, this url will not automatically handle passed and named arguments in the $url parameter.
array $extra optional array(): if array includes the key "return" it sets the AutoRender to true. Can also be used to submit GET/POST data, and named/passed arguments.

Returns

mixed

Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.

toString() public ¶

toString( )

Object-to-string conversion. Each class can override this method as necessary.

Returns

string
The name of this class

Properties detail

`$action` ¶

public string

Current action.

null

`$base` ¶

public string

Base URL

null

`$data` ¶

public array

POSTed model data

null

`$field` ¶

public string

Name of the current field

null

`$helpers` ¶

public array

Helpers used by RSS Helper

array('Time')

`$here` ¶

public string

URL to current action.

null

`$model` ¶

public string

Name of the current model

null

`$params` ¶

public array

Parameter array.

array()

`$version` ¶

public string

Default spec version of generated RSS

'2.0'

Magic properties detail

`$Time` ¶

public TimeHelper

Packages

Classes

Class RssHelper

Properties summary

Magic properties summary

Inherited Properties

Method Summary

channel() public

document() public

elem() public

item() public

items() public

time() public

Method Detail

channel() public ¶

Parameters

Returns

Link

document() public ¶

Parameters

Returns

Link

elem() public ¶

Parameters

Returns

Link

item() public ¶

Parameters

Returns

Link

items() public ¶

Parameters

Returns

Link

time() public ¶

Parameters

Returns

See

Link

Methods inherited from Helper

__call() public ¶

Parameters

__construct() public ¶

Parameters

Overrides

__get() public ¶

Parameters

Returns

__set() public ¶

Parameters

Returns

_clean() protected ¶

_formatAttribute() protected deprecated ¶

Deprecated

Parameters

Returns

_initInputField() protected ¶

Parameters

Returns

_name() protected ¶

Parameters

Returns

_parseAttributes() protected deprecated ¶

Deprecated

Parameters

Returns

_reset() protected ¶

_selectedArray() protected ¶

Parameters

Returns

addClass() public ¶

Parameters

Returns

afterLayout() public ¶

Parameters

afterRender() public ¶

Parameters

assetTimestamp() public ¶

Parameters

Returns