Class Zend_Service_Flickr

Description
  • license: New BSD License
  • copyright: Copyright (c) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com)

Located in /Zend/Service/Flickr.php (line 61)


	
			
Variable Summary
Method Summary
 static void _checkErrors ( $dom)
 Zend_Service_Flickr __construct (string $apiKey)
 integer getIdByEmail (string $email)
 integer getIdByUsername (string $username)
 Zend_Service_Flickr_ResultSet tagSearch (mixed $query, [array $options = null])
 Zend_Service_Flickr_ResultSet|boolean userSearch (string $query, [array $options = null])
 void _compareOptions (array $options, array $validOptions)
 array _prepareOptions (string $method, array $options, array $defaultOptions)
 void _validateTagSearch (array $options)
 void _validateUserSearch (array $options)
Variables
string $apiKey (line 68)

Your Flickr API key

  • access: public
Zend_Rest_Client $_rest (line 75)

Zend_Rest_Client Object

  • access: protected
Methods
static _checkErrors (line 379)

Check Result for Errors

  • access: protected
  • throws: Zend_Service_Exception
static void _checkErrors ( $dom)
  • DomDocument $dom
Constructor __construct (line 82)

Zend_Service_Flickr Constructor, setup character encoding

  • access: public
Zend_Service_Flickr __construct (string $apiKey)
  • string $apiKey: Your Flickr API key
getIdByEmail (line 320)

Utility function to find Flickr User IDs for emails.

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

  • return: the NSID (userid)
  • access: public
integer getIdByEmail (string $email)
  • string $email: the email
getIdByUsername (line 287)

Utility function to find Flickr User IDs for usernames.

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

  • return: the NSID (userid)
  • access: public
integer getIdByUsername (string $username)
  • string $username: the username
getImageDetails (line 350)

Utility function to find Flickr photo details by ID.

  • return: the details for the specified image
  • access: public
Zend_Service_Flickr_Image getImageDetails (string $id)
  • string $id: the NSID
tagSearch (line 111)

Find Flickr photos by tag.

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

  • access: public
Zend_Service_Flickr_ResultSet tagSearch (mixed $query, [array $options = null])
  • mixed $query: A single tag or an array of tags.
  • array $options: Additional parameters to refine your query.
userSearch (line 158)

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

  • access: public
Zend_Service_Flickr_ResultSet|boolean userSearch (string $query, [array $options = null])
  • string $query: username
  • array $options: Additional parameters to refine your query.
_compareOptions (line 413)

Check whether the user options are valid

  • access: protected
void _compareOptions (array $options, array $validOptions)
  • array $options: User options
  • array $validOptions: Valid options
_prepareOptions (line 398)

Prepare options for the request

  • return: Merged array of user and default/required options
  • access: protected
array _prepareOptions (string $method, array $options, array $defaultOptions)
  • string $method: Flickr Method to call
  • array $options: User Options
  • array $defaultOptions: Default Options
_validateTagSearch (line 245)

Validate Tag Search Options

  • access: protected
void _validateTagSearch (array $options)
  • array $options
_validateUserSearch (line 207)

Validate User Search Options

  • access: protected
void _validateUserSearch (array $options)
  • array $options

Documentation generated on Wed, 21 Feb 2007 11:48:27 -0800 by phpDocumentor 1.3.1