Zend Framework  1.12
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Zend_Gdata_Gapps_Extension_Nickname Class Reference

Public Member Functions

 __construct ($name=null)
 Constructs a new Zend_Gdata_Gapps_Extension_Nickname object.
 
 getDOM ($doc=null, $majorVersion=1, $minorVersion=null)
 Retrieves a DOMElement which corresponds to this element and all child properties.
 
 getName ()
 Get the value for this element's name attribute.
 
 setName ($value)
 Set the value for this element's name attribute.
 
 __toString ()
 Magic toString method allows using this directly via echo Works best in PHP >= 4.2.0.
 
- Public Member Functions inherited from Zend_Gdata_Extension
 __construct ()
 

Protected Member Functions

 takeAttributeFromDOM ($attribute)
 Given a DOMNode representing an attribute, tries to map the data into instance members.
 

Protected Attributes

 $_rootNamespace = 'apps'
 
 $_rootElement = 'nickname'
 
 $_name = null
 
- Protected Attributes inherited from Zend_Gdata_Extension
 $_rootNamespace = 'gd'
 

Additional Inherited Members

- Static Public Member Functions inherited from Zend_Gdata_App_Base
static flushNamespaceLookupCache ()
 Flush namespace lookup cache.
 
- Static Protected Attributes inherited from Zend_Gdata_App_Base
static $_namespaceLookupCache = array()
 

Constructor & Destructor Documentation

__construct (   $name = null)

Constructs a new Zend_Gdata_Gapps_Extension_Nickname object.

Parameters
string$name(optional) The nickname being represented.

Member Function Documentation

__toString ( )

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

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$docThe DOMDocument used to construct DOMElements
Returns
DOMElement The DOMElement representing this element and all child properties.
getName ( )

Get the value for this element's name attribute.

See Also
setName
Returns
string The requested attribute.
setName (   $value)

Set the value for this element's name attribute.

This name uniquely describes this nickname within the domain. Emails addressed to this name will be delivered to the user who owns this nickname.

Parameters
string$valueThe desired value for this attribute.
Returns
Zend_Gdata_Gapps_Extension_Nickname Provides a fluent interface.
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$attributeThe DOMNode attribute needed to be handled

Member Data Documentation

$_name = null
protected
$_rootElement = 'nickname'
protected
$_rootNamespace = 'apps'
protected