API Documentation

Gdata/Photos/AlbumQuery.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Gdata
subpackage
Photos
version
$Id: AlbumQuery.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Gdata_Photos_AlbumQuery

Description

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.

Zend_Gdata_Photos_AlbumQuery
jump to top

Extends from
Zend_Gdata_Photos_UserQuery
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Gdata
subpackage
Photos
Properties
$_albumName
$_albumId
Methods
setAlbumName
getAlbumName
setAlbumId
getAlbumId
getQueryUrl

Description

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.

Properties

$_albumId
jump to class

string $_albumId = 'null'

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

Details

$_albumId
string
visibility
protected
default
null
final
false
static
false

$_albumName
jump to class

string $_albumName = 'null'

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

Details

$_albumName
string
visibility
protected
default
null
final
false
static
false

Methods

getAlbumId
jump to class

getAlbumId( ) : string

Get the album ID which is to be returned.

Output
string
The ID of the album to retrieve.
Details
visibility
public
final
false
static
false
see
setAlbum

getAlbumName
jump to class

getAlbumName( ) : string

Get the album name which is to be returned.

Output
string
The name of the album to retrieve.
Details
visibility
public
final
false
static
false
see
setAlbumName

getQueryUrl
jump to class

getQueryUrl(  $incomingUri ) : string

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

Arguments
$incomingUri
Output
string
A URL generated based on the state of this query.
Details
visibility
public
final
false
static
false
throws

setAlbumId
jump to class

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.

Arguments
$value
string
The ID of the album to retrieve, or null to clear.
Output
Zend_Gdata_Photos_AlbumQuery
The query object.
Details
visibility
public
final
false
static
false

setAlbumName
jump to class

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.

Arguments
$value
string
The name of the album to retrieve, or null to clear.
Output
Zend_Gdata_Photos_AlbumQuery
The query object.
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.