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

__construct( ) : void
Create a new Query object with default values.
Inherited from: \Zend_Gdata_Photos_UserQuery::__construct()
__get( $name ) : void
Name | Type | Description |
---|---|---|
$name |

__set( $name, $val ) : void
Name | Type | Description |
---|---|---|
$name | ||
$val |

getAccess( ) : string
Get the visibility filter for entries returned.
Inherited from: \Zend_Gdata_Photos_UserQuery::getAccess()Type | Description |
---|---|
string | The visibility to filter by, or null for the default user. |

getAlbumId( ) : string
Get the album ID which is to be returned.
Inherited from: \Zend_Gdata_Photos_AlbumQuery::getAlbumId()Type | Description |
---|---|
string | The ID of the album to retrieve. |

getAlbumName( ) : string
Get the album name which is to be returned.
Inherited from: \Zend_Gdata_Photos_AlbumQuery::getAlbumName()Type | Description |
---|---|
string | The name of the album to retrieve. |

getAlt( ) : string
Type | Description |
---|---|
string | rss or atom |

getAuthor( ) : string
Type | Description |
---|---|
string | author |

getImgMax( ) : string
Get the maximum image size filter for entries returned.
Inherited from: \Zend_Gdata_Photos_UserQuery::getImgMax()Type | Description |
---|---|
string | The image size size to filter by, or null if no filter is to be applied. |

getKind( ) : string
Get the kind of entries to be returned.
Inherited from: \Zend_Gdata_Photos_UserQuery::getKind()Type | Description |
---|---|
string | The kind to filter by, or null if no filter is to be applied. |

getMaxResults( ) : int
Type | Description |
---|---|
int | maxResults |

getParam( string $name ) : void
Name | Type | Description |
---|---|---|
$name | string |

getPhotoId( ) : string
Get the photo ID which is to be returned.
Type | Description |
---|---|
string | The ID of the photo to retrieve. |

getProjection( ) : string
Gets the format of data in returned in Atom feeds.
Inherited from: \Zend_Gdata_Photos_UserQuery::getProjection()Type | Description |
---|---|
string | projection |

getPublishedMax( ) : string
Type | Description |
---|---|
string | publishedMax |

getPublishedMin( ) : string
Type | Description |
---|---|
string | publishedMin |

getQuery( ) : string
Type | Description |
---|---|
string | query |

getQueryString( ) : string
Type | Description |
---|---|
string | querystring |

getQueryUrl( $incomingUri ) : string
Returns the URL generated for this query, based on it's current parameters.
Name | Type | Description |
---|---|---|
$incomingUri |
Type | Description |
---|---|
string | A URL generated based on the state of this query. |
Exception | Description |
---|---|
\Zend_Gdata_App_InvalidArgumentException |

getStartIndex( ) : int
Type | Description |
---|---|
int | startIndex |

getTag( ) : string
Get the tag filter for entries returned.
Inherited from: \Zend_Gdata_Photos_UserQuery::getTag()Type | Description |
---|---|
string | The tag to filter by, or null if no filter is to be applied. |

getThumbsize( ) : string
Get the thumbnail size filter for entries returned.
Inherited from: \Zend_Gdata_Photos_UserQuery::getThumbsize()Type | Description |
---|---|
string | The thumbnail size to filter by, or null if no filter is to be applied. |

getType( ) : string
Gets the type of data in returned in queries.
Inherited from: \Zend_Gdata_Photos_UserQuery::getType()Type | Description |
---|---|
string | type |

getUpdatedMax( ) : string
Type | Description |
---|---|
string | updatedMax |

getUpdatedMin( ) : string
Type | Description |
---|---|
string | updatedMin |

getUser( ) : string
Get the user which is to be returned.
Inherited from: \Zend_Gdata_Photos_UserQuery::getUser()Type | Description |
---|---|
string | The visibility to retrieve. |

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

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.
Inherited from: \Zend_Gdata_Photos_AlbumQuery::setAlbumId()NOTE: Album and AlbumId are mutually exclusive. Setting one will automatically set the other to null.
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_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.
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. |

setAlt( string $value ) : \Zend_Gdata_Query
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Gdata_Query | Provides a fluent interface |

setAuthor( string $value ) : \Zend_Gdata_Query
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Gdata_Query | Provides a fluent interface |

setCategory( string $value ) : \Zend_Gdata_Query
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Gdata_Query | Provides a fluent interface |

setImgMax( 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.
Name | Type | Description |
---|---|---|
$value | string | The image size to filter by, or null if no filter is to be applied. |

setKind( 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.
Name | Type | Description |
---|---|---|
$value | string | The kind to filter by, or null if no filter is to be applied. |

setMaxResults( int $value ) : \Zend_Gdata_Query
Name | Type | Description |
---|---|---|
$value | int |
Type | Description |
---|---|
\Zend_Gdata_Query | Provides a fluent interface |

setParam( string $name, string $value ) : \Zend_Gdata_Query
Name | Type | Description |
---|---|---|
$name | string | |
$value | string |
Type | Description |
---|---|
\Zend_Gdata_Query | Provides a fluent interface |

setPhotoId( 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.
Name | Type | Description |
---|---|---|
$value | string | The ID of the photo to retrieve, or null to clear. |

setProjection( 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()Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Gdata_Photos_UserQuery | Provides a fluent interface |

setPublishedMax( string $value ) : \Zend_Gdata_Query
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Gdata_Query | Provides a fluent interface |

setPublishedMin( string $value ) : \Zend_Gdata_Query
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Gdata_Query | Provides a fluent interface |

setQuery( string $value ) : \Zend_Gdata_Query
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Gdata_Query | Provides a fluent interface |

setStartIndex( int $value ) : \Zend_Gdata_Query
Name | Type | Description |
---|---|---|
$value | int |
Type | Description |
---|---|
\Zend_Gdata_Query | Provides a fluent interface |

setTag( 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.
Name | Type | Description |
---|---|---|
$value | string | The tag to filter by, or null if no filter is to be applied. |

setThumbsize( 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.
Name | Type | Description |
---|---|---|
$value | string | The thumbnail size to filter by, or null if no filter is to be applied. |

setType( 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()Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Gdata_Photos_UserQuery | Provides a fluent interface |

setUpdatedMax( string $value ) : \Zend_Gdata_Query
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Gdata_Query | Provides a fluent interface |

setUpdatedMin( string $value ) : \Zend_Gdata_Query
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Gdata_Query | Provides a fluent interface |

setUser( 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()Name | Type | Description |
---|---|---|
$value | string | The user to retrieve, or null for the default user. |