API Documentation

Gdata/Photos/PhotoQuery.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Gdata  
subpackage
Photos  
version
$Id: PhotoQuery.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Gdata_Photos_PhotoQuery

Assists in constructing queries for comment/tag 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.

Extends from
\Zend_Gdata_Photos_AlbumQuery
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Gdata  
subpackage
Photos  

Properties

Propertyprotectedstring  $_photoId= 'null'

The ID of the photo to query for.

Default valuenullDetails
Type
string

Methods

methodpublic__construct( ) : void

Create a new Query object with default values.

Inherited from: \Zend_Gdata_Photos_UserQuery::__construct()
methodpublic__get(  $name ) : void

Inherited from: \Zend_Gdata_Query::__get()
Parameters
Name Type Description
$name
methodpublic__set(  $name,  $val ) : void

Inherited from: \Zend_Gdata_Query::__set()
Parameters
Name Type Description
$name
$val
methodpublicgetAccess( ) : string

Get the visibility filter for entries returned.

Inherited from: \Zend_Gdata_Photos_UserQuery::getAccess()
Returns
Type Description
string The visibility to filter by, or null for the default user.
Details
see
\setAccess  
methodpublicgetAlbumId( ) : string

Get the album ID which is to be returned.

Inherited from: \Zend_Gdata_Photos_AlbumQuery::getAlbumId()
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.

Inherited from: \Zend_Gdata_Photos_AlbumQuery::getAlbumName()
Returns
Type Description
string The name of the album to retrieve.
Details
see
\setAlbumName  
methodpublicgetAlt( ) : string

Inherited from: \Zend_Gdata_Query::getAlt()
Returns
Type Description
string rss or atom
methodpublicgetAuthor( ) : string
Returns
Type Description
string author
methodpublicgetCategory( ) : void
methodpublicgetImgMax( ) : string

Get the maximum image size filter for entries returned.

Inherited from: \Zend_Gdata_Photos_UserQuery::getImgMax()
Returns
Type Description
string The image size size to filter by, or null if no filter is to be applied.
Details
see
\setImgMax  
methodpublicgetKind( ) : string

Get the kind of entries to be returned.

Inherited from: \Zend_Gdata_Photos_UserQuery::getKind()
Returns
Type Description
string The kind to filter by, or null if no filter is to be applied.
Details
see
\setKind  
methodpublicgetMaxResults( ) : int
Returns
Type Description
int maxResults
methodpublicgetParam( string $name ) : void
Parameters
Name Type Description
$name string
methodpublicgetPhotoId( ) : string

Get the photo ID which is to be returned.

Returns
Type Description
string The ID of the photo to retrieve.
Details
see
\setPhoto  
methodpublicgetProjection( ) : string

Gets the format of data in returned in Atom feeds.

Inherited from: \Zend_Gdata_Photos_UserQuery::getProjection()
Returns
Type Description
string projection
Details
see
\setProjection  
methodpublicgetPublishedMax( ) : string
Returns
Type Description
string publishedMax
methodpublicgetPublishedMin( ) : string
Returns
Type Description
string publishedMin
methodpublicgetQuery( ) : string
Returns
Type Description
string query
methodpublicgetQueryString( ) : string
Returns
Type Description
string querystring
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
methodpublicgetStartIndex( ) : int
Returns
Type Description
int startIndex
methodpublicgetTag( ) : string

Get the tag filter for entries returned.

Inherited from: \Zend_Gdata_Photos_UserQuery::getTag()
Returns
Type Description
string The tag to filter by, or null if no filter is to be applied.
Details
see
\setTag  
methodpublicgetThumbsize( ) : string

Get the thumbnail size filter for entries returned.

Inherited from: \Zend_Gdata_Photos_UserQuery::getThumbsize()
Returns
Type Description
string The thumbnail size to filter by, or null if no filter is to be applied.
Details
see
\setThumbsize  
methodpublicgetType( ) : string

Gets the type of data in returned in queries.

Inherited from: \Zend_Gdata_Photos_UserQuery::getType()
Returns
Type Description
string type
Details
see
\setType  
methodpublicgetUpdatedMax( ) : string
Returns
Type Description
string updatedMax
methodpublicgetUpdatedMin( ) : string
Returns
Type Description
string updatedMin
methodpublicgetUser( ) : string

Get the user which is to be returned.

Inherited from: \Zend_Gdata_Photos_UserQuery::getUser()
Returns
Type Description
string The visibility to retrieve.
Details
see
\setUser  
methodpublicresetParameters( ) : void
methodpublicsetAccess( string $value ) : void

Set the visibility filter for entries returned. Only entries which match this value will be returned. If null or unset, the default value will be used instead.

Inherited from: \Zend_Gdata_Photos_UserQuery::setAccess()

Valid values are 'all' (default), 'public', and 'private'.

Parameters
Name Type Description
$value string The visibility to filter by, or null to use the default value.
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.

Inherited from: \Zend_Gdata_Photos_AlbumQuery::setAlbumId()

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.

Inherited from: \Zend_Gdata_Photos_AlbumQuery::setAlbumName()

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.
methodpublicsetAlt( string $value ) : \Zend_Gdata_Query

Inherited from: \Zend_Gdata_Query::setAlt()
Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Gdata_Query Provides a fluent interface
methodpublicsetAuthor( string $value ) : \Zend_Gdata_Query
Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Gdata_Query Provides a fluent interface
methodpublicsetCategory( string $value ) : \Zend_Gdata_Query
Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Gdata_Query Provides a fluent interface
methodpublicsetImgMax( string $value ) : void

Set the maximum image size for entries returned. Only entries which match this value will be returned. If null or unset, this filter will not be applied.

Inherited from: \Zend_Gdata_Photos_UserQuery::setImgMax()

See http://code.google.com/apis/picasaweb/reference.html#Parameters for a list of valid values.

Parameters
Name Type Description
$value string The image size to filter by, or null if no filter is to be applied.
methodpublicsetKind( string $value ) : void

Set the kind of entries that are returned. Only entries which match this value will be returned. If null or unset, this filter will not be applied.

Inherited from: \Zend_Gdata_Photos_UserQuery::setKind()

See http://code.google.com/apis/picasaweb/reference.html#Parameters for a list of valid values.

Parameters
Name Type Description
$value string The kind to filter by, or null if no filter is to be applied.
methodpublicsetMaxResults( int $value ) : \Zend_Gdata_Query
Parameters
Name Type Description
$value int
Returns
Type Description
\Zend_Gdata_Query Provides a fluent interface
methodpublicsetParam( string $name, string $value ) : \Zend_Gdata_Query
Parameters
Name Type Description
$name string
$value string
Returns
Type Description
\Zend_Gdata_Query Provides a fluent interface
methodpublicsetPhotoId( string $value ) : void

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

Parameters
Name Type Description
$value string The ID of the photo to retrieve, or null to clear.
methodpublicsetProjection( string $value ) : \Zend_Gdata_Photos_UserQuery

Set's the format of data returned in Atom feeds. Can be either 'api' or 'base'. Normally, 'api' will be desired. Default is 'api'.

Inherited from: \Zend_Gdata_Photos_UserQuery::setProjection()
Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Gdata_Photos_UserQuery Provides a fluent interface
methodpublicsetPublishedMax( string $value ) : \Zend_Gdata_Query
Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Gdata_Query Provides a fluent interface
methodpublicsetPublishedMin( string $value ) : \Zend_Gdata_Query
Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Gdata_Query Provides a fluent interface
methodpublicsetQuery( string $value ) : \Zend_Gdata_Query
Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Gdata_Query Provides a fluent interface
methodpublicsetStartIndex( int $value ) : \Zend_Gdata_Query
Parameters
Name Type Description
$value int
Returns
Type Description
\Zend_Gdata_Query Provides a fluent interface
methodpublicsetTag( string $value ) : void

Set the tag for entries that are returned. Only entries which match this value will be returned. If null or unset, this filter will not be applied.

Inherited from: \Zend_Gdata_Photos_UserQuery::setTag()

See http://code.google.com/apis/picasaweb/reference.html#Parameters for a list of valid values.

Parameters
Name Type Description
$value string The tag to filter by, or null if no filter is to be applied.
methodpublicsetThumbsize( string $value ) : void

Set the thumbnail size filter for entries returned. Only entries which match this value will be returned. If null or unset, this filter will not be applied.

Inherited from: \Zend_Gdata_Photos_UserQuery::setThumbsize()

See http://code.google.com/apis/picasaweb/reference.html#Parameters for a list of valid values.

Parameters
Name Type Description
$value string The thumbnail size to filter by, or null if no filter is to be applied.
methodpublicsetType( string $value ) : \Zend_Gdata_Photos_UserQuery

Set's the type of data returned in queries. Can be either 'feed' or 'entry'. Normally, 'feed' will be desired. Default is 'feed'.

Inherited from: \Zend_Gdata_Photos_UserQuery::setType()
Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Gdata_Photos_UserQuery Provides a fluent interface
methodpublicsetUpdatedMax( string $value ) : \Zend_Gdata_Query
Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Gdata_Query Provides a fluent interface
methodpublicsetUpdatedMin( string $value ) : \Zend_Gdata_Query
Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Gdata_Query Provides a fluent interface
methodpublicsetUser( string $value ) : void

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

Inherited from: \Zend_Gdata_Photos_UserQuery::setUser()
Parameters
Name Type Description
$value string The user to retrieve, or null for the default user.
Documentation was generated by DocBlox 0.13.3.