Class RssHelper
RSS Helper class for easy output RSS structures.
- AppHelper
-
RssHelper
Link: http://book.cakephp.org/2.0/en/core-libraries/helpers/rss.html
Copyright: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
License: MIT License
Location: Cake/View/Helper/RssHelper.php
Properties summary
-
$actionpublicstringCurrent action. -
$basepublicstringBase URL -
$datapublicarrayPOSTed model data -
$fieldpublicstringName of the current field -
$helperspublicarrayHelpers used by RSS Helper -
$herepublicstringURL to current action. -
$modelpublicstringName of the current model -
$paramspublicarrayParameter array. -
$versionpublicstringDefault spec version of generated RSS
Magic properties summary
-
$Timepublic
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() , array $elements = array() , string $content = null )
Returns an RSS <channel /> element
Parameters
- array $attrib optional array()
<channel />tag attributes- array $elements optional array()
- Named array elements which are converted to tags
- string $content optional null
- Content (
<item />'s belonging to this channel
Returns
An RSS
<channel />Link
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
- Tag content.
Returns
An RSS document
Link
elem() public ¶
elem( string $name , array $attrib = array() , string|array $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
- string|array $content optional null
- XML element content
- boolean $endTag optional true
- Whether the end tag of the element should be printed
Returns
XML
Link
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
An RSS
<item /> elementLink
items() public ¶
items( array $items , string|array $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 $callback optional null
A string function name, or array containing an object and a string method name
Returns
A set of RSS
<item /> elements