Feed/Element.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Feed
version: $Id: Element.php 20104 2010-01-06 21:26:01Z matthew $
Classes: Zend_Feed_Element

Description

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.

Zend_Feed_Element
jump to top

Implements
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Feed
Properties: $_element; $_encoding; $_parentElement; $_appended
Methods: __construct; getDOM; setDOM; setParent; ensureAppended; saveXml; saveXmlFragment; getEncoding; setEncoding; __get; __set; __isset; __call; __unset; __toString; _children; offsetExists; offsetGet; offsetSet; offsetUnset

Description

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

Properties

$_appended
jump to class

boolean $_appended = 'true'

Details

$_appended: boolean
visibility: protected
default: true
final: false
static: false

$_element
jump to class

DOMElement $_element = ''

Details

$_element: DOMElement
visibility: protected
default
final: false
static: false

$_encoding
jump to class

string $_encoding = 'UTF-8'

Details

$_encoding: string
Character encoding to utilize
visibility: protected
default: UTF-8
final: false
static: false

$_parentElement
jump to class

Zend_Feed_Element $_parentElement = ''

Details

$_parentElement: Zend_Feed_Element
visibility: protected
default
final: false
static: false

Methods

__call
jump to class

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

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.

Arguments

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

Output

mixed: The node's value, null, or an array of nodes.

Details

visibility: public
final: false
static: false

__construct
jump to class

__construct(
          DOMElement $element
              =
              null
          )
        
        :
        void

Zend_Feed_Element constructor.

Arguments

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

Details

visibility: public
final: false
static: false

__get
jump to class

__get(
          string $var
          )
        
        :
        mixed

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.

Arguments

$var: string
The property to access.

Output

mixed

Details

visibility: public
final: false
static: false

__isset
jump to class

__isset(
          string $var
          )
        
        :
        boolean

Map isset calls onto the underlying entry representation.

Arguments

$var: string

Output

boolean

Details

visibility: public
final: false
static: false

__set
jump to class

__set(
          string $var, string $val
          )
        
        :
        void

Map variable sets onto the underlying entry representation.

Arguments

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

Details

visibility: public
final: false
static: false
throws

__toString
jump to class

__toString(
          
          )
        
        :
        string

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

Output

string

Details

visibility: public
final: false
static: false

__unset
jump to class

__unset(
          string $var
          )
        
        :
        void

Remove all children matching $var.

Arguments

$var: string

Details

visibility: public
final: false
static: false

_children
jump to class

_children(
          string $var
          )
        
        :
        array

Finds children with tagnames matching $var

Similar to SimpleXML's children() method.

Arguments

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

Output

array

Details

visibility: protected
final: false
static: false

ensureAppended
jump to class

ensureAppended(
          
          )
        
        :
        void

Appends this element to its parent if necessary.

Details

visibility: protected
final: false
static: false

getDOM
jump to class

getDOM(
          
          )
        
        :
        DOMDocument

Get a DOM representation of the element

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

Output

DOMDocument

Details

visibility: public
final: false
static: false

getEncoding
jump to class

getEncoding(
          
          )
        
        :
        string

Get encoding

Output

string

Details

visibility: public
final: false
static: false

offsetExists
jump to class

offsetExists(
          string $offset
          )
        
        :
        boolean

Required by the ArrayAccess interface.

Arguments

$offset: string

Output

boolean

Details

visibility: public
final: false
static: false

offsetGet
jump to class

offsetGet(
          string $offset
          )
        
        :
        string

Required by the ArrayAccess interface.

Arguments

$offset: string

Output

string

Details

visibility: public
final: false
static: false

offsetSet
jump to class

offsetSet(
          string $offset, string $value
          )
        
        :
        string

Required by the ArrayAccess interface.

Arguments

$offset: string
$value: string

Output

string

Details

visibility: public
final: false
static: false

offsetUnset
jump to class

offsetUnset(
          string $offset
          )
        
        :
        boolean

Required by the ArrayAccess interface.

Arguments

$offset: string

Output

boolean

Details

visibility: public
final: false
static: false

saveXml
jump to class

saveXml(
          
          )
        
        :
        string

Get an XML string representation of this element

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

Output

string

Details

visibility: public
final: false
static: false

saveXmlFragment
jump to class

saveXmlFragment(
          
          )
        
        :
        string

Get the XML for only this element

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

Output

string

Details

visibility: public
final: false
static: false

setDOM
jump to class

setDOM(
          DOMElement $element
          )
        
        :
        void

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.

Arguments

$element: DOMElement

Details

visibility: public
final: false
static: false

setEncoding
jump to class

setEncoding(
          string $value
          )
        
        :
        Zend_Feed_Element

Set encoding

Arguments

$value: string
Encoding to use

Output

Zend_Feed_Element

Details

visibility: public
final: false
static: false

setParent
jump to class

setParent(
          Zend_Feed_Element $element
          )
        
        :
        void

Set the parent element of this object to another Zend_Feed_Element.

Arguments

$element: Zend_Feed_Element

Details

visibility: public
final: false
static: false

API Documentation

Feed/Element.php

Description

Zend_Feed_Elementjump to top

Description

Properties

$_appendedjump to class

Details

$_elementjump to class

Details

$_encodingjump to class

Details

$_parentElementjump to class

Details

Methods

__calljump to class

Arguments

Output

Details

__constructjump to class

Arguments

Details

__getjump to class

Arguments

Output

Details

__issetjump to class

Arguments

Output

Details

__setjump to class

Arguments

Details

__toStringjump to class

Output

Details

__unsetjump to class

Arguments

Details

_childrenjump to class

Arguments

Output

Details

ensureAppendedjump to class

Details

getDOMjump to class

Output

Details

getEncodingjump to class

Output

Details

offsetExistsjump to class

Arguments

Output

Details

offsetGetjump to class

Arguments

Output

Details

offsetSetjump to class

Arguments

Output

Details

offsetUnsetjump to class

Arguments

Output

Details

saveXmljump to class

Output

Details

saveXmlFragmentjump to class

Output

Details

setDOMjump to class

Arguments

Details

setEncodingjump to class

Arguments

Output

Details

Zend_Feed_Element
jump to top

$_appended
jump to class

$_element
jump to class

$_encoding
jump to class

$_parentElement
jump to class

__call
jump to class

__construct
jump to class

__get
jump to class

__isset
jump to class

__set
jump to class

__toString
jump to class

__unset
jump to class

_children
jump to class

ensureAppended
jump to class

getDOM
jump to class

getEncoding
jump to class

offsetExists
jump to class

offsetGet
jump to class

offsetSet
jump to class

offsetUnset
jump to class

saveXml
jump to class

saveXmlFragment
jump to class

setDOM
jump to class

setEncoding
jump to class

setParent
jump to class