Zend/Gdata/Photos/AlbumQuery.php

Show:

inherited

Classes
- \Zend_Gdata_Photos_AlbumQuery

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

\Zend_Gdata_Photos_AlbumQuery
jump to top

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

string
                 $_albumId= 'null'

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

Default valuenullDetails

Type: string

string
                 $_albumName= 'null'

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

Default valuenullDetails

Type: string

Methods

getAlbumId(
          
          )
        
        :
          string

Get the album ID which is to be returned.

Returns

Type	Description
string	The ID of the album to retrieve.

Details

See: \setAlbum

getAlbumName(
          
          )
        
        :
          string

Get the album name which is to be returned.

Returns

Type	Description
string	The name of the album to retrieve.

Details

See: \setAlbumName

getQueryUrl(
           $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

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

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

API Documentation

Zend/Gdata/Photos/AlbumQuery.php

\Zend_Gdata_Photos_AlbumQueryjump to top

Properties

Methods

\Zend_Gdata_Photos_AlbumQuery
jump to top