API Documentation

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

\Zend_Gdata_Photos_AlbumQuery

Package: Zend\Gdata\Photos

Assists in constructing album queries for various entries.

Instances of this class can be provided in many places where a URL is required.

For information on submitting queries to a server, see the service class, Zend_Gdata_Photos.

Parent(s)
\Zend_Gdata_Photos_UserQuery < \Zend_Gdata_Query
Children
\Zend_Gdata_Photos_PhotoQuery
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedstring  $_albumId= 'null'

The ID of the album to query for. Mutually exclusive with AlbumName.

Default valuenullDetails
Type
string
Propertyprotectedstring  $_albumName= 'null'

The name of the album to query for. Mutually exclusive with AlbumId.

Default valuenullDetails
Type
string

Methods

methodpublicgetAlbumId( ) : string

Get the album ID which is to be returned.

Returns
Type Description
string The ID of the album to retrieve.
Details
See
\setAlbum  
methodpublicgetAlbumName( ) : string

Get the album name which is to be returned.

Returns
Type Description
string The name of the album to retrieve.
Details
See
\setAlbumName  
methodpublicgetQueryUrl(  $incomingUri = '' ) : string

Returns the URL generated for this query, based on it's current parameters.

Parameters
Name Type Description
$incomingUri
Returns
Type Description
string A URL generated based on the state of this query.
Throws
Exception Description
\Zend_Gdata_App_InvalidArgumentException
methodpublicsetAlbumId( string $value ) : \Zend_Gdata_Photos_AlbumQuery

Set the album ID to query for. When set, this album's photographs be returned. If not set or null, the default user's feed will be returned instead.

NOTE: Album and AlbumId are mutually exclusive. Setting one will automatically set the other to null.

Parameters
Name Type Description
$value string

The ID of the album to retrieve, or null to clear.

Returns
Type Description
\Zend_Gdata_Photos_AlbumQuery The query object.
methodpublicsetAlbumName( string $value ) : \Zend_Gdata_Photos_AlbumQuery

Set the album name to query for. When set, this album's photographs be returned. If not set or null, the default user's feed will be returned instead.

NOTE: AlbumName and AlbumId are mutually exclusive. Setting one will automatically set the other to null.

Parameters
Name Type Description
$value string

The name of the album to retrieve, or null to clear.

Returns
Type Description
\Zend_Gdata_Photos_AlbumQuery The query object.
Documentation was generated by DocBlox 0.15.1.