RssHelper Class Reference

Inheritance diagram for RssHelper:

XmlHelper AppHelper Helper Helper Overloadable Overloadable Object Object Object Object

List of all members.


Public Member Functions

 channel ($attrib=array(), $elements=array(), $content=null)
 document ($attrib=array(), $content=null)
 item ($att=array(), $elements=array())
 items ($items, $callback=null)
 time ($time)

Public Attributes

 $action = null
 $base = null
 $data = null
 $field = null
 $helpers = array('Time')
 $here = null
 $Html = null
 $model = null
 $params = array()
 $Time = null
 $version = '2.0'

Detailed Description

Definition at line 37 of file rss.php.

Member Function Documentation

RssHelper::channel ( $  attrib = array(),
$  elements = array(),
$  content = null 
)

Returns an RSS <channel> element

Parameters:
array $attrib <channel> tag attributes
mixed $elements Named array elements which are converted to tags
mixed $content Content ('s belonging to this channel
Returns:
string An RSS <channel>

Definition at line 125 of file rss.php.

References $data, XmlHelper::elem(), ClassRegistry::getObject(), and Helper::url().

RssHelper::document ( $  attrib = array(),
$  content = null 
)

Returns an RSS document wrapped in <rss> tags

Parameters:
array $attrib <rss> tag attributes
Returns:
string An RSS document

Definition at line 106 of file rss.php.

References XmlHelper::elem().

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

Converts an array into an element and its contents

Parameters:
array $attrib The attributes of the element
array $elements The list of elements contained in this
Returns:
string An RSS element

Definition at line 179 of file rss.php.

References XmlHelper::elem(), time(), and Helper::url().

Referenced by items().

RssHelper::items ( $  items,
$  callback = null 
)

Transforms an array of data using an optional callback, and maps it to a set of tags

Parameters:
array $items The list of items to be mapped
mixed $callback A string function name, or array containing an object and a string method name
Returns:
string A set of RSS elements

Definition at line 159 of file rss.php.

References $out, and item().

RssHelper::time ( $  time  ) 

Converts a time in any format to an RSS time

Parameters:
mixed $time
Returns:
string An RSS-formatted timestamp
See also:
TimeHelper::toRSS

Definition at line 248 of file rss.php.

Referenced by item().

Member Data Documentation

RssHelper::$action = null

Reimplemented from Helper.

Definition at line 71 of file rss.php.

RssHelper::$base = null

Reimplemented from Helper.

Definition at line 50 of file rss.php.

RssHelper::$data = null

Reimplemented from Helper.

Definition at line 78 of file rss.php.

Referenced by channel().

RssHelper::$field = null

Definition at line 92 of file rss.php.

RssHelper::$helpers = array('Time')

Reimplemented from Helper.

Definition at line 43 of file rss.php.

RssHelper::$here = null

Reimplemented from Helper.

Definition at line 57 of file rss.php.

RssHelper::$Html = null

Definition at line 39 of file rss.php.

RssHelper::$model = null

Definition at line 85 of file rss.php.

RssHelper::$params = array()

Reimplemented from Helper.

Definition at line 64 of file rss.php.

RssHelper::$Time = null

Definition at line 41 of file rss.php.

RssHelper::$version = '2.0'

Definition at line 99 of file rss.php.

The documentation for this class was generated from the following file: