Inheritance diagram for Zend_Gdata_App_Base:

Public Member Functions
	__construct ()
	getText ($trim=true)
	setText ($value)
	getExtensionElements ()
	setExtensionElements ($value)
	getExtensionAttributes ()
	setExtensionAttributes ($value)
	getDOM ($doc=null, $majorVersion=1, $minorVersion=null)
	transferFromDOM ($node)
	transferFromXML ($xml)
	saveXML ()
	getXML ()
	encode ()
	lookupNamespace ($prefix, $majorVersion=1, $minorVersion=null)
	registerNamespace ($prefix, $namespaceUri, $majorVersion=1, $minorVersion=0)
	registerAllNamespaces ($namespaceArray)
	__get ($name)
	__set ($name, $val)
	__isset ($name)
	__unset ($name)
	__toString ()
Static Public Member Functions
static	flushNamespaceLookupCache ()
Protected Member Functions
	takeChildFromDOM ($child)
	takeAttributeFromDOM ($attribute)
Protected Attributes
	$_rootElement = null
	$_rootNamespace = 'atom'
	$_rootNamespaceURI = null
	$_extensionElements = array()
	$_extensionAttributes = array()
	$_text = null
	$_namespaces
Static Protected Attributes
static	$_namespaceLookupCache = array()

Detailed Description

Definition at line 38 of file Base.php.

Constructor & Destructor Documentation

__construct ( )

Reimplemented in Zend_Gdata_YouTube_Extension_MediaContent, Zend_Gdata_YouTube_Extension_Private, Zend_Gdata_Media_Extension_MediaKeywords, and Zend_Gdata_Extension.

Definition at line 111 of file Base.php.

Member Function Documentation

__get ( $ name )

Magic getter to allow access like $entry->foo to call $entry->getFoo() Alternatively, if no getFoo() is defined, but a $_foo protected variable is defined, this is returned.

TODO Remove ability to bypass getFoo() methods??

Parameters:

string $name The variable name sought

Reimplemented in Zend_Gdata_App_FeedSourceParent, and Zend_Gdata_App_Feed.

Definition at line 475 of file Base.php.

__isset ( $ name )

Magic __isset method

Parameters:

string $name

Definition at line 520 of file Base.php.

__set	(	$	name,
		$	val
	)

Magic setter to allow acces like $entry->foo='bar' to call $entry->setFoo('bar') automatically.

Alternatively, if no setFoo() is defined, but a $_foo protected variable is defined, this is returned.

TODO Remove ability to bypass getFoo() methods??

Parameters:

string	$name
string	$value

Definition at line 501 of file Base.php.

__toString ( )

Magic toString method allows using this directly via echo Works best in PHP >= 4.2.0

Returns:: string The text representation of this object

Definition at line 567 of file Base.php.

Here is the call graph for this function:

__unset ( $ name )

Magic __unset method

Parameters:

string $name

Definition at line 550 of file Base.php.

encode ( )

Alias for saveXML()

Can be overridden by children to provide more complex representations of entries.

Returns:: string Encoded string content

Reimplemented in Zend_Gdata_App_MediaEntry.

Definition at line 352 of file Base.php.

Here is the call graph for this function:

static flushNamespaceLookupCache ( ) [static]

Flush namespace lookup cache.

Empties the namespace lookup cache. Call this function if you have added data to the namespace lookup table that contradicts values that may have been cached during a previous call to lookupNamespace().

Definition at line 442 of file Base.php.

getDOM	(	$	doc = `null`,
		$	majorVersion = `1`,
		$	minorVersion = `null`
	)

Retrieves a DOMElement which corresponds to this element and all child properties. This is used to build an entry back into a DOM and eventually XML text for sending to the server upon updates, or for application storage/persistence.

Parameters:

DOMDocument $doc The DOMDocument used to construct DOMElements

Returns:: DOMElement The DOMElement representing this element and all child properties.

Definition at line 207 of file Base.php.

Here is the call graph for this function:

Here is the caller graph for this function:

getExtensionAttributes ( )

Returns an array of all extension attributes not transformed into data model properties during parsing of the XML. Each element of the array is a hashed array of the format: array('namespaceUri' => string, 'name' => string, 'value' => string);

Returns:: array All extension attributes

Definition at line 176 of file Base.php.

Here is the caller graph for this function:

getExtensionElements ( )

Returns an array of all elements not matched to data model classes during the parsing of the XML

Returns:: array All elements not matched to data model classes during parsing

Definition at line 149 of file Base.php.

getText ( $ trim = true )

Returns the child text node of this element This represents any raw text contained within the XML element

Returns:: string Child text node

Definition at line 121 of file Base.php.

Here is the caller graph for this function:

getXML ( )

Alias for saveXML() returns XML content for this element and all children

Returns:: string XML content

Definition at line 339 of file Base.php.

Here is the call graph for this function:

array Memoized results from calls to lookupNamespace	(	$	prefix,
		$	majorVersion = `1`,
		$	minorVersion = `null`
	)

Get the full version of a namespace prefix

Looks up a prefix (atom:, etc.) in the list of registered namespaces and returns the full namespace URI if available. Returns the prefix, unmodified, if it's not registered.

Parameters:

string	$prefix	The namespace prefix to lookup.
integer	$majorVersion	The major protocol version in effect. Defaults to '1'.
integer	$minorVersion	The minor protocol version in effect. Defaults to null (use latest).

Returns:: string

expensive calls to getGreatestBoundedValue(). The key is in the form 'prefix-majorVersion-minorVersion', and the value is the output from getGreatestBoundedValue().

Reimplemented in Zend_Gdata_App_FeedEntryParent.

Definition at line 372 of file Base.php.

Here is the call graph for this function:

Here is the caller graph for this function:

registerAllNamespaces ( $ namespaceArray )

Add an array of namespaces to the registered list.

Takes an array in the format of: namespace prefix, namespace URI, major protocol version, minor protocol version and adds them with calls to ->registerNamespace()

Parameters:

array $namespaceArray An array of namespaces.

Returns:: void

Definition at line 457 of file Base.php.

Here is the call graph for this function:

registerNamespace	(	$	prefix,
		$	namespaceUri,
		$	majorVersion = `1`,
		$	minorVersion = `0`
	)

Add a namespace and prefix to the registered list

Takes a prefix and a full namespace URI and adds them to the list of registered namespaces for use by $this->lookupNamespace().

WARNING: Currently, registering a namespace will NOT invalidate any memoized data stored in $_namespaceLookupCache. Under normal use, this behavior is acceptable. If you are adding contradictory data to the namespace lookup table, you must call flushNamespaceLookupCache().

Parameters:

string	$prefix	The namespace prefix
string	$namespaceUri	The full namespace URI
integer	$majorVersion	The major protocol version in effect. Defaults to '1'.
integer	$minorVersion	The minor protocol version in effect. Defaults to null (use latest).

Returns:: void

Definition at line 426 of file Base.php.

Here is the caller graph for this function:

saveXML ( )

Converts this element and all children into XML text using getDOM()

Returns:: string XML content

Definition at line 327 of file Base.php.

Here is the call graph for this function:

Here is the caller graph for this function:

setExtensionAttributes ( $ value )

Sets an array of all extension attributes not transformed into data model properties during parsing of the XML. Each element of the array is a hashed array of the format: array('namespaceUri' => string, 'name' => string, 'value' => string); This can be used to add arbitrary attributes to any data model element

Parameters:

array $value All extension attributes

Returns:: Zend_Gdata_App_Base Returns an object of the same type as 'this' to provide a fluent interface.

Definition at line 191 of file Base.php.

Here is the caller graph for this function:

setExtensionElements ( $ value )

Sets an array of all elements not matched to data model classes during the parsing of the XML. This method can be used to add arbitrary child XML elements to any data model class.

Parameters:

array $value All extension elements

Returns:: Zend_Gdata_App_Base Returns an object of the same type as 'this' to provide a fluent interface.

Definition at line 162 of file Base.php.

setText ( $ value )

Sets the child text node of this element This represents any raw text contained within the XML element

Parameters:

string $value Child text node

Returns:: Zend_Gdata_App_Base Returns an object of the same type as 'this' to provide a fluent interface.

Definition at line 137 of file Base.php.

Here is the caller graph for this function:

takeAttributeFromDOM ( $ attribute ) [protected]

Given a DOMNode representing an attribute, tries to map the data into instance members. If no mapping is defined, the name and value are stored in an array.

Parameters:

DOMNode $attribute The DOMNode attribute needed to be handled

Definition at line 261 of file Base.php.

Here is the caller graph for this function:

takeChildFromDOM ( $ child ) [protected]

Given a child DOMNode, tries to determine how to map the data into object instance members. If no mapping is defined, Extension_Element objects are created and stored in an array.

Parameters:

DOMNode $child The DOMNode needed to be handled

Definition at line 243 of file Base.php.

Here is the caller graph for this function:

transferFromDOM ( $ node )

Transfers each child and attribute into member variables. This is called when XML is received over the wire and the data model needs to be built to represent this XML.

Parameters:

DOMNode $node The DOMNode that represents this object's data

Reimplemented in Zend_Gdata_Spreadsheets_Extension_Custom, Zend_Gdata_Health_Extension_Ccr, and Zend_Gdata_App_Extension_Element.

Definition at line 279 of file Base.php.

Here is the call graph for this function:

Here is the caller graph for this function:

transferFromXML ( $ xml )

Parses the provided XML text and generates data model classes for each know element by turning the XML text into a DOM tree and calling transferFromDOM($element). The first data model element with the same name as $this->_rootElement is used and the child elements are recursively parsed.

Parameters:

string $xml The XML text to parse

Definition at line 298 of file Base.php.

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$_extensionAttributes = array() [protected]

Definition at line 65 of file Base.php.

$_extensionElements = array() [protected]

Definition at line 60 of file Base.php.

$_namespaceLookupCache = array() [static, protected]

Definition at line 78 of file Base.php.

$_namespaces [protected]

Initial value:

 array(
        'atom'      => array(
            1 => array(
                0 => 'http://www.w3.org/2005/Atom'
                )
            ),
        'app'       => array(
            1 => array(
                0 => 'http://purl.org/atom/app#'
                ),
            2 => array(
                0 => 'http://www.w3.org/2007/app'
                )
            )
        )

Definition at line 95 of file Base.php.

$_rootElement = null [protected]

Definition at line 44 of file Base.php.

$_rootNamespace = 'atom' [protected]

Definition at line 49 of file Base.php.

$_rootNamespaceURI = null [protected]

Definition at line 55 of file Base.php.

$_text = null [protected]

Definition at line 70 of file Base.php.

The documentation for this class was generated from the following file:

C:/xampp/htdocs/moodle/lib/zend/Zend/Gdata/App/Base.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation