Service/Flickr.php

Show:

inherited

Classes
- \Zend_Service_Flickr

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 [email protected] so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Service
Subpackage: Flickr
Version: $Id$

\Zend_Service_Flickr
jump to top

Package: Zend_Service\Flickr

Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Constants

 
                URI_BASE
                = 'http://www.flickr.com'

Base URI for the REST client

Properties

\Zend_Rest_Client $_restClient = null

Reference to REST client object

Default valuenullDetails

Type: \Zend_Rest_Client

string $apiKey

Your Flickr API key

Details

Type: string

Methods

__construct(string $apiKey) : void

Performs object initializations

# Sets up character encoding # Saves the API key

Parameters

Name	Type	Description
$apiKey	string	Your Flickr API key

_checkErrors(\DOMDocument $dom) : void

static

Throws an exception if and only if the response status indicates a failure

Parameters

Name	Type	Description
$dom	\DOMDocument

Throws

Exception	Description
\Zend_Service_Exception

_compareOptions(array $options, array $validOptions) : void

Throws an exception if and only if any user options are invalid

Parameters

Name	Type	Description
$options	array	User options
$validOptions	array	Valid options

Throws

Exception	Description
\Zend_Service_Exception

_prepareOptions(string $method, array $options, array $defaultOptions) : array

Prepare options for the request

Parameters

Name	Type	Description
$method	string	Flickr Method to call
$options	array	User Options
$defaultOptions	array	Default Options

Returns

Type	Description
array	Merged array of user and default/required options

_validateGroupPoolGetPhotos(array $options) : void

Validate Group Search Options

Parameters

Name	Type	Description
$options	array

Throws

Exception	Description
\Zend_Service_Exception

_validateTagSearch(array $options) : void

Validate Tag Search Options

Parameters

Name	Type	Description
$options	array

Throws

Exception	Description
\Zend_Service_Exception

_validateUserSearch(array $options) : void

Validate User Search Options

Parameters

Name	Type	Description
$options	array

Throws

Exception	Description
\Zend_Service_Exception

getIdByEmail(string $email) : string

Utility function to find Flickr User IDs for emails.

(You can only find a user's photo with their NSID.)

Parameters

Name	Type	Description
$email	string	the email

Returns

Type	Description
string	the NSID (userid)

Throws

Exception	Description
\Zend_Service_Exception

getIdByUsername(string $username) : string

Utility function to find Flickr User IDs for usernames.

(You can only find a user's photo with their NSID.)

Parameters

Name	Type	Description
$username	string	the username

Returns

Type	Description
string	the NSID (userid)

Throws

Exception	Description
\Zend_Service_Exception

getImageDetails(string $id) : array

Returns Flickr photo details by for the given photo ID

Parameters

Name	Type	Description
$id	string	the NSID

Returns

Type	Description
array	of Zend_Service_Flickr_Image, details for the specified image

Throws

Exception	Description
\Zend_Service_Exception

getRestClient() : \Zend_Rest_Client

Returns a reference to the REST client, instantiating it if necessary

Returns

Type	Description
\Zend_Rest_Client

groupPoolGetPhotos(string $query, array $options = array()) : \Zend_Service_Flickr_ResultSet

Finds photos in a group's pool.

Parameters

Name	Type	Description
$query	string	group id
$options	array	Additional parameters to refine your query.

Returns

Type	Description
\Zend_Service_Flickr_ResultSet

Throws

Exception	Description
\Zend_Service_Exception

tagSearch(string | array $query, array $options = array()) : \Zend_Service_Flickr_ResultSet

Find Flickr photos by tag.

Query options include: # per_page: how many results to return per query # page: the starting page offset. first result will be (page - 1) * per_page + 1 # tag_mode: Either 'any' for an OR combination of tags, or 'all' for an AND combination. Default is 'any'. # min_upload_date: Minimum upload date to search on. Date should be a unix timestamp. # max_upload_date: Maximum upload date to search on. Date should be a unix timestamp. # min_taken_date: Minimum upload date to search on. Date should be a MySQL datetime. # max_taken_date: Maximum upload date to search on. Date should be a MySQL datetime.

Parameters

Name	Type	Description
$query	string \| array	A single tag or an array of tags.
$options	array	Additional parameters to refine your query.

Returns

Type	Description
\Zend_Service_Flickr_ResultSet

Throws

Exception	Description
\Zend_Service_Exception

userSearch(string $query, array $options = null) : \Zend_Service_Flickr_ResultSet

Finds photos by a user's username or email.

Additional query options include: # per_page: how many results to return per query # page: the starting page offset. first result will be (page - 1) * per_page + 1 # min_upload_date: Minimum upload date to search on. Date should be a unix timestamp. # max_upload_date: Maximum upload date to search on. Date should be a unix timestamp. # min_taken_date: Minimum upload date to search on. Date should be a MySQL datetime. # max_taken_date: Maximum upload date to search on. Date should be a MySQL datetime.

Parameters

Name	Type	Description
$query	string	username or email
$options	array	Additional parameters to refine your query.

Returns

Type	Description
\Zend_Service_Flickr_ResultSet

Throws

Exception	Description
\Zend_Service_Exception

Service/Flickr.php

\Zend_Service_Flickrjump to top

Constants

Properties

Methods

\Zend_Service_Flickr
jump to top