Gdata/Gapps/UserEntry.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: UserEntry.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Gdata_Gapps_UserEntry

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_UserEntry
jump to top

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; $_login; $_name; $_quota; $_feedLink
Methods: __construct; getDOM; takeChildFromDOM; getLogin; setLogin; getName; setName; getQuota; setQuota; getFeedLink; setFeedLink

Description

Data model class for a Google Apps User Entry.

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

To transfer user 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

$_entryClassName
jump to class

$_entryClassName = 'Zend_Gdata_Gapps_UserEntry'

Details

visibility: protected
default: Zend_Gdata_Gapps_UserEntry
final: false
static: false

$_feedLink
jump to class

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

$_login
jump to class

Zend_Gdata_Gapps_Extension_Login $_login = 'null'

<apps:login> element containing information about this user's account, including their username and permissions.

Details

$_login: Zend_Gdata_Gapps_Extension_Login
visibility: protected
default: null
final: false
static: false

$_name
jump to class

Zend_Gdata_Gapps_Extension_Name $_name = 'null'

<apps:name> element containing the user's actual name.

Details

$_name: Zend_Gdata_Gapps_Extension_Name
visibility: protected
default: null
final: false
static: false

$_quota
jump to class

Zend_Gdata_Gapps_Extension_Quota $_quota = 'null'

<apps:quotq> element describing any storage quotas in place for this user.

Details

$_quota: Zend_Gdata_Gapps_Extension_Quota
visibility: protected
default: null
final: false
static: false

Methods

__construct
jump to class

__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
jump to class

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

getFeedLink
jump to class

getFeedLink(
          string $rel
              =
              null
          )
        
        :
        mixed

Returns all feed links for this entry, or if a rel value is specified, the feed link associated with that value is returned.

Arguments

$rel: string
The rel value of the link to be found. If null, the array of links is returned instead.

Output

mixed: Either an array of Zend_Gdata_Extension_FeedLink objects if $rel is null, a single Zend_Gdata_Extension_FeedLink object if $rel is specified and a matching feed link is found, or null if $rel is specified and no matching feed link is found.

Details

visibility: public
final: false
static: false

getLogin
jump to class

getLogin(
          
          )
        
        :
        Zend_Gdata_Gapps_Extension_Login

Get the value of the login property for this object.

Output

Zend_Gdata_Gapps_Extension_Login: The requested object.

Details

visibility: public
final: false
static: false
see: setLogin

getName
jump to class

getName(
          
          )
        
        :
        Zend_Gdata_Gapps_Extension_Name

Get the value of the name property for this object.

Output

Zend_Gdata_Gapps_Extension_Name: The requested object.

Details

visibility: public
final: false
static: false
see: setName

getQuota
jump to class

getQuota(
          
          )
        
        :
        Zend_Gdata_Gapps_Extension_Quota

Get the value of the quota property for this object.

Output

Zend_Gdata_Gapps_Extension_Quota: The requested object.

Details

visibility: public
final: false
static: false
see: setQuota

setFeedLink
jump to class

setFeedLink(
          array $value
          )
        
        :
        Zend_Gdata_Gapps_EventEntry

Set the value of the feed link property for this object. This property is used to provide links to alternative feeds relevant to this entry.

Arguments

$value: array
A collection of Zend_Gdata_Gapps_Extension_FeedLink objects.

Output

Zend_Gdata_Gapps_EventEntry: Provides a fluent interface.

Details

visibility: public
final: false
static: false

setLogin
jump to class

setLogin(
          Zend_Gdata_Gapps_Extension_Login $value
          )
        
        :
        Zend_Gdata_Gapps_UserEntry

Set the value of the login property for this object. This property is used to store the username address of the current user.

Arguments

$value: Zend_Gdata_Gapps_Extension_Login
The desired value for this instance's login property.

Output

Zend_Gdata_Gapps_UserEntry: Provides a fluent interface.

Details

visibility: public
final: false
static: false

setName
jump to class

setName(
          Zend_Gdata_Gapps_Extension_Name $value
          )
        
        :
        Zend_Gdata_Gapps_UserEntry

Set the value of the name property for this object. This property is used to store the full name of the current user.

Arguments

$value: Zend_Gdata_Gapps_Extension_Name
The desired value for this instance's name property.

Output

Zend_Gdata_Gapps_UserEntry: Provides a fluent interface.

Details

visibility: public
final: false
static: false

setQuota
jump to class

setQuota(
          Zend_Gdata_Gapps_Extension_Quota $value
          )
        
        :
        Zend_Gdata_Gapps_UserEntry

Set the value of the quota property for this object. This property is used to store the amount of storage available for the current user. Quotas may not be modifiable depending on the domain used.

Arguments

$value: Zend_Gdata_Gapps_Extension_Quota
The desired value for this instance's quota property.

Output

Zend_Gdata_Gapps_UserEntry: Provides a fluent interface.

Details

visibility: public
final: false
static: false

takeChildFromDOM
jump to class

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

API Documentation

Gdata/Gapps/UserEntry.php

Description

Zend_Gdata_Gapps_UserEntryjump to top

Description

Properties

$_entryClassNamejump to class

Details

$_feedLinkjump to class

Details

$_loginjump to class

Details

$_namejump to class

Details

$_quotajump to class

Details

Methods

__constructjump to class

Arguments

Details

getDOMjump to class

Arguments

Output

Details

getFeedLinkjump to class

Arguments

Output

Details

getLoginjump to class

Output

Details

getNamejump to class

Output

Details

getQuotajump to class

Output

Details

setFeedLinkjump to class

Arguments

Output

Details

setLoginjump to class

Arguments

Output

Details

setNamejump to class

Arguments

Output

Details

setQuotajump to class

Arguments

Output

Details

takeChildFromDOMjump to class

Arguments

Details

Zend_Gdata_Gapps_UserEntry
jump to top

$_entryClassName
jump to class

$_feedLink
jump to class

$_login
jump to class

$_name
jump to class

$_quota
jump to class

__construct
jump to class

getDOM
jump to class

getFeedLink
jump to class

getLogin
jump to class

getName
jump to class

getQuota
jump to class

setFeedLink
jump to class

setLogin
jump to class

setName
jump to class

setQuota
jump to class

takeChildFromDOM
jump to class