Gdata/Photos/UserQuery.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-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Gdata
- Subpackage
- Photos
- Version
- $Id: UserQuery.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Gdata_Photos_UserQuery
Package: Zend\Gdata\PhotosAssists in constructing queries for user 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_Query
- Children
- \Zend_Gdata_Photos_AlbumQuery
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties



string $_projection = 'api'
Indicates the format of data returned in Atom feeds.
Can be either
'api' or 'base'. Default value is 'api'.
Default value'api'
Details- Type
- string



string $_user = \Zend_Gdata_Photos::DEFAULT_USER
A string which, if not null, indicates which user should
be retrieved by this query.
If null, the default user will be used
instead.
Default value\Zend_Gdata_Photos::DEFAULT_USER
Details- Type
- string
Methods



getAccess() : string
Get the visibility filter for entries returned.
ReturnsType | Description |
---|
string | The visibility to filter by, or null for the default
user. |
Details- See
- \setAccess



getImgMax() : string
Get the maximum image size filter for entries returned.
ReturnsType | Description |
---|
string | The image size size to filter by, or null if no filter
is to be applied. |
Details- See
- \setImgMax



getKind() : string
Get the kind of entries to be returned.
ReturnsType | Description |
---|
string | The kind to filter by, or null if no filter
is to be applied. |
Details- See
- \setKind



getProjection() : string
Gets the format of data in returned in Atom feeds.
ReturnsType | Description |
---|
string | projection |
Details- See
- \setProjection



getQueryUrl( $incomingUri = null) : string
Returns the URL generated for this query, based on it's current
parameters.
ParametersName | Type | Description |
---|
$incomingUri | | |
---|
ReturnsType | Description |
---|
string | A URL generated based on the state of this query. |
Throws 


getTag() : string
Get the tag filter for entries returned.
ReturnsType | Description |
---|
string | The tag to filter by, or null if no filter
is to be applied. |
Details- See
- \setTag



getThumbsize() : string
Get the thumbnail size filter for entries returned.
ReturnsType | Description |
---|
string | The thumbnail size to filter by, or null if no filter
is to be applied. |
Details- See
- \setThumbsize



getType() : string
Gets the type of data in returned in queries.
ReturnsType | Description |
---|
string | type |
Details- See
- \setType



getUser() : string
Get the user which is to be returned.
ReturnsType | Description |
---|
string | The visibility to retrieve. |
Details- See
- \setUser



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.
Valid values are 'all' (default), 'public', and 'private'.
ParametersName | Type | Description |
---|
$value | string | The visibility to filter by, or null to use the
default value. |
---|



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.
See http://code.google.com/apis/picasaweb/reference.html#Parameters
for a list of valid values.
ParametersName | 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.
See http://code.google.com/apis/picasaweb/reference.html#Parameters
for a list of valid values.
ParametersName | Type | Description |
---|
$value | string | The kind to filter by, or null if no
filter is to be applied. |
---|



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'.
ParametersName | Type | Description |
---|
$value | string | |
---|
Returns


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.
See http://code.google.com/apis/picasaweb/reference.html#Parameters
for a list of valid values.
ParametersName | 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.
See http://code.google.com/apis/picasaweb/reference.html#Parameters
for a list of valid values.
ParametersName | 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'.
ParametersName | Type | Description |
---|
$value | string | |
---|
Returns


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