Docs For Class Zend_Feed_Element

## Class Zend_Feed_Element

Description

Implements interfaces:

- ArrayAccess (internal interface)

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

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

Located in /Zend/Feed/Element.php (line 30)

Direct descendents

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

Variable Summary
boolean $_appended
DOMElement $_element
Zend_Feed_Element $_parentElement
Method Summary
Zend_Feed_Element __construct ([DOMElement $element = null])
void ensureAppended ()
DOMDocument getDOM ()
void offsetExists ( $offset)
void offsetGet ( $offset)
void offsetSet ( $offset, $value)
void offsetUnset ( $offset)
string saveXML ()
string saveXMLFragment ()
void setDOM ( $element)
void setParent (Zend_Feed_Element $element)
array _children (mixed $var)
mixed __call (string $var, $unused)
mixed __get (string $var)
void __isset ( $var)
void __set (string $var, string $val)
void __toString ()
void __unset ( $var)
Variables
boolean $_appended = true (line 46)

- access: protected

DOMElement $_element (line 36)

- access: protected

Zend_Feed_Element $_parentElement (line 41)

- access: protected

Methods
Constructor __construct (line 54)

Zend_Feed_Element constructor.

- access: public

Zend_Feed_Element __construct ([DOMElement $element = null])

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

Redefined in descendants as:

- Zend_Feed_EntryAbstract::__construct() : Zend_Feed_EntryAbstract constructor
- Zend_Feed_Abstract::__construct() : Feed constructor

ensureAppended (line 107)

Appends this element to its parent if necessary.

- access: protected

void ensureAppended ()
getDOM (line 68)

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 ()
offsetExists (line 331)

Required by the ArrayAccess interface.

- access: public

void offsetExists ( $offset)

- $offset

Implementation of:

ArrayAccess::offsetExists

offsetGet (line 347)

Required by the ArrayAccess interface.

- access: public

void offsetGet ( $offset)

- $offset

Implementation of:

ArrayAccess::offsetGet

offsetSet (line 363)

Required by the ArrayAccess interface.

- access: public

void offsetSet ( $offset, $value)

- $offset
- $value

Implementation of:

ArrayAccess::offsetSet

offsetUnset (line 381)

Required by the ArrayAccess interface.

- access: public

void offsetUnset ( $offset)

- $offset

Implementation of:

ArrayAccess::offsetUnset

saveXML (line 125)

Get an XML string representation of this element

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

- access: public

string saveXML ()
saveXMLFragment (line 142)

Get the XML for only this element

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

- access: public

string saveXMLFragment ()
setDOM (line 83)

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

setParent (line 95)

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 302)

Finds children with tagnames matching $var

Similar to SimpleXML's children() method.

- access: protected

array _children (mixed $var)
__call (line 253)

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, $unused)

- string $var: The element to get the string value of.
- $unused

__get (line 158)

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.

__isset (line 220)

Map isset calls onto the underlying entry representation.

Only supported by PHP 5.1 and later.

- access: public

void __isset ( $var)

- $var

__set (line 193)

Map variable sets onto the underlying entry representation.

- access: public

void __set (string $var, string $val)

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

__toString (line 288)

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

- access: public

void __toString ()
__unset (line 272)

Remove all children matching $var.

Only supported by PHP 5.1 and later.

- access: public

void __unset ( $var)

- $var

Documentation generated on Sun, 29 Oct 2006 21:27:09 -0600 by phpDocumentor 1.3.0RC6