API Documentation

Zend/Gdata/Photos/AlbumEntry.php

Show:

inherited

Classes
- \Zend_Gdata_Photos_AlbumEntry

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

\Zend_Gdata_Photos_AlbumEntry
jump to top

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


                 $_entryClassName= ''Zend_Gdata_Photos_AlbumEntry''

Default value'Zend_Gdata_Photos_AlbumEntry'Details

Type

\Zend_Gdata_Geo_Extension_GeoRssWhere
                 $_geoRssWhere= 'null'

georss:where element

Default valuenullDetails

Type: \Zend_Gdata_Geo_Extension_GeoRssWhere

\Zend_Gdata_Photos_Extension_Access
                 $_gphotoAccess= 'null'

gphoto:access element

Default valuenullDetails

Type: \Zend_Gdata_Photos_Extension_Access

\Zend_Gdata_Photos_Extension_CommentCount
                 $_gphotoCommentCount= 'null'

gphoto:commentCount element

Default valuenullDetails

Type: \Zend_Gdata_Photos_Extension_CommentCount

\Zend_Gdata_Photos_Extension_CommentingEnabled
                 $_gphotoCommentingEnabled= 'null'

gphoto:commentingEnabled element

Default valuenullDetails

Type: \Zend_Gdata_Photos_Extension_CommentingEnabled

\Zend_Gdata_Photos_Extension_Id
                 $_gphotoId= 'null'

gphoto:id element

Default valuenullDetails

Type: \Zend_Gdata_Photos_Extension_Id

\Zend_Gdata_Photos_Extension_Location
                 $_gphotoLocation= 'null'

gphoto:location element

Default valuenullDetails

Type: \Zend_Gdata_Photos_Extension_Location

\Zend_Gdata_Photos_Extension_Name
                 $_gphotoName= 'null'

gphoto:name element

Default valuenullDetails

Type: \Zend_Gdata_Photos_Extension_Name

\Zend_Gdata_Photos_Extension_Nickname
                 $_gphotoNickname= 'null'

gphoto:nickname element

Default valuenullDetails

Type: \Zend_Gdata_Photos_Extension_Nickname

\Zend_Gdata_Photos_Extension_NumPhotos
                 $_gphotoNumPhotos= 'null'

gphoto:numphotos element

Default valuenullDetails

Type: \Zend_Gdata_Photos_Extension_NumPhotos

\Zend_Gdata_Photos_Extension_Timestamp
                 $_gphotoTimestamp= 'null'

gphoto:timestamp element

Default valuenullDetails

Type: \Zend_Gdata_Photos_Extension_Timestamp

\Zend_Gdata_Photos_Extension_User
                 $_gphotoUser= 'null'

gphoto:user element

Default valuenullDetails

Type: \Zend_Gdata_Photos_Extension_User

\Zend_Gdata_Media_MediaGroup
                 $_mediaGroup= 'null'

media:group element

Default valuenullDetails

Type: \Zend_Gdata_Media_MediaGroup

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.

getGeoRssWhere(
          
          )
        
        :
          string

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

Returns

Type	Description
string	The requested attribute.

Details

See: \setGeoRssWhere

getGphotoAccess(
          
          )
        
        :
          string

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

Returns

Type	Description
string	The requested attribute.

Details

See: \setGphotoAccess

getGphotoCommentCount(
          
          )
        
        :
          string

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

Returns

Type	Description
string	The requested attribute.

Details

See: \setGphotoCommentCount

getGphotoCommentingEnabled(
          
          )
        
        :
          string

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

Returns

Type	Description
string	The requested attribute.

Details

See: \setGphotoCommentingEnabled

getGphotoId(
          
          )
        
        :
          string

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

Returns

Type	Description
string	The requested attribute.

Details

See: \setGphotoId

getGphotoLocation(
          
          )
        
        :
          string

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

Returns

Type	Description
string	The requested attribute.

Details

See: \setGphotoLocation

getGphotoName(
          
          )
        
        :
          string

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

Returns

Type	Description
string	The requested attribute.

Details

See: \setGphotoName

getGphotoNickname(
          
          )
        
        :
          string

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

Returns

Type	Description
string	The requested attribute.

Details

See: \setGphotoNickname

getGphotoNumPhotos(
          
          )
        
        :
          string

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

Returns

Type	Description
string	The requested attribute.

Details

See: \setGphotoNumPhotos

getGphotoTimestamp(
          
          )
        
        :
          string

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

Returns

Type	Description
string	The requested attribute.

Details

See: \setGphotoTimestamp

getGphotoUser(
          
          )
        
        :
          string

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

Returns

Type	Description
string	The requested attribute.

Details

See: \setGphotoUser

getMediaGroup(
          
          )
        
        :
          string

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

Returns

Type	Description
string	The requested attribute.

Details

See: \setMediaGroup

setGeoRssWhere(
          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.

setGphotoAccess(
          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.

setGphotoCommentCount(
          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.

setGphotoCommentingEnabled(
          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.

setGphotoId(
          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.

setGphotoLocation(
          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.

setGphotoName(
          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.

setGphotoNickname(
          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.

setGphotoNumPhotos(
          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.

setGphotoTimestamp(
          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.

setGphotoUser(
          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.

setMediaGroup(
          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.

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