File Source for Flickr.php

<?php
/**
*
* SWX Flickr API by Aral Balkan. Uses the phpFlickr library. You can call this API using SWX, Amfphp, JSON and XML-RPC.
*
* @author Aral Balkan
* @copyright 2007 Aral Balkan. All Rights Reserved.
* @link http://aralbalkan.com
* @link http://swxformat.org
* @link mailto://aral@aralbalkan.com
*
***/
require_once("../lib/phpFlickr/phpFlickr.php");
class Flickr
{
var $API_KEY = "e7efb59164979981686e62d8bcc473be";
var $SHARED_SECRET = "2be064bed40b0b78";
var $api; // phpFlickr class instance
function Flickr()
{
global $flickr;
// I'm putting my (Aral's) Flickr API key here so you guys
// can get up and running with this quickly. Please don't
// abuse this. If you're going to build your own apps
// using the SWX Flickr API, please add your API here instead.
// Thanks! :)
$this->api = new phpFlickr($this->API_KEY, $this->SHARED_SECRET);
}
/**
* Returns the requested number of photos for the specified user.
*
* @param Flickr user name
* @param Style of photo as string (square, thumbnail, small, medium, large, original)
* @param Number of photos to receive
*
* @return void
* @author Aral Balkan
***/
function getUserPhotos($userName, $photoStyle = "medium", $numPhotos = 10, $page = 1)
{
$i = 0;
if (!empty($userName))
{
// Find the NSID of the username inputted via the form.
$person = $this->api->people_findByUsername($userName);
// Flickr Error?
if ($person === false)
{
return $this->_getResult($person);
}
// Get the friendly URL of the user's photos.
$photos_url = $this->api->urls_getUserPhotos($person['id']);
// Flickr Error?
if ($photos_url === false)
{
return $this->_getResult($photos_url);
}
// Get $numPhotos of the user's public photos, starting at page $page.
$photos = $this->api->people_getPublicPhotos($person['id'], NULL, $numPhotos, $page);
// Flickr Error?
if ($photos === false)
{
return $this->_getResult($photos);
}
// Build the results
$photoList = array();
// Loop through the photos and output the html
foreach ((array)$photos['photo'] as $photo)
{
$newPhoto = array
(
'link' => $photos_url.$photo['id'],
'alt' => $photo['title'],
'src' => $this->api->buildPhotoURL($photo, $photoStyle)
);
array_push($photoList, $newPhoto);
}
}
return $photoList;
}
//
// Activity methods.
//
/**
* Returns a list of recent activity on photos commented on by the calling user.
* Do not poll this method more than once an hour.
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.activity.userComments.html
*
* Requires read authentication.
*
* @param (str) The auth token that was returned by authGetToken().
* @param (int, optional) Number of items to return per page. If this argument is omitted, it defaults to 10. The maximum allowed value is 50.
* @param (int, optional) The page of results to return. If this argument is omitted, it defaults to 1.
*
* @return List of recent activity on photos commented on by the calling user.
* @author Aral Balkan
***/
function activityUserComments($token, $perPage = NULL, $page = NULL)
{
$this->api->setToken($token);
$activityComments = $this->api->activity_userComments($perPage, $page = NULL);
return $this->_getResult($activityComments);
}
/**
* Returns a list of recent activity on photos belonging to the calling user.
* Do not poll this method more than once an hour.
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.activity.userPhotos.html
*
* Requires read authentication.
*
* @param (str) The auth token that was returned by authGetToken().
* @param (str, optional) The timeframe in which to return updates for. This can be specified in days ('2d') or hours ('4h'). The default behavoir is to return changes since the beginning of the previous user session.
* @param (int, optional) Number of items to return per page. If this argument is omitted, it defaults to 10. The maximum allowed value is 50.
* @param (int, optional) The page of results to return. If this argument is omitted, it defaults to 1.
*
* @return List of recent activity on photos belonging to the calling user.
* @author Aral Balkan
***/
function activityUserPhotos ($token, $timeframe = NULL, $perPage = NULL, $page = NULL)
{
$this->api->setToken($token);
$activityPhotos = $this->api->activity_userPhotos ($timeframe, $perPage, $page);
return $this->_getResult($activityPhotos);
}
//
// Authentication methods.
// (Uses the authentication process for desktop applications.)
//
/**
* Returns a frob to be used during authentication.
*
* To authenticate a user using the SWX Flickr API:
*
* 1. First call this method and get the magic frob value.
* 2. Call the authGetUrl() method and pass the frob as well as the type of authentication you want ("read", "write", "delete"). This will return a URL.
* 3. Send the user to the URL returned in Step 2. Flickr will ask them to authorize your application. Once they've done that, they'll return to your application.
* 4. Call the authGetToken() method and pass the frob. If the user granted your application the correct permissions, you should get a token back. Send this token for all authenticated calls.
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.auth.getFrob.html
*
* Original Flickr authorization spec:
* http://www.flickr.com/services/api/auth.spec.html
*
* Flickr Desktop Applications How-To:
* http://www.flickr.com/services/api/auth.howto.desktop.html
*
* @return (str) Frob.
* @author Aral Balkan
***/
function authGetFrob()
{
$frob = $this->api->auth_getFrob();
return $this->_getResult($frob);
}
/**
* Returns the authentication url to redirect the user to so
* they can log in and authorize the Flash application. (This
* uses the authentication mechanism for desktop applications, which
* is the one that works best for Flash applications).
*
* For a full explanation of the authorization system in the
* SWX Flickr API, see the notes on the authGetFrob() method.
*
* @param (str) The frob that was returned by the authGetFrob() method.
* @param (str, optional) The permissions being requested ("read"|"write"|"delete"). Write includes read, and delete includes both read and write permissions. Defaults to read.
*
* @return (str) URL to send user to so they can authorize the application.
* @author Aral Balkan
***/
function authGetUrl ($frob, $perms="read")
{
// Calculate the desktop auth url.
$api_sig = md5($this->SHARED_SECRET . 'api_key' . $this->API_KEY . 'frob' . $frob . 'perms' . $perms);
$desktopAuthUrl = 'http://www.flickr.com/services/auth/?api_key=' . $this->API_KEY . '&perms=' . $perms . '&frob=' . $frob . '&api_sig='. $api_sig;
// And return it.
return $this->_getResult($desktopAuthUrl);
}
/**
* Returns the token you need to make authenticated calls if the user has authenticated
* your application.
*
* For a full explanation of the authorization system in the
* SWX Flickr API, see the notes on the authGetFrob() method.
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.auth.getToken.html
*
* @param (str) The frob that was returned by the authGetFrob() method.
*
* @return (str) Flickr auth token.
* @author Aral Balkan
***/
function authGetToken($frob)
{
$token = $this->api->auth_getToken($frob);
return $this->_getResult($token);
}
//
// Blog methods
//
/**
* Get a list of configured blogs for the calling user.
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.blogs.getList.html
*
* Requires read authentication.
*
* @param (str) The auth token that was returned by authGetToken().
*
* @return List of blogs for the calling user.
* @author Aral Balkan
***/
function blogsGetList($token)
{
$this->api->setToken($token);
$blogList = $this->api->blogs_getList();
return $this->_getResult($blogList);
}
/**
* Posts a photo to the blog with the passed id.
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.blogs.postPhoto.html
*
* Requires write authentication
*
* @param (str) The auth token that was returned by authGetToken().
* @param (str) The id of the blog to post to.
* @param (str) The id of the photo to blog.
* @param (str) The blog post title.
* @param (str) The blog post body.
* @param (str) The password for the blog (used when the blog does not have a stored password).
*
* @return (bool) True/False depending on whether the call succeeded or failed.
* @author Aral Balkan
***/
function blogsPostPhoto($token, $blogId, $photoId, $title, $description, $blogPassword = NULL)
{
$this->api->setToken($token);
$success = $this->api->blogs_postPhoto($blogId, $photoId, $title, $description, $blogPassword);
return $this->_getResult($success);
}
//
// Contacts methods
//
/**
* Get a list of contacts for the calling user.
*
* Valid values for the filter parameter, below, are:
*
* friends: Only contacts who are friends (and not family).
* family: Only contacts who are family (and not friends).
* both: Only contacts who are both friends and family.
* neither: Only contacts who are neither friends nor family.
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.contacts.getList.html
*
* Requires read authentication.
*
* @param (str) The auth token that was returned by authGetToken().
* @param (str, optional) An optional filter of the results.
* @param (int, optional) The page of results to return. If this argument is omitted, it defaults to 1.
* @param (int, optional) Number of photos to return per page. If this argument is omitted, it defaults to 1000. The maximum allowed value is 1000.
*
* @return List of contacts or false on error.
* @author Aral Balkan
***/
function contactsGetList($token, $filter = NULL, $page = NULL, $per_page = NULL)
{
$this->api->setToken($token);
error_log("page = $page, perpage = $per_page");
$contacts = $this->api->contacts_getList($filter, $page, $per_page);
return $this->_getResult($contacts);
}
/**
* Get the contact list for a user.
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.contacts.getPublicList.html
*
* Does not require authentication.
*
* @param (str) The NSID of the user to fetch the contact list for.
* @param (int, optional) The page of results to return. If this argument is omitted, it defaults to 1.
* @param (int, optional) Number of contacts to return per page. If this argument is omitted, it defaults to 1000. The maximum allowed value is 1000.
*
* @return List of contacts for the user.
* @author Aral Balkan
***/
function contactsGetPublicList($userId, $page = NULL, $perPage = NULL)
{
$publicList = $this->api->contacts_getPublicList($userId, $page, $perPage);
return $this->_getResult($publicList);
}
//
// Favorites methods
//
/**
* Returns a list of the user's favorite photos.
* Only photos which the calling user has permission to see are returned.
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.favorites.getList.html
*
* Requires read authentication.
*
* @param (str) The auth token that was returned by authGetToken().
* @param (str, optional) The NSID of the user to fetch the favorites list for. If this argument is omitted, the favorites list for the calling user is returned.
* @param (str, optional) A comma-delimited list of extra information to fetch for each returned record. Currently supported fields are: license, date_upload, date_taken, owner_name, icon_server, original_format, last_update, geo, tags, machine_tags.
* @param (int, optional) Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.
* @param (int, optional) The page of results to return. If this argument is omitted, it defaults to 1.
*
* @return List of user's favorite photos.
* @author Aral Balkan
***/
function favoritesGetList($token, $userId = NULL, $extras = NULL, $perPage = NULL, $page = NULL)
{
$this->api->setToken($token);
$favorites = $this->api->favorites_getList($userId, $extras, $perPage, $page);
return $this->_getResult($favorites);
}
/**
* Returns a list of favorite public photos for the given user.
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.favorites.getPublicList.html
*
* Does not require authentication.
*
* @param (str) The user to fetch the favorites list for.
* @param (str, optional) A comma-delimited list of extra information to fetch for each returned record. Currently supported fields are: license, date_upload, date_taken, owner_name, icon_server, original_format, last_update, geo, tags, machine_tags.
* @param (int, optional) Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.
* @param (int, optional) The page of results to return. If this argument is omitted, it defaults to 1.
*
* @return List of favorite public photos for the given user.
* @author Aral Balkan
***/
function favoritesGetPublicList($userId, $extras = NULL, $perPage = NULL, $page = NULL)
{
$publicList = $this->api->favorites_getPublicList($userId, $extras, $perPage, $page);
return $this->_getResult($publicList);
}
/**
* Adds a photo to a user's favorites list.
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.favorites.add.html
*
* Requires write authentication and a POST request.
*
* @param (str) The auth token that was returned by authGetToken().
* @param (str) The id of the photo to add to the user's favorites.
*
* @return True/False depending on whether call was successful.
* @author Aral Balkan
***/
function favoritesAdd ($token, $photoId)
{
$this->api->setToken($token);
$success = $this->api->favorites_add ($photoId);
return $this->_getResult($success);
}
/**
* Removes a photo from a user's favorites list.
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.favorites.remove.html
*
* Requires write authentication and a POST request.
*
* @param (str) The auth token that was returned by authGetToken().
* @param (str) The id of the photo to remove from the user's favorites.
*
* @return True/False depending on whether call was successful.
* @author Aral Balkan
***/
function favoritesRemove($token, $photoId)
{
$this->api->setToken($token);
$success = $this->api->favorites_remove($photoId);
return $this->_getResult($success);
}
//
// Groups methods
//
/**
* Browse the group category tree, finding groups and sub-categories.
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.groups.browse.html
*
* Requires read authentication.
*
* @param (str) The auth token that was returned by authGetToken().
* @param (str, optional) The category id to fetch a list of groups and sub-categories for. If not specified, it defaults to zero, the root of the category tree.
*
* @return Category information.
* @author Aral Balkan
***/
function groupsBrowse($token, $catId = NULL)
{
$this->api->setToken($token);
$groups = $this->api->groups_browse($catId);
return $this->_getResult($groups);
}
/**
* Search for groups.
* 18+ groups will only be returned for authenticated calls where the authenticated user is over 18.
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.groups.search.html
*
* Does not require authentication unless you also want to receive 18+ groups.
*
* @param (str) Text to search for.
* @param (int) Number of groups to return per page. If this argument is ommited, it defaults to 100. The maximum allowed value is 500.
* @param (int) The page of results to return. If this argument is ommited, it defaults to 1.
* @param (str; optional) The auth token that was returned by authGetToken(). Only required to receive 18+ groups.
*
* @return List of groups matching the search.
* @author Aral Balkan
***/
function groupsSearch($text, $perPage = NULL, $page = NULL, $token = NULL)
{
if ($token != NULL)
{
$this->api->setToken($token);
}
$groups = $this->api->groups_search($text, $perPage, $page);
return $this->_getResult($groups);
}
/**
* Get information about a group.
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.groups.getInfo.html
*
* Does not require authentication.
*
* @param (str) The NSID of the group to fetch information for.
*
* @return Information on requested group.
* @author Aral Balkan
***/
function groupsGetInfo($groupId)
{
$groupInfo = $this->api->groups_getInfo($groupId);
return $this->_getResult($groupInfo);
}
//
// Groups pools methods
//
/**
* Add a photo to a group's pool.
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.groups.pools.add.html
*
* Requires write authentication.
*
* @param (str) The auth token that was returned by authGetToken().
* @param (str) The id of the photo to add to the group pool. The photo must belong to the calling user.
* @param (str) The NSID of the group who's pool the photo is to be added to.
*
* @return True/False depending on whether call was successful.
* @author Aral Balkan
***/
function groupsPoolAdd ($token, $photoId, $groupId)
{
$this->api->setToken($token);
$success = $this->api->groups_pools_add ($photoId, $groupId);
return $this->_getResult($success);
}
/**
* Returns next and previous photos for a photo in a group pool.
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.groups.pools.getContext.html
*
* Does not require authentication.
*
* @param (str) The id of the photo to fetch the context for.
* @param (str) The nsid of the group who's pool to fetch the photo's context for.
*
* @return The next and previous photos for requested photo, in the requested group.
* @author Aral Balkan
***/
function groupsPoolsGetContext($photoId, $groupId)
{
$context = $this->api->groups_pools_getContext ($photoId, $groupId);
return $this->_getResult($context);
}
/**
* Returns a list of groups to which you can add photos.
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.groups.pools.getGroups.html
*
* Requires read authentication.
*
* @param (str) The auth token that was returned by authGetToken().
* @param (int, optional) The page of results to return. If this argument is omitted, it defaults to 1.
* @param (int, optional) Number of groups to return per page. If this argument is omitted, it defaults to 400. The maximum allowed value is 400.
*
* @return List of groups to which you can add photos.
* @author Aral Balkan
***/
function groupsPoolsGetGroups ($token, $page = NULL, $perPage = NULL)
{
$this->api->setToken($token);
$groups = $this->api->groups_pools_getGroups ($page, $perPage);
return $this->_getResult($groups);
}
/**
* Returns a list of pool photos for a given group,
* based on the permissions of the group and the user logged in (if any).
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.groups.pools.getPhotos.html
*
* Does not require authentication.
*
* @param (str) The id of the group who's pool you which to get the photo list for.
* @param (str, optional) A tag to filter the pool with. At the moment only one tag at a time is supported.
* @param (str, optional) The nsid of a user. Specifiying this parameter will retrieve for you only those photos that the user has contributed to the group pool.
* @param (str, optional) A comma-delimited list of extra information to fetch for each returned record. Currently supported fields are: license, date_upload, date_taken, owner_name, icon_server, original_format, last_update, geo, tags, machine_tags.
* @param (int, optional) Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.
* @param (int, optional) The page of results to return. If this argument is omitted, it defaults to 1.
*
* @return List of pool photos for a given group.
* @author Aral Balkan
***/
function groupsPoolsGetPhotos($groupId, $tags = NULL, $userId = NULL, $extras = NULL, $perPage = NULL, $page = NULL)
{
$photos = $this->api->groups_pools_getPhotos ($groupId, $tags, $userId, $extras, $perPage, $page);
return $this->_getResult($photos);
}
/**
* Remove a photo from a group pool.
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.groups.pools.remove.html
*
* Requires write authentication.
*
* @param (str) The auth token that was returned by authGetToken().
* @param (str) The id of the photo to remove from the group pool. The photo must either be owned by the calling user of the calling user must be an administrator of the group.
* @param (str) The NSID of the group who's pool the photo is to removed from.
*
* @return True/Error obj depending on whether call was successful.
* @author Aral Balkan
***/
function groupsPoolsRemove($token, $photoId, $groupId)
{
$this->api->setToken($token);
$success = $this->api->groups_pools_remove ($photoId, $groupId);
return $this->_getResult($success);
}
//
// Interestingness methods
//
/**
* Returns the list of interesting photos for the most recent day or a user-specified date.
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.interestingness.getList.html
*
* Does not require authentication.
*
* @param (str, optional) A specific date, formatted as YYYY-MM-DD, to return interesting photos for.
* @param (str, optional) A comma-delimited list of extra information to fetch for each returned record. Currently supported fields are: license, date_upload, date_taken, owner_name, icon_server, original_format, last_update, geo, tags, machine_tags.
* @param (int, optional) Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.
* @param (int, optional) The page of results to return. If this argument is omitted, it defaults to 1.
*
* @return List of interesting photos for the most recent day or a user-specified date.
* @author Aral Balkan
***/
function interestingnessGetList($date = NULL, $extras = NULL, $perPage = NULL, $page = NULL)
{
$photos = $this->api->interestingness_getList($date, $extras, $perPage, $page);
return $this->_getResult($photos);
}
//
// People methods
//
/**
* Return a user's NSID, given their email address
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.people.findByEmail.html
*
* Does not require authentication.
*
* @param (str) The email address of the user to find (may be primary or secondary).
*
* @return User's NSID.
* @author Aral Balkan
***/
function peopleFindByEmail($findEmail)
{
$nsid = $this->api->people_findByEmail($findEmail);
return $this->_getResult($nsid);
}
/**
* Return a user's NSID, given their username.
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.people.findByUsername.html
*
* Does not require authentication.
*
* @param (str) The username of the user to lookup.
*
* @return User's NSID.
* @author Aral Balkan
***/
function peopleFindByUsername($userName)
{
$nsid = $this->api->people_findByUsername($userName);
return $this->_getResult($nsid);
}
/**
* Get information about a user.
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.people.getInfo.html
*
* Does not require authentication but will return additional information
* if authenticated.
*
* @param (str) The NSID of the user to fetch information about.
* @param (str, optional) The auth token that was returned by authGetToken().
*
* @return User info.
* @author Aral Balkan
***/
function peopleGetInfo($userId, $token = NULL)
{
if ($token != NULL)
{
$this->api->setToken($token);
}
$userInfo = $this->api->people_getInfo($userId);
return $this->_getResult($userInfo);
}
/**
* Returns the list of public groups a user is a member of.
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.people.getPublicGroups.html
*
* Does not require authentication.
*
* @param (str) The NSID of the user to fetch groups for.
*
* @return List of public groups a user is a member of.
* @author Aral Balkan
***/
function peopleGetPublicGroups($userId)
{
$publicGroups = $this->api->people_getPublicGroups($userId);
return $this->_getResult($publicGroups);
}
/**
* Get a list of public photos for the given user.
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.people.getPublicPhotos.html
*
* Does not require authentication.
*
* @param (str) The NSID of the user who's photos to return.
* @param (str, optional) A comma-delimited list of extra information to fetch for each returned record. Currently supported fields are: license, date_upload, date_taken, owner_name, icon_server, original_format, last_update, geo, tags, machine_tags.
* @param (int, optional) Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.
* @param (int, optional) The page of results to return. If this argument is omitted, it defaults to 1.
*
* @return List of public photos for the given user.
* @author Aral Balkan
***/
function peopleGetPublicPhotos($userId, $extra = NULL, $perPage = NULL, $page = NULL)
{
$publicPhotos = $this->api->people_getPublicPhotos($userId, $extras, $perPage, $page);
return $this->_getResult($publicPhotos);
}
/**
* Returns information for the calling user related to photo uploads.
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.people.getUploadStatus.html
*
* Requires read authentication.
*
* @param (str) The auth token that was returned by authGetToken().
*
* @return Information for the calling user related to photo uploads.
* @author Aral Balkan
***/
function peopleGetUploadStatus($token)
{
$this->api->setToken($token);
$uploadStatus = $this->api->people_getUploadStatus();
return $this->_getResult($uploadStatus);
}
//
// Photos methods
//
/**
* Add tags to a photo.
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.photos.addTags.html
*
* Requires write authentication.
*
* @param (str) The auth token that was returned by authGetToken().
* @param (str) The id of the photo to add tags to.
* @param (str) The tags to add to the photo.
*
* @return True/False depending on result of the call.
* @author Aral Balkan
***/
function photosAddTags($token, $photoId, $tags)
{
$this->api->setToken($token);
$success = $this->api->photos_addTags ($photoId, $tags);
return $this->_getResult($success);
}
/**
* Delete a photo from flickr.
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.photos.delete.html
*
* This method requires delete authentication.
*
* @param (str) The auth token that was returned by authGetToken().
* @param (str) The id of the photo to delete.
*
* @return True/False depending on result of the call.
* @author Aral Balkan
***/
function photosDelete($token, $photoId)
{
$this->api->setToken($token);
$success = $this->api->photos_delete($photoId);
return $this->_getResult($success);
}
/**
* Returns all visible sets and pools the photo belongs to.
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.photos.getAllContexts.html
*
* Does not require authentication.
*
* @param (str) The photo to return information for.
*
* @return All visible sets and pools the photo belongs to.
* @author Aral Balkan
***/
function photosGetAllContexts($photoId)
{
$contexts = $this->api->photos_getAllContexts($photoId);
return $this->_getResult($contexts);
}
/**
* Fetch a list of recent photos from the calling users' contacts.
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.photos.getContactsPhotos.html
*
* Requires read authentication.
*
* @param (str) The auth token that was returned by authGetToken().
* @param (int, optional) Number of photos to return. Defaults to 10, maximum 50. This is only used if single_photo is not passed.
* @param (int, optional) Set as 1 to only show photos from friends and family (excluding regular contacts).
* @param (?, optional) Only fetch one photo (the latest) per contact, instead of all photos in chronological order.
* @param (int, optional) Set to 1 to include photos from the calling user.
* @param (str, optional) A comma-delimited list of extra information to fetch for each returned record. Currently supported fields are: license, date_upload, date_taken, owner_name, icon_server, original_format, last_update.
*
* @return List of recent photos from the calling users' contacts.
* @author Aral Balkan
***/
function photosGetContactsPhotos($token, $count = NULL, $justFriends = NULL, $singlePhoto = NULL, $includeSelf = NULL, $extras = NULL)
{
$this->api->setToken($token);
$contactsPhotos = $this->api->photos_getContactsPhotos($count, $justFriends, $singlePhoto, $includeSelf, $extras);
return $this->_getResult($contactsPhotos);
}
/**
* Fetch a list of recent public photos from a users' contacts.
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.photos.getContactsPublicPhotos.html
*
* @param (str) The NSID of the user to fetch photos for.
* @param (int, optional) Number of photos to return. Defaults to 10, maximum 50. This is only used if single_photo is not passed.
* @param (int, optional) Set as 1 to only show photos from friends and family (excluding regular contacts).
* @param (?, optional) Only fetch one photo (the latest) per contact, instead of all photos in chronological order.
* @param (int, optional) Set to 1 to include photos from the calling user.
* @param (str, optional) A comma-delimited list of extra information to fetch for each returned record. Currently supported fields are: license, date_upload, date_taken, owner_name, icon_server, original_format, last_update.
*
* @return List of recent public photos from a users' contacts.
* @author Aral Balkan
***/
function photosGetContactsPublicPhotos($userId, $count = NULL, $justFriends = NULL, $singlePhoto = NULL, $includeSelf = NULL, $extras = NULL)
{
$contactsPublicPhotos = $this->api->photos_getContactsPublicPhotos($userId, $count, $justFriends, $singlePhoto, $includeSelf, $extras);
return $this->_getResult($contactsPublicPhotos);
}
/**
* Returns next and previous photos for a photo in a photostream.
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.photos.getContext.html
*
* Does not require authentication.
*
* @param (str) The id of the photo to fetch the context for.
*
* @return Next and previous photos for a photo in a photostream.
* @author Aral Balkan
***/
function photosGetContext($photoId)
{
$context = $this->api->photos_getContext ($photoId);
return $this->_getResult($context);
}
/**
* Gets a list of photo counts for the given date ranges for the calling user.
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.photos.getCounts.html
*
* Requires read authentication.
*
* @param (str) The auth token that was returned by authGetToken().
* @param (str, optional) A comma delimited list of unix timestamps, denoting the periods to return counts for. They should be specified smallest first. You must specify either this or takenDates.
* @param (str, optional) A comma delimited list of mysql datetimes, denoting the periods to return counts for. They should be specified smallest first. You must specify either this or dates.
*
* @return List of photo counts for the given date ranges for the calling user.
* @author Aral Balkan
***/
function photosGetCounts($token, $dates = NULL, $takenDates = NULL)
{
$this->api->setToken($token);
$counts = $this->api->photos_getCounts($dates, $takenDates);
return $this->_getResult($counts);
}
/**
* Retrieves a list of EXIF/TIFF/GPS tags for a given photo.
* The calling user must have permission to view the photo.
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.photos.getExif.html
*
* Does not require authentication.
*
* @param (str) The id of the photo to fetch information for.
* @param (str, optional) The secret for the photo. If the correct secret is passed then permissions checking is skipped. This enables the 'sharing' of individual photos by passing around the id and secret.
*
* @return List of EXIF/TIFF/GPS tags for a given photo.
* @author Aral Balkan
***/
function photosGetExif($photoId, $secret = NULL)
{
$exif = $this->api->photos_getExif ($photoId, $secret);
return $this->_getResult($exif);
}
/**
* Returns the list of people who have favorited a given photo.
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.photos.getFavorites.html
*
* Does not require authentication.
*
* @param (str) The ID of the photo to fetch the favoriters list for.
* @param (int, optional) The page of results to return. If this argument is omitted, it defaults to 1.
* @param (int, optional) Number of usres to return per page. If this argument is omitted, it defaults to 10. The maximum allowed value is 50.
*
* @return List of people who have favorited a given photo.
* @author Aral Balkan
***/
function photosGetFavorites($photoId, $page = NULL, $perPage = NULL)
{
$favorites = $this->api->photos_getFavorites($photoId, $page, $perPage);
return $this->_getResult($favorites);
}
/**
* Get information about a photo.
* The calling user must have permission to view the photo.
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.photos.getInfo.html
*
* @param (str) The id of the photo to get information for.
* @param (str, optional) The secret for the photo. If the correct secret is passed then permissions checking is skipped. This enables the 'sharing' of individual photos by passing around the id and secret.
*
* @return Information about a photo.
* @author Aral Balkan
***/
function photosGetInfo($photoId, $secret = NULL)
{
$info = $this->api->photos_getInfo($photoId, $secret = NULL);
return $this->_getResult($info);
}
/**
* Returns a list of your photos that are not part of any sets.
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.photos.getNotInSet.html
*
* Requires read authentication.
*
* @param (str) The auth token that was returned by authGetToken().
* @param (str, optional) Minimum upload date. Photos with an upload date greater than or equal to this value will be returned. The date should be in the form of a unix timestamp.
* @param (str, optional) Maximum upload date. Photos with an upload date less than or equal to this value will be returned. The date should be in the form of a unix timestamp.
* @param (str, optional) Minimum taken date. Photos with an taken date greater than or equal to this value will be returned. The date should be in the form of a mysql datetime.
* @param (str, optional) Maximum taken date. Photos with an taken date less than or equal to this value will be returned. The date should be in the form of a mysql datetime.
* @param (int, optional) Return photos only matching a certain privacy level. Valid values are: 1 public photos, 2 private photos visible to friends, 3 private photos visible to family, 4 private photos visible to friends & family, 5 completely private photos
* @param (str, optional) A comma-delimited list of extra information to fetch for each returned record. Currently supported fields are: license, date_upload, date_taken, owner_name, icon_server, original_format, last_update, geo, tags, machine_tags.
* @param (int, optional) Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.
* @param (int, optional) The page of results to return. If this argument is omitted, it defaults to 1.
*
* @return List of your photos that are not part of any sets.
* @author Aral Balkan
***/
function photosGetNotInSet($token, $minUploadDate = NULL, $maxUploadDate = NULL, $minTakenDate = NULL, $maxTakenDate = NULL, $privacyFilter = NULL, $extras = NULL, $perPage = NULL, $page = NULL)
{
$this->api->setToken($token);
$photosNotInSet = $this->api->photos_getNotInSet($minUploadDate, $maxUploadDate, $minTakenDate, $maxTakenDate, $privacyFilter, $extras, $perPage, $page);
return $this->_getResult($photosNotInSet);
}
/**
* Get permissions for a photo.
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.photos.getPerms.html
*
* Requires read authentication.
*
* @param (str) The auth token that was returned by authGetToken().
* @param (str) The id of the photo to get permissions for.
*
* @return Permissions for a photo.
* @author Aral Balkan
***/
function photosGetPerms($token, $photoId)
{
$this->api->setToken($token);
$perms = $this->api->photos_getPerms($photoId);
return $this->_getResult($perms);
}
/**
* Returns a list of the latest public photos uploaded to flickr.
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.photos.getRecent.html
*
* Does not require authentication.
*
* @param (str, optional) comma-delimited list of extra information to fetch for each returned record. Currently supported fields are: license, date_upload, date_taken, owner_name, icon_server, original_format, last_update, geo, tags, machine_tags.
* @param (int, optional) Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.
* @param (int, optional) The page of results to return. If this argument is omitted, it defaults to 1.
*
* @return List of the latest public photos uploaded to flickr.
* @author Aral Balkan
***/
function photosGetRecent($extras = NULL, $perPage = NULL, $page = NULL)
{
$recentPhotos = $this->api->photos_getRecent($extras, $perPage, $page);
return $this->_getResult($recentPhotos);
}
/**
* Returns the available sizes for a photo.
* The calling user must have permission to view the photo.
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.photos.getSizes.html
*
* Does not require authentication.
*
* @param (str) The id of the photo to fetch size information for.
*
* @return The available sizes for a photo.
* @author Aral Balkan
***/
function photosGetSizes($photoId)
{
$sizes = $this->api->photos_getSizes($photoId);
return $this->_getResult($sizes);
}
/**
* Returns a list of your photos with no tags.
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.photos.getUntagged.html
*
* Requires read authentication.
*
* @param (str) The auth token that was returned by authGetToken().
* @param (str, optional) Minimum upload date. Photos with an upload date greater than or equal to this value will be returned. The date should be in the form of a unix timestamp.
* @param (str, optional) Maximum upload date. Photos with an upload date less than or equal to this value will be returned. The date should be in the form of a unix timestamp.
* @param (str, optional) Minimum taken date. Photos with an taken date greater than or equal to this value will be returned. The date should be in the form of a mysql datetime.
* @param (str, optional) Maximum taken date. Photos with an taken date less than or equal to this value will be returned. The date should be in the form of a mysql datetime.
* @param (int, optional) Return photos only matching a certain privacy level. Valid values are: 1 public photos, 2 private photos visible to friends, 3 private photos visible to family, 4 private photos visible to friends & family, 5 completely private photos
* @param (str, optional) A comma-delimited list of extra information to fetch for each returned record. Currently supported fields are: license, date_upload, date_taken, owner_name, icon_server, original_format, last_update, geo, tags, machine_tags.
* @param (int, optional) Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.
* @param (int, optional) The page of results to return. If this argument is omitted, it defaults to 1.
*
* @return List of your photos with no tags.
* @author Aral Balkan
***/
function photosGetUntagged($token, $minUploadDate = NULL, $maxUploadDate = NULL, $minTakenDate = NULL, $maxTakenDate = NULL, $privacyFilter = NULL, $extras = NULL, $perPage = NULL, $page = NULL)
{
$this->api->setToken($token);
$untagged = $this->api->photos_getUntagged($minUploadDate, $maxUploadDate, $minTakenDate, $maxTakenDate, $privacyFilter, $extras, $perPage, $page);
return $this->_getResult($untagged);
}
/**
* Returns a list of your geo-tagged photos.
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.photos.getWithGeoData.html
*
* Requires read authentication.
*
* @param (str) The auth token that was returned by authGetToken().
* @param (str, optional) Minimum upload date. Photos with an upload date greater than or equal to this value will be returned. The date should be in the form of a unix timestamp.
* @param (str, optional) Maximum upload date. Photos with an upload date less than or equal to this value will be returned. The date should be in the form of a unix timestamp.
* @param (str, optional) Minimum taken date. Photos with an taken date greater than or equal to this value will be returned. The date should be in the form of a mysql datetime.
* @param (str, optional) Maximum taken date. Photos with an taken date less than or equal to this value will be returned. The date should be in the form of a mysql datetime.
* @param (int, optional) Return photos only matching a certain privacy level. Valid values are: 1 public photos, 2 private photos visible to friends, 3 private photos visible to family, 4 private photos visible to friends & family, 5 completely private photos
* @param (str, optional) A comma-delimited list of extra information to fetch for each returned record. Currently supported fields are: license, date_upload, date_taken, owner_name, icon_server, original_format, last_update, geo, tags, machine_tags.
* @param (int, optional) Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.
* @param (int, optional) The page of results to return. If this argument is omitted, it defaults to 1.
*
* @return List of your geo-tagged photos.
* @author Aral Balkan
***/
function photosGetWithGeoData($token, $minUploadDate = NULL, $maxUploadDate = NULL, $minTakenDate = NULL, $maxTakenDate = NULL, $privacyFilter = NULL, $sort = NULL, $extras = NULL, $perPage = NULL, $page = NULL)
{
$this->api->setToken($token);
// Create the args array. (The way PHPFlickr implemented this method
// differs from the norm.
$args = array('min_upload_date' => $minUploadDate, 'max_upload_date' => $maxUploadDate, 'min_taken_date' => $minTakenDate, 'max_taken_date' => $maxTakenDate, 'private_filter' => $privacyFilter, 'sort' => $sort, 'extras' => $extras, 'per_page' => $perPage, 'page' => $page);
$photosWithGeoData = $this->api->photos_getWithGeoData($args);
return $this->_getResult($photosWithGeoData);
}
/**
* Returns a list of your photos which haven't been geo-tagged.
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.photos.getWithoutGeoData.html
*
* Requires read authentication.
*
* @param (str) The auth token that was returned by authGetToken().
* @param (str, optional) Minimum upload date. Photos with an upload date greater than or equal to this value will be returned. The date should be in the form of a unix timestamp.
* @param (str, optional) Maximum upload date. Photos with an upload date less than or equal to this value will be returned. The date should be in the form of a unix timestamp.
* @param (str, optional) Minimum taken date. Photos with an taken date greater than or equal to this value will be returned. The date should be in the form of a mysql datetime.
* @param (str, optional) Maximum taken date. Photos with an taken date less than or equal to this value will be returned. The date should be in the form of a mysql datetime.
* @param (int, optional) Return photos only matching a certain privacy level. Valid values are: 1 public photos, 2 private photos visible to friends, 3 private photos visible to family, 4 private photos visible to friends & family, 5 completely private photos
* @param (str, optional) A comma-delimited list of extra information to fetch for each returned record. Currently supported fields are: license, date_upload, date_taken, owner_name, icon_server, original_format, last_update, geo, tags, machine_tags.
* @param (int, optional) Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.
* @param (int, optional) The page of results to return. If this argument is omitted, it defaults to 1.
*
* @return List of your photos which haven't been geo-tagged.
* @author Aral Balkan
***/
function photosGetWithoutGeoData($token, $minUploadDate = NULL, $maxUploadDate = NULL, $minTakenDate = NULL, $maxTakenDate = NULL, $privacyFilter = NULL, $sort = NULL, $extras = NULL, $perPage = NULL, $page = NULL)
{
$this->api->setToken($token);
// Create the args array. (The way PHPFlickr implemented this method
// differs from the norm.
$args = array('min_upload_date' => $minUploadDate, 'max_upload_date' => $maxUploadDate, 'min_taken_date' => $minTakenDate, 'max_taken_date' => $maxTakenDate, 'private_filter' => $privacyFilter, 'sort' => $sort, 'extras' => $extras, 'per_page' => $perPage, 'page' => $page);
$photosWithoutGeoData = $this->api->photos_getWithoutGeoData($args);
return $this->_getResult($photosWithoutGeoData);
}
/**
* Return a list of your photos that have been recently created
* or which have been recently modified. Recently modified may mean
* that the photo's metadata (title, description, tags) may have
* been changed or a comment has been added (or just modified somehow :-)
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.photos.recentlyUpdated.html
*
* Requires read authentication.
*
* @param (str) The auth token that was returned by authGetToken().
* @param (str) A Unix timestamp indicating the date from which modifications should be compared.
* @param (str, optional) A comma-delimited list of extra information to fetch for each returned record. Currently supported fields are: license, date_upload, date_taken, owner_name, icon_server, original_format, last_update, geo, tags, machine_tags.
* @param (int, optional) Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.
* @param (int, optional) The page of results to return. If this argument is omitted, it defaults to 1.
*
* @return List of your photos that have been recently created
* or which have been recently modified.
* @author Aral Balkan
***/
function photosRecentlyUpdated($token, $minDate = NULL, $extras = NULL, $perPage = NULL, $page = NULL)
{
$this->api->setToken($token);
$photos = $this->api->photos_recentlyUpdated($minDate, $extras, $perPage, $page);
return $this->_getResult($photos);
}
/**
* Remove a tag from a photo.
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.photos.removeTag.html
*
* Requires write authentication.
*
* @param (str) The auth token that was returned by authGetToken().
* @param (str) The tag to remove from the photo. This parameter should contain a tag id, as returned by photosGetInfo().
*
* @return True on success, or error object.
* @author Aral Balkan
***/
function photosRemoveTag($token, $tagId)
{
$this->api->setToken($token);
$result = $this->api->photos_removeTag($tagId);
return $this->_getResult($result);
}
/**
* Return a list of photos matching some criteria. Only photos visible
* to the calling user will be returned. To return private or semi-private
* photos, the caller must be authenticated with 'read' permissions, and
* have permission to view the photos.
*
* Autentication is optional. Unauthenticated calls will only return
* public photos.
*
* Official Flickr API documentation:
* http://www.flickr.com/services/api/flickr.photos.search.html
*
* @param (str, optional) The auth token that was returned by authGetToken().
* @param (str, optional) The NSID of the user who's photo to search. If this parameter isn't passed then everybody's public photos will be searched. A value of "me" will search against the calling user's photos for authenticated calls.
* @param (str, optional) A comma-delimited list of tags. Photos with one or more of the tags listed will be returned.
* @param (str, optional) Either 'any' for an OR combination of tags, or 'all' for an AND combination. Defaults to 'any' if not specified.
* @param (str, optional) A free text search. Photos who's title, description or tags contain the text will be returned.
* @param (str, optional) Minimum upload date. Photos with an upload date greater than or equal to this value will be returned. The date should be in the form of a unix timestamp.
* @param (str, optional) Maximum upload date. Photos with an upload date less than or equal to this value will be returned. The date should be in the form of a unix timestamp.
* @param (str, optional) Minimum taken date. Photos with an taken date greater than or equal to this value will be returned. The date should be in the form of a mysql datetime.
* @param (str, optional) Maximum taken date. Photos with an taken date less than or equal to this value will be returned. The date should be in the form of a mysql datetime.
* @param (str, optional) The license id for photos (for possible values see the flickr.photos.licenses.getInfo method). Multiple licenses may be comma-separated.
* @param (str, optional) The order in which to sort returned photos. Deafults to date-posted-desc. The possible values are: date-posted-asc, date-posted-desc, date-taken-asc, date-taken-desc, interestingness-desc, interestingness-asc, and relevance.
* @param (int, optional) Return photos only matching a certain privacy level. This only applies when making an authenticated call to view photos you own. Valid values are: 1 public photos, 2 private photos visible to friends, 3 private photos visible to family, 4 private photos visible to friends & family, 5 completely private photos
* @param (str, optional) A comma-delimited list of 4 values defining the Bounding Box of the area that will be searched. The 4 values represent the bottom-left corner of the box and the top-right corner, minimum_longitude, minimum_latitude, maximum_longitude, maximum_latitude. Longitude has a range of -180 to 180 , latitude of -90 to 90. Defaults to -180, -90, 180, 90 if not specified. Unlike standard photo queries, geo (or bounding box) queries will only return 250 results per page. Geo queries require some sort of limiting agent in order to prevent the database from crying. This is basically like the check against "parameterless searches" for queries without a geo component. A tag, for instance, is considered a limiting agent as are user defined min_date_taken and min_date_upload parameters — If no limiting factor is passed we return only photos added in the last 12 hours (though we may extend the limit in the future).
* @param (int, optional) Recorded accuracy level of the location information. Current range is 1-16: World level is 1, Country is ~3, Region is ~6, City is ~11, Street is ~16, Defaults to maximum value if not specified.
* @param (int, optional) Safe search setting: 1 for safe. 2 for moderate. 3 for restricted. (Please note: Un-authed calls can only see Safe content.)
* @param (int, optional) Content Type setting: 1 for photos only. 2 for screenshots only. 3 for 'other' only. 4 for photos and screenshots. 5 for screenshots and 'other'. 6 for photos and 'other'. 7 for photos, screenshots, and 'other' (all).
* @param (str, optional) Aside from passing in a fully formed machine tag, there is a special syntax for searching on specific properties: Find photos using the 'dc' namespace : "machine_tags" => "dc:". Find photos with a title in the 'dc' namespace : "machine_tags" => "dc:title=". Find photos titled "mr. camera" in the 'dc' namespace : "machine_tags" => "dc:title=\"mr. camera\". Find photos whose value is "mr. camera" : "machine_tags" => "*:*=\"mr. camera\"". Find photos that have a title, in any namespace : "machine_tags" => "*:title=". Find photos that have a title, in any namespace, whose value is "mr. camera" : "machine_tags" => "*:title=\"mr. camera\"". Find photos, in the 'dc' namespace whose value is "mr. camera" : "machine_tags" => "dc:*=\"mr. camera\"". Multiple machine tags may be queried by passing a comma-separated list. The number of machine tags you can pass in a single query depends on the tag mode (AND or OR) that you are querying with. "AND" queries are limited to (16) machine tags. "OR" queries are limited to (8).
* @param (str, required if searching for machine tags) Either 'any' for an OR combination of tags, or 'all' for an AND combination. Defaults to 'any' if not specified.
* @param (str, optional) The id of a group who's pool to search. If specified, only matching photos posted to the group's pool will be returned.
* @param (str, optional) A comma-delimited list of extra information to fetch for each returned record. Currently supported fields are: license, date_upload, date_taken, owner_name, icon_server, original_format, last_update, geo, tags, machine_tags.
* @param (int, optional) Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.
* @param (int, optional) The page of results to return. If this argument is omitted, it defaults to 1.
*
* @return List of photos matching the criteria.
* @author Aral Balkan
***/
function photosSearch($token = NULL, $userId = NULL, $tags = NULL, $tagMode = NULL, $text = NULL, $minUploadDate = NULL, $maxUploadDate = NULL, $minTakenDate = NULL, $maxTakenDate = NULL, $license = NULL, $sort = NULL, $privacyFilter = NULL, $bbox = NULL, $accuracy = NULL, $safeSearch = NULL, $contentType = NULL, $machineTags = NULL, $machineTagMode = NULL, $groupId = NULL, $extras = NULL, $perPage = NULL, $page = NULL)
{
if ($token !== NULL)
{
$this->api->setToken($token);
}
$args = array('user_id' => $userId, 'tags' => $tags, 'tag_mode' => $tagMode, 'text' => $text, 'min_upload_date' => $minUploadDate, 'max_upload_date' => $maxUploadDate, 'min_taken_date' => $minTakenDate, 'max_taken_date' => $maxTakenDate, 'license' => $license, 'sort' => $sort, 'privacy_filter' => $privacyFilter, 'bbox' => $bbox, 'accuracy' => $accuracy, 'safe_search' => $safeSearch, 'content_type' => $contentType, 'machine_tags' => $machineTags, 'machine_tag_mode' => $machineTagMode, 'group_id' => $groupId, 'extras' => $extras, 'per_page' => $perPage, 'page' => $page);
$result = $this->api->photos_search($args);
return $this->_getResult($result);
}
//
// Private methods
//
function _getResult($result)
{
if ($result === false)
{
// Send the meaningful error message returned by Flickr, instead of false.
$result = array('error'=>true, 'code'=>$this->api->error_code, 'message'=>$this->api->error_msg);
}
return $result;
}
}
?>

Source for file Flickr.php