Docs For Class Zend_Feed

Zend_Feed_Element

Description

Implements interfaces:

ArrayAccess (internal interface)

Wraps a DOMElement allowing for SimpleXML-like access to attributes.

copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: New BSD License

Direct descendents

Class	Description
Zend_Feed_Abstract	The Zend_Feed_Abstract class is an abstract class representing feeds.
Zend_Feed_Entry_Abstract	Zend_Feed_Entry_Abstract represents a single entry in an Atom or RSS feed.

Variable Summary

boolean $_appended

DOMElement $_element

string $_encoding

Zend_Feed_Element $_parentElement

Method Summary

void __construct ([DOMElement $element = null])

void ensureAppended ()

DOMDocument getDOM ()

string getEncoding ()

boolean offsetExists (string $offset)

string offsetGet (string $offset)

string offsetSet (string $offset, string $value)

boolean offsetUnset (string $offset)

string saveXml ()

string saveXmlFragment ()

void setDOM ( $element)

Zend_Feed_Element setEncoding (string $value)

void setParent (Zend_Feed_Element $element)

array _children (string $var)

mixed __call (string $var, mixed $unused)

mixed __get (string $var)

boolean __isset (string $var)

void __set (string $var, string $val)

string __toString ()

void __unset (string $var)

Variables

boolean $_appended = true (line 53)

access: protected

DOMElement $_element (line 38)

access: protected

string $_encoding = 'UTF-8' (line 43)

var: Character encoding to utilize
access: protected

Zend_Feed_Element $_parentElement (line 48)

access: protected

Methods

Constructor __construct (line 62)

Zend_Feed_Element constructor.

access: public

void __construct ([DOMElement $element = null])

DOMElement $element: The DOM element we're encapsulating.

Redefined in descendants as:

Zend_Feed_Abstract::__construct() : Feed constructor
Zend_Feed_Entry_Abstract::__construct() : Zend_Feed_Entry_Abstract constructor

ensureAppended (line 116)

Appends this element to its parent if necessary.

access: protected

void ensureAppended ()

getDOM (line 76)

Get a DOM representation of the element

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

access: public

DOMDocument getDOM ()

getEncoding (line 161)

Get encoding

access: public

string getEncoding ()

offsetExists (line 372)

Required by the ArrayAccess interface.

access: public

boolean offsetExists (string $offset)

string $offset

Implementation of:

ArrayAccess::offsetExists

offsetGet (line 389)

Required by the ArrayAccess interface.

access: public

string offsetGet (string $offset)

string $offset

Implementation of:

ArrayAccess::offsetGet

offsetSet (line 407)

Required by the ArrayAccess interface.

access: public

string offsetSet (string $offset, string $value)

string $offset
string $value

Implementation of:

ArrayAccess::offsetSet

offsetUnset (line 427)

Required by the ArrayAccess interface.

access: public

boolean offsetUnset (string $offset)

string $offset

Implementation of:

ArrayAccess::offsetUnset

saveXml (line 134)

Get an XML string representation of this element

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

access: public

string saveXml ()

Redefined in descendants as:

Zend_Feed_Rss::saveXml() : Override Zend_Feed_Element to include <rss> root node
Zend_Feed_Atom::saveXml() : Override Zend_Feed_Element to allow formated feeds

saveXmlFragment (line 151)

Get the XML for only this element

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

access: public

string saveXmlFragment ()

setDOM (line 92)

Update the object from a DOM element

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.

access: public

void setDOM ( $element)

DOMElement $element

setEncoding (line 172)

Set encoding

access: public

Zend_Feed_Element setEncoding (string $value)

string $value: Encoding to use

setParent (line 104)

Set the parent element of this object to another Zend_Feed_Element.

access: public

void setParent (Zend_Feed_Element $element)

Zend_Feed_Element $element

_children (line 342)

Finds children with tagnames matching $var

Similar to SimpleXML's children() method.

access: protected

array _children (string $var)

string $var: Tagname to match, can be either namespace:tagName or just tagName.

__call (line 292)

Get the value of an element with method syntax.

Map method calls to get the string value of the requested element. If there are multiple elements that match, this will return an array of those objects.

return: The node's value, null, or an array of nodes.
access: public

mixed __call (string $var, mixed $unused)

string $var: The element to get the string value of.
mixed $unused: This parameter is not used.

Redefined in descendants as:

Zend_Feed_Entry_Rss::__call() : Overwrites parent::_call method to enable read access to content:encoded element.

__get (line 188)

Map variable access onto the underlying entry representation.

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

access: public

mixed __get (string $var)

string $var: The property to access.

Redefined in descendants as:

Zend_Feed_Rss::__get() : Make accessing some individual elements of the channel easier.
Zend_Feed_Atom::__get() : Make accessing some individual elements of the feed easier.
Zend_Feed_Entry_Rss::__get() : Overwrites parent::_get method to enable read access to content:encoded element.

__isset (line 259)

Map isset calls onto the underlying entry representation.

access: public

boolean __isset (string $var)

string $var

Redefined in descendants as:

Zend_Feed_Entry_Rss::__isset() : Overwrites parent::_isset method to enable access to content:encoded element.

__set (line 225)

Map variable sets onto the underlying entry representation.

throws: Zend_Feed_Exception
access: public

void __set (string $var, string $val)

string $var: The property to change.
string $val: The property's new value.

Redefined in descendants as:

Zend_Feed_Entry_Rss::__set() : Overwrites parent::_set method to enable write access to content:encoded element.

__toString (line 328)

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

access: public

string __toString ()

__unset (line 312)

Remove all children matching $var.

access: public

void __unset (string $var)

string $var

Documentation generated on Mon, 21 Jun 2010 15:18:50 -0400 by phpDocumentor 1.4.3