API Documentation

Feed/Entry/Rss.php

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Feed  
version
$Id: Rss.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Feed_Entry_Rss

Concrete class for working with RSS items.

Extends from
\Zend_Feed_Entry_Abstract
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Feed  

Properties

Propertyprotectedstring  $_rootElement= 'item'

Root XML element for RSS items.

Default valueitemDetails
Type
string

Methods

methodpublic__call( string $var, mixed $unused ) : mixed

Overwrites parent::_call method to enable read access to content:encoded element.

Please note that method-style write access is not currently supported by parent method, consequently this method doesn't as well.

Parameters
Name Type Description
$var string The element to get the string value of.
$unused mixed This parameter is not used.
Returns
Type Description
mixed The node's value, null, or an array of nodes.
methodpublic__construct( string $uri = null, \SimpleXMLElement|\DOMNode|string $element = null ) : void

Zend_Feed_Entry_Abstract constructor

Inherited from: \Zend_Feed_Entry_Abstract::__construct()

The Zend_Feed_Entry_Abstract constructor takes the URI of the feed the entry is part of, and optionally an XML construct (usually a SimpleXMLElement, but it can be an XML string or a DOMNode as well) that contains the contents of the entry.

Parameters
Name Type Description
$uri string
$element \SimpleXMLElement|\DOMNode|string
Throws
Exception Description
\Zend_Feed_Exception
methodpublic__get( string $var ) : mixed

Overwrites parent::_get method to enable read access to content:encoded element.

Get-style access returns a Zend_Feed_Element representing the child element accessed. To get string values, use method syntax with the __call() overriding.

Parameters
Name Type Description
$var string The property to access.
Returns
Type Description
mixed
methodpublic__isset( string $var ) : boolean

Overwrites parent::_isset method to enable access to content:encoded element.

Parameters
Name Type Description
$var string
Returns
Type Description
boolean
methodpublic__set( string $var,  $value ) : void

Overwrites parent::_set method to enable write access to content:encoded element.

Parameters
Name Type Description
$var string The property to change.
$value
Throws
Exception Description
\Zend_Feed_Exception
methodpublic__toString( ) : string

Returns the nodeValue of this element when this object is used in a string context.

Inherited from: \Zend_Feed_Element::__toString()
Returns
Type Description
string
methodpublic__unset( string $var ) : void

Remove all children matching $var.

Inherited from: \Zend_Feed_Element::__unset()
Parameters
Name Type Description
$var string
methodprotected_children( string $var ) : array

Finds children with tagnames matching $var

Inherited from: \Zend_Feed_Element::_children()

Similar to SimpleXML's children() method.

Parameters
Name Type Description
$var string Tagname to match, can be either namespace:tagName or just tagName.
Returns
Type Description
array
methodprotectedensureAppended( ) : void

Appends this element to its parent if necessary.

Inherited from: \Zend_Feed_Element::ensureAppended()
methodpublicgetDOM( ) : \DOMDocument

Get a DOM representation of the element

Inherited from: \Zend_Feed_Element::getDOM()

Returns the underlying DOM object, which can then be manipulated with full DOM methods.

Returns
Type Description
\DOMDocument
methodpublicgetEncoding( ) : string

Get encoding

Inherited from: \Zend_Feed_Element::getEncoding()
Returns
Type Description
string
methodpublicoffsetExists( string $offset ) : boolean

Required by the ArrayAccess interface.

Inherited from: \Zend_Feed_Element::offsetExists()
Parameters
Name Type Description
$offset string
Returns
Type Description
boolean
methodpublicoffsetGet( string $offset ) : string

Required by the ArrayAccess interface.

Inherited from: \Zend_Feed_Element::offsetGet()
Parameters
Name Type Description
$offset string
Returns
Type Description
string
methodpublicoffsetSet( string $offset, string $value ) : string

Required by the ArrayAccess interface.

Inherited from: \Zend_Feed_Element::offsetSet()
Parameters
Name Type Description
$offset string
$value string
Returns
Type Description
string
methodpublicoffsetUnset( string $offset ) : boolean

Required by the ArrayAccess interface.

Inherited from: \Zend_Feed_Element::offsetUnset()
Parameters
Name Type Description
$offset string
Returns
Type Description
boolean
methodpublicsaveXml( ) : string

Get an XML string representation of this element

Inherited from: \Zend_Feed_Element::saveXml()

Returns a string of this element's XML, including the XML prologue.

Returns
Type Description
string
methodpublicsaveXmlFragment( ) : string

Get the XML for only this element

Inherited from: \Zend_Feed_Element::saveXmlFragment()

Returns a string of this element's XML without prologue.

Returns
Type Description
string
methodpublicsetDOM( \DOMElement $element ) : void

Update the object from a DOM element

Inherited from: \Zend_Feed_Element::setDOM()

Take a DOMElement object, which may be originally from a call to getDOM() or may be custom created, and use it as the DOM tree for this Zend_Feed_Element.

Parameters
Name Type Description
$element \DOMElement
methodpublicsetEncoding( string $value ) : \Zend_Feed_Element

Set encoding

Inherited from: \Zend_Feed_Element::setEncoding()
Parameters
Name Type Description
$value string Encoding to use
Returns
Type Description
\Zend_Feed_Element
methodpublicsetParent( \Zend_Feed_Element $element ) : void

Set the parent element of this object to another Zend_Feed_Element.

Inherited from: \Zend_Feed_Element::setParent()
Parameters
Name Type Description
$element \Zend_Feed_Element
Documentation was generated by DocBlox 0.13.3.