Class Zend_Service_Flickr

Description
Description | Vars (details) | Methods (details)
  • license: Zend
  • copyright: Copyright (c) 2005-2006 Zend Technologies Inc. (http://www.zend.com)

Located in /library/Zend/Service/Flickr.php (line 59) 

Zend_Service_Abstract
   |
   --Zend_Service_Rest
      |
      --Zend_Service_Flickr
Variable Summary
Description | Vars (details) | Methods (details)
string $apiKey
Method Summary
Description | Vars (details) | Methods (details)
Zend_Service_Flickr __construct (string $apiKey)
integer getIdByEmail (string $email)
integer getIdByUsername (string $username)
Zend_Service_Flickr_Image getImageDetails (string $id)
Zend_Service_Flickr_ResultSet tagSearch (mixed $query, [array $options = null])
Zend_Service_Flickr_ResultSet|boolean userSearch (string $query, [array $options = null])
void _checkErrors (DomDocument $dom)
void _compareOptions (array $options, array $validOptions)
array _prepareOptions (string $method, array $options, array $defaultOptions)
void _validateTagSearch (array $options)
void _validateUserSearch (array $options)
Variables
Description | Vars (details) | Methods (details)
string $apiKey (line 66)

Your Flickr API key

  • access: public

Inherited Variables

Inherited from Zend_Service_Rest

Zend_Service_Rest::$_uri

Inherited from Zend_Service_Abstract

Zend_Service_Abstract::$_httpClient
Methods
Description | Vars (details) Methods (details)
Constructor __construct (line 73)

Zend_Service_Flickr Constructor, setup character encoding

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

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 280)

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 343)

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 101)

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: whether to 'any' or 'and' tags. 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 148)

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.
_checkErrors (line 372)

Check Result for Errors

  • access: protected
  • static:
  • throws: Zend_Service_Exception
void _checkErrors (DomDocument $dom)
  • DomDocument $dom
_compareOptions (line 406)

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 391)

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 236)

Validate Tag Search Options

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

Validate User Search Options

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

Inherited Methods

Inherited From Zend_Service_Rest

Zend_Service_Rest::restDelete()
Zend_Service_Rest::restGet()
Zend_Service_Rest::restPost()
Zend_Service_Rest::restPut()
Zend_Service_Rest::setUri()

Inherited From Zend_Service_Abstract

Zend_Service_Abstract::getHttpClient()
Zend_Service_Abstract::setHttpClient()

Documentation generated on Wed, 08 Mar 2006 04:52:28 -0800 by phpDocumentor 1.3.0RC4