API Documentation

Zend/Gdata/Photos/PhotoQuery.php

Show: inherited
Table of Contents

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: PhotoQuery.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Gdata_Photos_PhotoQuery

Package: Zend\Gdata\Photos

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.

Parent(s)
\Zend_Gdata_Photos_AlbumQuery < \Zend_Gdata_Photos_UserQuery < \Zend_Gdata_Query
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedstring  $_photoId= 'null'

The ID of the photo to query for.

Default valuenullDetails
Type
string

Methods

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

Documentation was generated by DocBlox 0.15.1.