API Documentation

Zend/Gdata/Gapps/EmailListRecipientEntry.php

Show: inherited
Table of Contents

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.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Gdata  
Subpackage
Gapps  
Version
$Id: EmailListRecipientEntry.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Gdata_Gapps_EmailListRecipientEntry

Package: Zend\Gdata\Gapps

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 in the Google Data protocol.

Parent(s)
\Zend_Gdata_Entry < \Zend_Gdata_App_MediaEntry < \Zend_Gdata_App_Entry < \Zend_Gdata_App_FeedEntryParent < \Zend_Gdata_App_Base
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotected  $_entryClassName= ''Zend_Gdata_Gapps_EmailListRecipientEntry''
Default value'Zend_Gdata_Gapps_EmailListRecipientEntry'Details
Type
Propertyprotected\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.

Default valuenullDetails
Type
\Zend_Gdata_Extension_Who

Methods

methodpublic__construct( \DOMElement $element = null ) : void

Create a new instance.

Parameters
Name Type Description
$element \DOMElement

(optional) DOMElement from which this object should be constructed.

methodpublicgetDOM( \DOMDocument $doc = null,  $majorVersion = 1,  $minorVersion = null ) : \DOMElement

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 application storage/persistence.

Parameters
Name Type Description
$doc \DOMDocument

The DOMDocument used to construct DOMElements

$majorVersion
$minorVersion
Returns
Type Description
\DOMElement The DOMElement representing this element and all child properties.
methodpublicgetWho( ) : \Zend_Gdata_Extension_Who

Get the value of the who property for this object.

Returns
Type Description
\Zend_Gdata_Extension_Who The requested object.
Details
See
\setWho  
methodpublicsetWho( \Zend_Gdata_Extension_Who $value ) : \Zend_Gdata_Gapps_EventEntry

Set the value of the who property for this object. This property is used to store the email address of the current recipient.

Parameters
Name Type Description
$value \Zend_Gdata_Extension_Who

The desired value for this instance's who property.

Returns
Type Description
\Zend_Gdata_Gapps_EventEntry Provides a fluent interface.
methodprotectedtakeChildFromDOM( \DOMNode $child ) : void

Creates individual Entry objects of the appropriate type and stores them as members of this entry based upon DOM data.

Parameters
Name Type Description
$child \DOMNode

The DOMNode to process

Documentation was generated by DocBlox 0.15.1.