Docs For Class Zend_Gdata_Gapps_Extension

Description

Represents the apps:emailList element used by the Apps data API. This class represents properties of an email list and is usually contained within an instance of Zend_Gdata_Gapps_EmailListEntry.

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

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

Zend_Gdata_App_Base
   |
   --Zend_Gdata_App_Extension
      |
      --Zend_Gdata_Extension
         |
         --Zend_Gdata_Gapps_Extension_EmailList

Variable Summary

string $_name

mixed $_rootElement

mixed $_rootNamespace

Method Summary

Zend_Gdata_Gapps_Extension_EmailList __construct ([string $name = null])

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

string getName ()

Zend_Gdata_Gapps_Extension_EmailList setName (string $value)

void takeAttributeFromDOM (DOMNode $attribute)

string __toString ()

Variables

string $_name = null (line 57)

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

access: protected

mixed $_rootElement = 'emailList' (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 64)

Constructs a new Zend_Gdata_Gapps_Extension_EmailList object.

access: public

Zend_Gdata_Gapps_Extension_EmailList __construct ([string $name = null])

string $name: (optional) The name to be used for this email list.

Redefinition of:

Zend_Gdata_Extension::__construct()

getDOM (line 81)

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 114)

Get the value for this element's name attribute.

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

string getName ()

setName (line 127)

Set the value for this element's name attribute. This is the unique name which will be used to identify this email list within this domain, and will be used to form this email list's email address.

return: The element being modified.
access: public

Zend_Gdata_Gapps_Extension_EmailList setName (string $value)

string $value: The desired value for this attribute.

takeAttributeFromDOM (line 97)

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 139)

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

access: public

string __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()