Docs4dev
Docs
cakephp / 2.10 / class-rsshelper.html

Class RssHelper

RSS Helper class for easy output RSS structures.

AppHelper
Extended by RssHelper
Package: Cake\View\Helper
Link: https://book.cakephp.org/2.0/en/core-libraries/helpers/rss.html
Copyright: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
License: MIT License
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

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()source 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

string
An RSS <channel />

Link

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

document()source 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

string
An RSS document

Link

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

elem()source 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

string
XML

Link

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

item()source 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

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

items()source 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

string
A set of RSS <item /> elements

Link

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

time()source public

time( integer|string|DateTime $time )

Converts a time in any format to an RSS time

Parameters

integer|string|DateTime $time
UNIX timestamp or valid time string or DateTime object.

Returns

string
An RSS-formatted timestamp

See

TimeHelper::toRSS

Link

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

Properties detail

$actionsource

public string

Current action.

null

$basesource

public string

Base URL

null

$datasource

public array

POSTed model data

null

$fieldsource

public string

Name of the current field

null

$helperssource

public array

Helpers used by RSS Helper

array('Time')

$heresource

public string

URL to current action.

null

$modelsource

public string

Name of the current model

null

$paramssource

public array

Parameter array.

array()

$versionsource

public string

Default spec version of generated RSS

'2.0'

Magic properties detail

$Timesource

public TimeHelper

© 2005–2017 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/2.10/class-RssHelper.html