Gdata/Photos/AlbumQuery.php
Show:
inherited
inherited
Classes
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-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Gdata
- Subpackage
- Photos
- Version
- $Id$
\Zend_Gdata_Photos_AlbumQuery
Package: Zend_Gdata\Photos
Returns
Returns
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-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
Methods
getAlbumId() : stringGet the album ID which is to be returned.
getAlbumName() : stringGet the album name which is to be returned.
getQueryUrl( $incomingUri = '') : stringReturns the URL generated for this query, based on it's current parameters.
Parameters
Returns
Throws
| Name | Type | Description |
|---|---|---|
| $incomingUri |
| Type | Description |
|---|---|
| string | A URL generated based on the state of this query. |
| Exception | Description |
|---|---|
| \Zend_Gdata_App_InvalidArgumentException |
setAlbumId(string $value) : \Zend_Gdata_Photos_AlbumQuerySet 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. |
| Type | Description |
|---|---|
| \Zend_Gdata_Photos_AlbumQuery | The query object. |
setAlbumName(string $value) : \Zend_Gdata_Photos_AlbumQuerySet 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. |
| Type | Description |
|---|---|
| \Zend_Gdata_Photos_AlbumQuery | The query object. |