Gdata/Gapps/Extension/EmailList.php
- category
- Zend
- copyright
- Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- license
- http://framework.zend.com/license/new-bsd New BSD License
- package
- Zend_Gdata
- subpackage
- Gapps
- version
- $Id: EmailList.php 20096 2010-01-06 02:05:09Z bkarwin $
- Classes
- Zend_Gdata_Gapps_Extension_EmailList
Description
Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
Zend_Gdata_Gapps_Extension_EmailList
- Extends from
- Zend_Gdata_Extension
- category
- Zend
- copyright
- Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- license
- http://framework.zend.com/license/new-bsd New BSD License
- package
- Zend_Gdata
- subpackage
- Gapps
- Properties
- $_rootNamespace
- $_rootElement
- $_name
- Methods
- __construct
- getDOM
- takeAttributeFromDOM
- getName
- setName
- __toString
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.
Properties
$_name
string $_name = 'null'The name of the email list. This name is used as the email address for this list.
Details
- $_name
- string
- visibility
- protected
- default
- null
- final
- false
- static
- false
$_rootElement
$_rootElement = 'emailList'
Details
- visibility
- protected
- default
- emailList
- final
- false
- static
- false
$_rootNamespace
$_rootNamespace = 'apps'
Details
- visibility
- protected
- default
- apps
- final
- false
- static
- false
Methods
__construct
__construct(
string $name
=
null
)
:
Constructs a new Zend_Gdata_Gapps_Extension_EmailList object.
Arguments
- $name
- string
(optional) The name to be used for this email list.
Details
- visibility
- public
- final
- false
- static
- false
__toString
__toString(
)
:
stringMagic toString method allows using this directly via echo Works best in PHP >= 4.2.0
Output
- string
Details
- visibility
- public
- final
- false
- static
- false
getDOM
getDOM(
DOMDocument $doc
=
null, $majorVersion
=
1, $minorVersion
=
null
)
:
DOMElementRetrieves 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.
Arguments
- $doc
- DOMDocument
The DOMDocument used to construct DOMElements - $majorVersion
- $minorVersion
Output
- DOMElement
- The DOMElement representing this element and all child properties.
Details
- visibility
- public
- final
- false
- static
- false
getName
getName(
)
:
stringGet the value for this element's name attribute.
Output
- string
- The requested attribute.
Details
- visibility
- public
- final
- false
- static
- false
- see
- setName
setName
setName(
string $value
)
:
Zend_Gdata_Gapps_Extension_EmailListSet 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.
Arguments
- $value
- string
The desired value for this attribute.
Output
- Zend_Gdata_Gapps_Extension_EmailList
- The element being modified.
Details
- visibility
- public
- final
- false
- static
- false
takeAttributeFromDOM
takeAttributeFromDOM(
DOMNode $attribute
)
:
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.
Arguments
- $attribute
- DOMNode
The DOMNode attribute needed to be handled
Details
- visibility
- protected
- final
- false
- static
- false