Gdata/Photos/UserQuery.php

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: UserQuery.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Gdata_Photos_UserQuery

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_UserQuery
jump to top

Extends from: Zend_Gdata_Query
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: $_projection; $_type; $_user
Methods: __construct; setProjection; getProjection; setType; getType; setUser; getUser; setAccess; getAccess; setTag; getTag; setKind; getKind; setImgMax; getImgMax; setThumbsize; getThumbsize; getQueryUrl

Description

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

Properties

$_projection
jump to class

string $_projection = 'api'

Indicates the format of data returned in Atom feeds. Can be either 'api' or 'base'. Default value is 'api'.

Details

$_projection: string
visibility: protected
default: api
final: false
static: false

$_type
jump to class

string $_type = 'feed'

Indicates whether to request a feed or entry in queries. Default value is 'feed';

Details

$_type: string
visibility: protected
default: feed
final: false
static: false

$_user
jump to class

string $_user = 'Zend_Gdata_Photos'

A string which, if not null, indicates which user should be retrieved by this query. If null, the default user will be used instead.

Details

$_user: string
visibility: protected
default: Zend_Gdata_Photos
final: false
static: false

Methods

__construct
jump to class

__construct(
          
          )
        
        :

Create a new Query object with default values.

Details

visibility: public
final: false
static: false

getAccess
jump to class

getAccess(
          
          )
        
        :
        string

Get the visibility filter for entries returned.

Output

string: The visibility to filter by, or null for the default user.

Details

visibility: public
final: false
static: false
see: setAccess

getImgMax
jump to class

getImgMax(
          
          )
        
        :
        string

Get the maximum image size filter for entries returned.

Output

string: The image size size to filter by, or null if no filter is to be applied.

Details

visibility: public
final: false
static: false
see: setImgMax

getKind
jump to class

getKind(
          
          )
        
        :
        string

Get the kind of entries to be returned.

Output

string: The kind to filter by, or null if no filter is to be applied.

Details

visibility: public
final: false
static: false
see: setKind

getProjection
jump to class

getProjection(
          
          )
        
        :
        string

Gets the format of data in returned in Atom feeds.

Output

string: projection

Details

visibility: public
final: false
static: false
see: setProjection

getQueryUrl
jump to class

getQueryUrl(
           $incomingUri
              =
              null
          )
        
        :
        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

getTag
jump to class

getTag(
          
          )
        
        :
        string

Get the tag filter for entries returned.

Output

string: The tag to filter by, or null if no filter is to be applied.

Details

visibility: public
final: false
static: false
see: setTag

getThumbsize
jump to class

getThumbsize(
          
          )
        
        :
        string

Get the thumbnail size filter for entries returned.

Output

string: The thumbnail size to filter by, or null if no filter is to be applied.

Details

visibility: public
final: false
static: false
see: setThumbsize

getType
jump to class

getType(
          
          )
        
        :
        string

Gets the type of data in returned in queries.

Output

string: type

Details

visibility: public
final: false
static: false
see: setType

getUser
jump to class

getUser(
          
          )
        
        :
        string

Get the user which is to be returned.

Output

string: The visibility to retrieve.

Details

visibility: public
final: false
static: false
see: setUser

setAccess
jump to class

setAccess(
          string $value
          )
        
        :

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

Arguments

$value: string
The visibility to filter by, or null to use the default value.

Details

visibility: public
final: false
static: false

setImgMax
jump to class

setImgMax(
          string $value
          )
        
        :

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.

Arguments

$value: string
The image size to filter by, or null if no filter is to be applied.

Details

visibility: public
final: false
static: false

setKind
jump to class

setKind(
          string $value
          )
        
        :

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.

Arguments

$value: string
The kind to filter by, or null if no filter is to be applied.

Details

visibility: public
final: false
static: false

setProjection
jump to class

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

Arguments

$value: string

Output

Zend_Gdata_Photos_UserQuery: Provides a fluent interface

Details

visibility: public
final: false
static: false

setTag
jump to class

setTag(
          string $value
          )
        
        :

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.

Arguments

$value: string
The tag to filter by, or null if no filter is to be applied.

Details

visibility: public
final: false
static: false

setThumbsize
jump to class

setThumbsize(
          string $value
          )
        
        :

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.

Arguments

$value: string
The thumbnail size to filter by, or null if no filter is to be applied.

Details

visibility: public
final: false
static: false

setType
jump to class

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

Arguments

$value: string

Output

Zend_Gdata_Photos_UserQuery: Provides a fluent interface

Details

visibility: public
final: false
static: false

setUser
jump to class

setUser(
          string $value
          )
        
        :

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.

Arguments

$value: string
The user to retrieve, or null for the default user.

Details

visibility: public
final: false
static: false

API Documentation

Gdata/Photos/UserQuery.php

Description

Zend_Gdata_Photos_UserQueryjump to top

Description

Properties

$_projectionjump to class

Details

$_typejump to class

Details

$_userjump to class

Details

Methods

__constructjump to class

Details

getAccessjump to class

Output

Details

getImgMaxjump to class

Output

Details

getKindjump to class

Output

Details

getProjectionjump to class

Output

Details

getQueryUrljump to class

Arguments

Output

Details

getTagjump to class

Output

Details

getThumbsizejump to class

Output

Details

getTypejump to class

Output

Details

getUserjump to class

Output

Details

setAccessjump to class

Arguments

Details

setImgMaxjump to class

Arguments

Details

setKindjump to class

Arguments

Details

setProjectionjump to class

Arguments

Output

Details

setTagjump to class

Arguments

Details

setThumbsizejump to class

Arguments

Details

setTypejump to class

Arguments

Output

Details

setUserjump to class

Arguments

Details

Zend_Gdata_Photos_UserQuery
jump to top

$_projection
jump to class

$_type
jump to class

$_user
jump to class

__construct
jump to class

getAccess
jump to class

getImgMax
jump to class

getKind
jump to class

getProjection
jump to class

getQueryUrl
jump to class

getTag
jump to class

getThumbsize
jump to class

getType
jump to class

getUser
jump to class

setAccess
jump to class

setImgMax
jump to class

setKind
jump to class

setProjection
jump to class

setTag
jump to class

setThumbsize
jump to class

setType
jump to class

setUser
jump to class