Zend/Gdata/Gapps/UserEntry.php

Show:

inherited

Classes
- \Zend_Gdata_Gapps_UserEntry

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: UserEntry.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Gdata_Gapps_UserEntry
jump to top

Package: Zend\Gdata\Gapps

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.

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


                 $_entryClassName= ''Zend_Gdata_Gapps_UserEntry''

Default value'Zend_Gdata_Gapps_UserEntry'Details

Type

\Zend_Gdata_Extension_FeedLink
                 $_feedLink= 'array()'

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

Default valuearray()Details

Type: \Zend_Gdata_Extension_FeedLink

\Zend_Gdata_Gapps_Extension_Login
                 $_login= 'null'

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

Default valuenullDetails

Type: \Zend_Gdata_Gapps_Extension_Login

\Zend_Gdata_Gapps_Extension_Name
                 $_name= 'null'

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

Default valuenullDetails

Type: \Zend_Gdata_Gapps_Extension_Name

\Zend_Gdata_Gapps_Extension_Quota
                 $_quota= 'null'

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

Default valuenullDetails

Type: \Zend_Gdata_Gapps_Extension_Quota

Methods

__construct(
          \DOMElement $element
              =
              null
          )
        
        :
          void

Create a new instance.

Parameters

Name	Type	Description
$element	\DOMElement	(optional) DOMElement from which this object should be constructed.

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.

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.

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.

Parameters

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

Returns

Type	Description
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.

getLogin(
          
          )
        
        :
          \Zend_Gdata_Gapps_Extension_Login

Get the value of the login property for this object.

Returns

Type	Description
\Zend_Gdata_Gapps_Extension_Login	The requested object.

Details

See: \setLogin

getName(
          
          )
        
        :
          \Zend_Gdata_Gapps_Extension_Name

Get the value of the name property for this object.

Returns

Type	Description
\Zend_Gdata_Gapps_Extension_Name	The requested object.

Details

See: \setName

getQuota(
          
          )
        
        :
          \Zend_Gdata_Gapps_Extension_Quota

Get the value of the quota property for this object.

Returns

Type	Description
\Zend_Gdata_Gapps_Extension_Quota	The requested object.

Details

See: \setQuota

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.

Parameters

Name	Type	Description
$value	array	A collection of Zend_Gdata_Gapps_Extension_FeedLink objects.

Returns

Type	Description
\Zend_Gdata_Gapps_EventEntry	Provides a fluent interface.

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.

Parameters

Name	Type	Description
$value	\Zend_Gdata_Gapps_Extension_Login	The desired value for this instance's login property.

Returns

Type	Description
\Zend_Gdata_Gapps_UserEntry	Provides a fluent interface.

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.

Parameters

Name	Type	Description
$value	\Zend_Gdata_Gapps_Extension_Name	The desired value for this instance's name property.

Returns

Type	Description
\Zend_Gdata_Gapps_UserEntry	Provides a fluent interface.

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.

Parameters

Name	Type	Description
$value	\Zend_Gdata_Gapps_Extension_Quota	The desired value for this instance's quota property.

Returns

Type	Description
\Zend_Gdata_Gapps_UserEntry	Provides a fluent interface.

takeChildFromDOM(
          \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

API Documentation

Zend/Gdata/Gapps/UserEntry.php

\Zend_Gdata_Gapps_UserEntryjump to top

Properties

Methods

\Zend_Gdata_Gapps_UserEntry
jump to top