API Documentation

Zend/Feed/Element.php

Show: inherited
Table of Contents

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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Feed  
Version
$Id: Element.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Feed_Element

Package: Zend\Feed

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

Implements
Children
\Zend_Feed_Entry_Abstract
\Zend_Feed_Abstract
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedboolean  $_appended= 'true'

Default valuetrueDetails
Type
boolean
Propertyprotected\DOMElement  $_element= ''

Details
Type
\DOMElement
Propertyprotectedstring  $_encoding= ''UTF-8''

Character encoding to utilize
Default value'UTF-8'Details
Type
string
Propertyprotected\Zend_Feed_Element  $_parentElement= ''

Details
Type
\Zend_Feed_Element

Methods

methodpublic__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.

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( \DOMElement $element = null ) : void

Zend_Feed_Element constructor.

Parameters
Name Type Description
$element \DOMElement

The DOM element we're encapsulating.

methodpublic__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.

Parameters
Name Type Description
$var string

The property to access.

Returns
Type Description
mixed
methodpublic__isset( string $var ) : boolean

Map isset calls onto the underlying entry representation.

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

Map variable sets onto the underlying entry representation.

Parameters
Name Type Description
$var string

The property to change.

$val string

The property's new 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.

Returns
Type Description
string
methodpublic__unset( string $var ) : void

Remove all children matching $var.

Parameters
Name Type Description
$var string
methodprotected_children( string $var ) : array

Finds children with tagnames matching $var

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.

methodpublicgetDOM( ) : \DOMDocument

Get a DOM representation of the element

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

Returns
Type Description
\DOMDocument
methodpublicgetEncoding( ) : string

Get encoding

Returns
Type Description
string
methodpublicoffsetExists( string $offset ) : boolean

Required by the ArrayAccess interface.

Parameters
Name Type Description
$offset string
Returns
Type Description
boolean
methodpublicoffsetGet( string $offset ) : string

Required by the ArrayAccess interface.

Parameters
Name Type Description
$offset string
Returns
Type Description
string
methodpublicoffsetSet( string $offset, string $value ) : string

Required by the ArrayAccess interface.

Parameters
Name Type Description
$offset string
$value string
Returns
Type Description
string
methodpublicoffsetUnset( string $offset ) : boolean

Required by the ArrayAccess interface.

Parameters
Name Type Description
$offset string
Returns
Type Description
boolean
methodpublicsaveXml( ) : string

Get an XML string representation of this element

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

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

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

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.

Parameters
Name Type Description
$element \Zend_Feed_Element
Documentation was generated by DocBlox 0.15.1.