API Documentation

Zend/Gdata/Gapps/MemberEntry.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:$  

\Zend_Gdata_Gapps_MemberEntry

Package: Zend\Gdata\Gapps

Data model class for a Google Apps Member Entry.

Each member entry describes a single member within a Google Apps hosted domain.

To transfer member 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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotected  $_entryClassName= ''Zend_Gdata_Gapps_MemberEntry''
Default value'Zend_Gdata_Gapps_MemberEntry'Details
Type
Propertyprotected\Zend_Gdata_Gapps_Extension_Property  $_property= 'array()'

<apps:property> element containing information about other items relevant to this entry.

Default valuearray()Details
Type
\Zend_Gdata_Gapps_Extension_Property

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.
methodpublicgetProperty( string $rel = null ) : mixed

Returns all property tags for this entry

Parameters
Name Type Description
$rel string

The rel value of the property to be found. If null, the array of properties is returned instead.

Returns
Type Description
mixed Either an array of Zend_Gdata_Gapps_Extension_Property objects if $rel is null, a single Zend_Gdata_Gapps_Extension_Property object if $rel is specified and a matching feed link is found, or null if $rel is specified and no matching property is found.
methodpublicsetProperty( array $value ) : \Zend_Gdata_Gapps_MemberEntry

Set the value of the property property for this object.

Parameters
Name Type Description
$value array

A collection of Zend_Gdata_Gapps_Extension_Property objects.

Returns
Type Description
\Zend_Gdata_Gapps_MemberEntry 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.