## Zend_Gdata_Gapps_Extension_Nickname

Description

Represents the apps:nickname element used by the Apps data API. This is used to describe a nickname's properties, and is usually contained within instances of Zend_Gdata_Gapps_NicknameEntry.

- copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- license: New BSD License

Located in /Gdata/Gapps/Extension/Nickname.php (line 45)

    Zend_Gdata_App_Base
       |
       --Zend_Gdata_App_Extension
          |
          --Zend_Gdata_Extension
             |
             --Zend_Gdata_Gapps_Extension_Nickname

Variable Summary
string $_name
mixed $_rootElement
mixed $_rootNamespace
Method Summary
Zend_Gdata_Gapps_Extension_Nickname __construct ([string $name = null])
DOMElement getDOM ([DOMDocument $doc = null], [ $majorVersion = 1], [ $minorVersion = null])
string getName ()
Zend_Gdata_Gapps_Extension_Nickname setName (string $value)
void takeAttributeFromDOM (DOMNode $attribute)
void __toString ()
Variables
string $_name = null (line 57)

The name of the nickname. This name is used as the email address for this nickname.

- access: protected

mixed $_rootElement = 'nickname' (line 49)

- access: protected

Redefinition of:

Zend_Gdata_App_Base::$_rootElement

mixed $_rootNamespace = 'apps' (line 48)

- access: protected

Redefinition of:

Zend_Gdata_Extension::$_rootNamespace

#### Inherited Variables

Inherited from Zend_Gdata_App_Base

> Zend_Gdata_App_Base::$_extensionAttributes
> Zend_Gdata_App_Base::$_extensionElements
> Zend_Gdata_App_Base::$_namespaceLookupCache
> Zend_Gdata_App_Base::$_namespaces
> Zend_Gdata_App_Base::$_rootNamespaceURI
> Zend_Gdata_App_Base::$_text

Methods
Constructor __construct (line 63)

Constructs a new Zend_Gdata_Gapps_Extension_Nickname object.

- access: public

Zend_Gdata_Gapps_Extension_Nickname __construct ([string $name = null])

- string $name: (optional) The nickname being represented.

Redefinition of:

Zend_Gdata_Extension::__construct()

getDOM (line 80)

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.

- return: The DOMElement representing this element and all child properties.
- access: public

DOMElement getDOM ([DOMDocument $doc = null], [ $majorVersion = 1], [ $minorVersion = null])

- DOMDocument $doc: The DOMDocument used to construct DOMElements
- $majorVersion
- $minorVersion

Redefinition of:

Zend_Gdata_App_Base::getDOM()
  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.

getName (line 113)

Get the value for this element's name attribute.

- return: The requested attribute.
- see: Zend_Gdata_Gapps_Extension_Nickname::setName()
- access: public

string getName ()
setName (line 127)

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.

- return: Provides a fluent interface.
- access: public

Zend_Gdata_Gapps_Extension_Nickname setName (string $value)

- string $value: The desired value for this attribute.

takeAttributeFromDOM (line 96)

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.

- access: protected

void takeAttributeFromDOM (DOMNode $attribute)

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

Redefinition of:

Zend_Gdata_App_Base::takeAttributeFromDOM()
  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.

__toString (line 137)

Magic toString method allows using this directly via echo

Works best in PHP >= 4.2.0

- access: public

void __toString ()

Redefinition of:

Zend_Gdata_App_Base::__toString()
  Magic toString method allows using this directly via echo Works best in PHP >= 4.2.0

#### Inherited Methods

Inherited From Zend_Gdata_Extension

> Zend_Gdata_Extension::__construct()

Inherited From Zend_Gdata_App_Base

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

Documentation generated on Tue, 26 Oct 2010 20:09:00 +0400 by phpDocumentor 1.4.2