Gdata/Gapps/EmailListEntry.php

Show: PublicProtectedPrivateinherited
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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Gdata  
Subpackage
Gapps  
Version
$Id$  

\Zend_Gdata_Gapps_EmailListEntry
jump to top

Package: Zend_Gdata\Gapps
Data model class for a Google Apps Email List Entry.
Each email list entry describes a single email list within a Google Apps hosted domain. Email lists may contain multiple recipients, as described by instances of Zend_Gdata_Gapps_EmailListRecipient. Multiple entries are contained within instances of Zend_Gdata_Gapps_EmailListFeed. To transfer email list entries to and from the Google Apps servers, including creating new entries, 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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotected\Zend_Gdata_Gapps_Extension_EmailList $_emailList = null
child element containing general information about this email list.
Default valuenullDetails
Type
\Zend_Gdata_Gapps_Extension_EmailList
>VPropertyprotected$_entryClassName = 'Zend_Gdata_Gapps_EmailListEntry'
Default value'Zend_Gdata_Gapps_EmailListEntry'Details
Type
n/a
>VPropertyprotected\Zend_Gdata_Extension_FeedLink $_feedLink = array()
element containing information about other feeds relevant to this entry.
Default valuearray()Details
Type
\Zend_Gdata_Extension_FeedLink

Methods

methodpublic__construct(\DOMElement $element = null) : void

Create a new instance.

Parameters
NameTypeDescription
$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
NameTypeDescription
$doc\DOMDocument

The DOMDocument used to construct DOMElements

$majorVersion
$minorVersion
Returns
TypeDescription
\DOMElementThe DOMElement representing this element and all child properties.
methodpublicgetEmailList() : \Zend_Gdata_Gapps_Extension_EmailList

Retrieve the email list property for this entry.

Returns
TypeDescription
\Zend_Gdata_Gapps_Extension_EmailListThe requested object or null if not set.
Details
See
 
methodpublicgetFeedLink(string $rel = null) : mixed

Get the feed link property for this entry.

Parameters
NameTypeDescription
$relstring

(optional) The rel value of the link to be found.

     If null, the array of links is returned.
Returns
TypeDescription
mixedIf $rel is specified, a Zend_Gdata_Extension_FeedLink object corresponding to the requested rel value is returned if found, or null if the requested value is not found. If $rel is null or not specified, an array of all available feed links for this entry is returned, or null if no feed links are set.
Details
See
 
methodpublicsetEmailList(\Zend_Gdata_Gapps_Extension_EmailList $value) : \Zend_Gdata_Gapps_EventEntry

Set the email list property for this entry. This property contains information such as the name of this email list.

This corresponds to the property in the Google Data protocol.
Parameters
NameTypeDescription
$value\Zend_Gdata_Gapps_Extension_EmailList

The desired value this element, or null to unset.

Returns
TypeDescription
\Zend_Gdata_Gapps_EventEntryProvides a fluent interface
methodpublicsetFeedLink(array $value) : \Zend_Gdata_Gapps_EventEntry

Set the feed link property for this entry. Feed links provide information about other feeds associated with this entry.

This corresponds to the property in the Google Data protocol.
Parameters
NameTypeDescription
$valuearray

A collection of Zend_Gdata_Gapps_Extension_FeedLink instances representing all feed links for this entry, or null to unset.

Returns
TypeDescription
\Zend_Gdata_Gapps_EventEntryProvides 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
NameTypeDescription
$child\DOMNode

The DOMNode to process

Documentation was generated by phpDocumentor 2.2.0 .