[ Index ]

PHP Cross Reference of moodle-2.8

title

Body

[close]

/lib/zend/Zend/Gdata/App/ -> Base.php (summary)

Zend Framework LICENSE

Copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
License: http://framework.zend.com/license/new-bsd New BSD License
Version: $Id$
File Size: 572 lines (19 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 24 functions

  __construct()
  getText()
  setText()
  getExtensionElements()
  setExtensionElements()
  getExtensionAttributes()
  setExtensionAttributes()
  getDOM()
  takeChildFromDOM()
  takeAttributeFromDOM()
  transferFromDOM()
  transferFromXML()
  saveXML()
  getXML()
  encode()
  lookupNamespace()
  registerNamespace()
  flushNamespaceLookupCache()
  registerAllNamespaces()
  __get()
  __set()
  __isset()
  __unset()
  __toString()

Functions
Functions that are not part of a class:

__construct()   X-Ref
No description

getText($trim = true)   X-Ref
Returns the child text node of this element
This represents any raw text contained within the XML element

return: string Child text node

setText($value)   X-Ref
Sets the child text node of this element
This represents any raw text contained within the XML element

param: string $value Child text node
return: Zend_Gdata_App_Base Returns an object of the same type as 'this' to provide a fluent interface.

getExtensionElements()   X-Ref
Returns an array of all elements not matched to data model classes
during the parsing of the XML

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

setExtensionElements($value)   X-Ref
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.

param: array $value All extension elements
return: Zend_Gdata_App_Base Returns an object of the same type as 'this' to provide a fluent interface.

getExtensionAttributes()   X-Ref
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);

return: array All extension attributes

setExtensionAttributes($value)   X-Ref
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

param: array $value All extension attributes
return: Zend_Gdata_App_Base Returns an object of the same type as 'this' to provide a fluent interface.

getDOM($doc = null, $majorVersion = 1, $minorVersion = null)   X-Ref
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.

param: DOMDocument $doc The DOMDocument used to construct DOMElements
return: DOMElement The DOMElement representing this element and all

takeChildFromDOM($child)   X-Ref
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.

param: DOMNode $child The DOMNode needed to be handled

takeAttributeFromDOM($attribute)   X-Ref
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.

param: DOMNode $attribute The DOMNode attribute needed to be handled

transferFromDOM($node)   X-Ref
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.

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

transferFromXML($xml)   X-Ref
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.

param: string $xml The XML text to parse

saveXML()   X-Ref
Converts this element and all children into XML text using getDOM()

return: string XML content

getXML()   X-Ref
Alias for saveXML() returns XML content for this element and all
children

return: string XML content

encode()   X-Ref
Alias for saveXML()

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

return: string Encoded string content

lookupNamespace($prefix,$majorVersion = 1,$minorVersion = null)   X-Ref
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.

param: string $prefix The namespace prefix to lookup.
param: integer $majorVersion The major protocol version in effect.
param: integer $minorVersion The minor protocol version in effect.
return: string

registerNamespace($prefix,$namespaceUri,$majorVersion = 1,$minorVersion = 0)   X-Ref
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().

param: string $prefix The namespace prefix
param: string $namespaceUri The full namespace URI
param: integer $majorVersion The major protocol version in effect.
param: integer $minorVersion The minor protocol version in effect.
return: void

flushNamespaceLookupCache()   X-Ref
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().

registerAllNamespaces($namespaceArray)   X-Ref
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()

param: array $namespaceArray An array of namespaces.
return: void

__get($name)   X-Ref
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??

param: string $name The variable name sought

__set($name, $val)   X-Ref
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??

param: string $name
param: string $value

__isset($name)   X-Ref
Magic __isset method

param: string $name

__unset($name)   X-Ref
Magic __unset method

param: string $name

__toString()   X-Ref
Magic toString method allows using this directly via echo
Works best in PHP >= 4.2.0

return: string The text representation of this object



Generated: Fri Nov 28 20:29:05 2014 Cross-referenced by PHPXref 0.7.1