API Documentation

Gdata/Gapps/EmailListEntry.php

Includes Classes 
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: EmailListEntry.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Gdata_Gapps_EmailListEntry

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_EmailListEntry

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
$_emailList
$_feedLink
Methods
__construct
getDOM
takeChildFromDOM
getEmailList
setEmailList
getFeedLink
setFeedLink

Description

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.

Properties

$_emailList

Zend_Gdata_Gapps_Extension_EmailList $_emailList = 'null'

<apps:emailList> child element containing general information about this email list.

Details

$_emailList
Zend_Gdata_Gapps_Extension_EmailList
visibility
protected
default
null
final
false
static
false

$_entryClassName

 $_entryClassName = 'Zend_Gdata_Gapps_EmailListEntry'

Details

visibility
protected
default
Zend_Gdata_Gapps_EmailListEntry
final
false
static
false

$_feedLink

Zend_Gdata_Extension_FeedLink $_feedLink = 'array'

<gd:feedLink> element containing information about other feeds relevant to this entry.

Details

$_feedLink
Zend_Gdata_Extension_FeedLink
visibility
protected
default
array
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 ) : 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.

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

getEmailList

getEmailList( ) : Zend_Gdata_Gapps_Extension_EmailList

Retrieve the email list property for this entry.

Output
Zend_Gdata_Gapps_Extension_EmailList
The requested object or null if not set.
Details
visibility
public
final
false
static
false
see
setEmailList

getFeedLink

getFeedLink( string $rel = null ) : mixed

Get the feed link property for this entry.

Arguments
$rel
string
(optional) The rel value of the link to be found. If null, the array of links is returned.
Output
mixed
If $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
visibility
public
final
false
static
false
see
setFeedLink

setEmailList

setEmailList( 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.

Arguments
$value
Zend_Gdata_Gapps_Extension_EmailList
The desired value this element, or null to unset.
Output
Zend_Gdata_Gapps_EventEntry
Provides a fluent interface
Details
visibility
public
final
false
static
false

setFeedLink

setFeedLink( 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.

Arguments
$value
array
A collection of Zend_Gdata_Gapps_Extension_FeedLink instances representing all feed links for this entry, or null to unset.
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
Documentation was generated by DocBlox.