API Documentation

Zend/Gdata/Photos/UserEntry.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
Photos  
Version
$Id: UserEntry.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Gdata_Photos_UserEntry

Package: Zend\Gdata\Photos

Data model class for a User Entry.

To transfer user entries to and from the servers, including creating new entries, refer to the service class, Zend_Gdata_Photos.

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_Photos_UserEntry''
Default value'Zend_Gdata_Photos_UserEntry'Details
Type
Propertyprotected\Zend_Gdata_Photos_Extension_MaxPhotosPerAlbum  $_gphotoMaxPhotosPerAlbum= 'null'

gphoto:maxPhotosPerAlbum element

Default valuenullDetails
Type
\Zend_Gdata_Photos_Extension_MaxPhotosPerAlbum
Propertyprotected\Zend_Gdata_Photos_Extension_Nickname  $_gphotoNickname= 'null'

gphoto:nickname element

Default valuenullDetails
Type
\Zend_Gdata_Photos_Extension_Nickname
Propertyprotected\Zend_Gdata_Photos_Extension_QuotaCurrent  $_gphotoQuotaCurrent= 'null'

gphoto:quotacurrent element

Default valuenullDetails
Type
\Zend_Gdata_Photos_Extension_QuotaCurrent
Propertyprotected\Zend_Gdata_Photos_Extension_QuotaLimit  $_gphotoQuotaLimit= 'null'

gphoto:quotalimit element

Default valuenullDetails
Type
\Zend_Gdata_Photos_Extension_QuotaLimit
Propertyprotected\Zend_Gdata_Photos_Extension_Thumbnail  $_gphotoThumbnail= 'null'

gphoto:thumbnail element

Default valuenullDetails
Type
\Zend_Gdata_Photos_Extension_Thumbnail
Propertyprotected\Zend_Gdata_Photos_Extension_User  $_gphotoUser= 'null'

gphoto:user element

Default valuenullDetails
Type
\Zend_Gdata_Photos_Extension_User

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.
methodpublicgetGphotoMaxPhotosPerAlbum( ) : string

Get the value for this element's gphoto:maxPhotosPerAlbum attribute.

Returns
Type Description
string The requested attribute.
Details
See
\setGphotoMaxPhotosPerAlbum  
methodpublicgetGphotoNickname( ) : string

Get the value for this element's gphoto:nickname attribute.

Returns
Type Description
string The requested attribute.
Details
See
\setGphotoNickname  
methodpublicgetGphotoQuotaCurrent( ) : string

Get the value for this element's gphoto:quotacurrent attribute.

Returns
Type Description
string The requested attribute.
Details
See
\setGphotoQuotaCurrent  
methodpublicgetGphotoQuotaLimit( ) : string

Get the value for this element's gphoto:quotalimit attribute.

Returns
Type Description
string The requested attribute.
Details
See
\setGphotoQuotaLimit  
methodpublicgetGphotoThumbnail( ) : string

Get the value for this element's gphoto:thumbnail attribute.

Returns
Type Description
string The requested attribute.
Details
See
\setGphotoThumbnail  
methodpublicgetGphotoUser( ) : string

Get the value for this element's gphoto:user attribute.

Returns
Type Description
string The requested attribute.
Details
See
\setGphotoUser  
methodpublicsetGphotoMaxPhotosPerAlbum( string $value ) : \Zend_Gdata_Photos_Extension_MaxPhotosPerAlbum

Set the value for this element's gphoto:maxPhotosPerAlbum attribute.

Parameters
Name Type Description
$value string

The desired value for this attribute.

Returns
Type Description
\Zend_Gdata_Photos_Extension_MaxPhotosPerAlbum The element being modified.
methodpublicsetGphotoNickname( string $value ) : \Zend_Gdata_Photos_Extension_Nickname

Set the value for this element's gphoto:nickname attribute.

Parameters
Name Type Description
$value string

The desired value for this attribute.

Returns
Type Description
\Zend_Gdata_Photos_Extension_Nickname The element being modified.
methodpublicsetGphotoQuotaCurrent( string $value ) : \Zend_Gdata_Photos_Extension_QuotaCurrent

Set the value for this element's gphoto:quotacurrent attribute.

Parameters
Name Type Description
$value string

The desired value for this attribute.

Returns
Type Description
\Zend_Gdata_Photos_Extension_QuotaCurrent The element being modified.
methodpublicsetGphotoQuotaLimit( string $value ) : \Zend_Gdata_Photos_Extension_QuotaLimit

Set the value for this element's gphoto:quotalimit attribute.

Parameters
Name Type Description
$value string

The desired value for this attribute.

Returns
Type Description
\Zend_Gdata_Photos_Extension_QuotaLimit The element being modified.
methodpublicsetGphotoThumbnail( string $value ) : \Zend_Gdata_Photos_Extension_Thumbnail

Set the value for this element's gphoto:thumbnail attribute.

Parameters
Name Type Description
$value string

The desired value for this attribute.

Returns
Type Description
\Zend_Gdata_Photos_Extension_Thumbnail The element being modified.
methodpublicsetGphotoUser( string $value ) : \Zend_Gdata_Photos_Extension_User

Set the value for this element's gphoto:user attribute.

Parameters
Name Type Description
$value string

The desired value for this attribute.

Returns
Type Description
\Zend_Gdata_Photos_Extension_User The element being modified.
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.