Gdata/Gapps/EmailListRecipientEntry.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: EmailListRecipientEntry.php 20096 2010-01-06 02:05:09Z bkarwin $
- Classes
- Zend_Gdata_Gapps_EmailListRecipientEntry
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_EmailListRecipientEntry
- Extends from
- Zend_Gdata_Entry
- 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
- $_entryClassName
- $_who
- Methods
- __construct
- getDOM
- takeChildFromDOM
- getWho
- setWho
Description
Data model class for a Google Apps Email List Recipient Entry.
Each instance of this class represents a recipient of an email list hosted on a Google Apps domain. Each email list may contain multiple recipients. Email lists themselves are described by Zend_Gdata_EmailListEntry. Multiple recipient entries are contained within instances of Zend_Gdata_Gapps_EmailListRecipientFeed.
To transfer email list recipients to and from the Google Apps servers, including creating new recipients, refer to the Google Apps service class, Zend_Gdata_Gapps.
This class represents
Properties
$_entryClassName
$_entryClassName = 'Zend_Gdata_Gapps_EmailListRecipientEntry'
Details
- visibility
- protected
- default
- Zend_Gdata_Gapps_EmailListRecipientEntry
- final
- false
- static
- false
$_who
Zend_Gdata_Extension_Who $_who = 'null'<gd:who> element used to store the email address of the current recipient. Only the email property of this element should be populated.
Details
- $_who
-
Zend_Gdata_Extension_Who
- visibility
- protected
- default
- null
- final
- false
- static
- false
Methods
__construct
__construct(
DOMElement $element
=
null
)
:
Create a new instance.
Arguments
- $element
- DOMElement
(optional) DOMElement from which this object should be constructed.
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 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
getWho
getWho(
)
:
Zend_Gdata_Extension_WhoGet the value of the who property for this object.
Output
- Zend_Gdata_Extension_Who
- The requested object.
Details
- visibility
- public
- final
- false
- static
- false
- see
- setWho
setWho
setWho(
Zend_Gdata_Extension_Who $value
)
:
Zend_Gdata_Gapps_EventEntrySet the value of the who property for this object. This property is used to store the email address of the current recipient.
Arguments
- $value
- Zend_Gdata_Extension_Who
The desired value for this instance's who property.
Output
- Zend_Gdata_Gapps_EventEntry
- Provides a fluent interface.
Details
- visibility
- public
- final
- false
- static
- false
takeChildFromDOM
takeChildFromDOM(
DOMNode $child
)
:
Creates individual Entry objects of the appropriate type and stores them as members of this entry based upon DOM data.
Arguments
- $child
- DOMNode
The DOMNode to process
Details
- visibility
- protected
- final
- false
- static
- false