API Documentation

Zend/Gdata/Photos/AlbumEntry.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: AlbumEntry.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Gdata_Photos_AlbumEntry

Package: Zend\Gdata\Photos

Data model class for a Photo Album 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_AlbumEntry''
Default value'Zend_Gdata_Photos_AlbumEntry'Details
Type
Propertyprotected\Zend_Gdata_Geo_Extension_GeoRssWhere  $_geoRssWhere= 'null'

georss:where element

Default valuenullDetails
Type
\Zend_Gdata_Geo_Extension_GeoRssWhere
Propertyprotected\Zend_Gdata_Photos_Extension_Access  $_gphotoAccess= 'null'

gphoto:access element

Default valuenullDetails
Type
\Zend_Gdata_Photos_Extension_Access
Propertyprotected\Zend_Gdata_Photos_Extension_CommentCount  $_gphotoCommentCount= 'null'

gphoto:commentCount element

Default valuenullDetails
Type
\Zend_Gdata_Photos_Extension_CommentCount
Propertyprotected\Zend_Gdata_Photos_Extension_CommentingEnabled  $_gphotoCommentingEnabled= 'null'

gphoto:commentingEnabled element

Default valuenullDetails
Type
\Zend_Gdata_Photos_Extension_CommentingEnabled
Propertyprotected\Zend_Gdata_Photos_Extension_Id  $_gphotoId= 'null'

gphoto:id element

Default valuenullDetails
Type
\Zend_Gdata_Photos_Extension_Id
Propertyprotected\Zend_Gdata_Photos_Extension_Location  $_gphotoLocation= 'null'

gphoto:location element

Default valuenullDetails
Type
\Zend_Gdata_Photos_Extension_Location
Propertyprotected\Zend_Gdata_Photos_Extension_Name  $_gphotoName= 'null'

gphoto:name element

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

gphoto:nickname element

Default valuenullDetails
Type
\Zend_Gdata_Photos_Extension_Nickname
Propertyprotected\Zend_Gdata_Photos_Extension_NumPhotos  $_gphotoNumPhotos= 'null'

gphoto:numphotos element

Default valuenullDetails
Type
\Zend_Gdata_Photos_Extension_NumPhotos
Propertyprotected\Zend_Gdata_Photos_Extension_Timestamp  $_gphotoTimestamp= 'null'

gphoto:timestamp element

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

gphoto:user element

Default valuenullDetails
Type
\Zend_Gdata_Photos_Extension_User
Propertyprotected\Zend_Gdata_Media_MediaGroup  $_mediaGroup= 'null'

media:group element

Default valuenullDetails
Type
\Zend_Gdata_Media_MediaGroup

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

Get the value for this element's georss:where attribute.

Returns
Type Description
string The requested attribute.
Details
See
\setGeoRssWhere  
methodpublicgetGphotoAccess( ) : string

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

Returns
Type Description
string The requested attribute.
Details
See
\setGphotoAccess  
methodpublicgetGphotoCommentCount( ) : string

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

Returns
Type Description
string The requested attribute.
Details
See
\setGphotoCommentCount  
methodpublicgetGphotoCommentingEnabled( ) : string

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

Returns
Type Description
string The requested attribute.
Details
See
\setGphotoCommentingEnabled  
methodpublicgetGphotoId( ) : string

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

Returns
Type Description
string The requested attribute.
Details
See
\setGphotoId  
methodpublicgetGphotoLocation( ) : string

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

Returns
Type Description
string The requested attribute.
Details
See
\setGphotoLocation  
methodpublicgetGphotoName( ) : string

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

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

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

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

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

Returns
Type Description
string The requested attribute.
Details
See
\setGphotoNumPhotos  
methodpublicgetGphotoTimestamp( ) : string

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

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

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

Returns
Type Description
string The requested attribute.
Details
See
\setGphotoUser  
methodpublicgetMediaGroup( ) : string

Get the value for this element's media:group attribute.

Returns
Type Description
string The requested attribute.
Details
See
\setMediaGroup  
methodpublicsetGeoRssWhere( string $value ) : \Zend_Gdata_Geo_Extension_GeoRssWhere

Set the value for this element's georss:where attribute.

Parameters
Name Type Description
$value string

The desired value for this attribute.

Returns
Type Description
\Zend_Gdata_Geo_Extension_GeoRssWhere The element being modified.
methodpublicsetGphotoAccess( string $value ) : \Zend_Gdata_Photos_Extension_Access

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

Parameters
Name Type Description
$value string

The desired value for this attribute.

Returns
Type Description
\Zend_Gdata_Photos_Extension_Access The element being modified.
methodpublicsetGphotoCommentCount( string $value ) : \Zend_Gdata_Photos_Extension_CommentCount

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

Parameters
Name Type Description
$value string

The desired value for this attribute.

Returns
Type Description
\Zend_Gdata_Photos_Extension_CommentCount The element being modified.
methodpublicsetGphotoCommentingEnabled( string $value ) : \Zend_Gdata_Photos_Extension_CommentingEnabled

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

Parameters
Name Type Description
$value string

The desired value for this attribute.

Returns
Type Description
\Zend_Gdata_Photos_Extension_CommentingEnabled The element being modified.
methodpublicsetGphotoId( string $value ) : \Zend_Gdata_Photos_Extension_Id

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

Parameters
Name Type Description
$value string

The desired value for this attribute.

Returns
Type Description
\Zend_Gdata_Photos_Extension_Id The element being modified.
methodpublicsetGphotoLocation( string $value ) : \Zend_Gdata_Photos_Extension_Location

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

Parameters
Name Type Description
$value string

The desired value for this attribute.

Returns
Type Description
\Zend_Gdata_Photos_Extension_Location The element being modified.
methodpublicsetGphotoName( string $value ) : \Zend_Gdata_Photos_Extension_Name

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

Parameters
Name Type Description
$value string

The desired value for this attribute.

Returns
Type Description
\Zend_Gdata_Photos_Extension_Name 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.
methodpublicsetGphotoNumPhotos( string $value ) : \Zend_Gdata_Photos_Extension_NumPhotos

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

Parameters
Name Type Description
$value string

The desired value for this attribute.

Returns
Type Description
\Zend_Gdata_Photos_Extension_NumPhotos The element being modified.
methodpublicsetGphotoTimestamp( string $value ) : \Zend_Gdata_Photos_Extension_Timestamp

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

Parameters
Name Type Description
$value string

The desired value for this attribute.

Returns
Type Description
\Zend_Gdata_Photos_Extension_Timestamp 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.
methodpublicsetMediaGroup( string $value ) : \Zend_Gdata_Media_Extension_MediaGroup

Set the value for this element's media:group attribute.

Parameters
Name Type Description
$value string

The desired value for this attribute.

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