A PHP wrapper for the Flickr API, including Oauth.
A PHP wrapper for the Flickr API.
Table of contents:
Install with Composer:
composer require samwilson/phpflickr
Once you've included Composer's autoloader, create a PhpFlickr object. For example:
require_once 'vendor/autoload.php'; $flickr = new \Samwilson\PhpFlickr\PhpFlickr($apiKey, $apiSecret);
The constructor takes three arguments:
$api_key— This is the API key given to you by Flickr when you register an app.
$secret— The API secret is optional because it is only required to make authenticated requests (see below). It is given to you along with your API key when you register an app.
$die_on_error- This takes a boolean value and determines whether the class will die (aka cease operation) if the API returns an error statement. It defaults to false. Every method will return false if the API returns an error. You can access error messages using the getErrorCode() and getErrorMsg() methods.
All of the API methods have been implemented in phpFlickr. You can see a full list and documentation here: http://www.flickr.com/services/api/
To call a method, remove the "flickr." part of the name and replace any periods with underscores. For example, instead of flickr.photos.search, you would call $f->photos_search() or instead of flickr.photos.licenses.getInfo, you would call $f->photos_licenses_getInfo() (yes, it is case sensitive).
All functions have their arguments implemented in the list order on their documentation page (a link to which is included with each method in the phpFlickr clasS). The only exceptions to this are photos_search(), photos_getWithoutGeodata() and photos_getWithoutGeodata() which have so many optional arguments that it's easier for everyone if you just have to pass an associative array of arguments. See the comment in the photos_search() definition in phpFlickr.php for more information.
There are a few example files in the
To use these, first copy
php examples/get_auth_token.php to get the access token.
Add this access token to your
and then you can run any of the examples that require authentication
(note that not all of them do).
There is only one user authentication method available to the API, and that is OAuth 1.0. You only need to use this if you're performing operations that require it, such as uploading or accessing private photos.
This authentication method is somewhat complex, but is secure and allows your users to feel a little safer authenticating to your application. You don't have to ask for their username and password.
☛ Read more about the Flickr Authentication API.
We know how difficult this API looks at first glance, so we've tried to make it as transparent as possible for users of phpFlickr. We'll go through all of the steps you'll need to do to use this.
To have end users authenticate their accounts:
Create an object in which to temporarily store the authentication token, and give it to PhpFlickr. This must be an implementation of TokenStorageInterface, and will usually be of type
Session(for browser-based workflows) or
Memory(for command-line workflows) — or you can create your own implementation.
$storage = new \OAuth\Common\Storage\Memory(); $flickr->setOauthStorage($storage);
Send your user to a Flickr URL (by redirecting them, or just telling them to click a link), where they'll confirm that they want your application to have the permission you specify (which is either
$perm = 'read'; $url = $flickr->getAuthUrl($perm, $callbackUrl);
Once the user has authorized your application, they'll either be redirected back to a URL on your site (that you specified as the callback URL above) or be given a nine-digit code that they'll need to copy and paste into your application.
- For the browser-based workflow, your callback URL will now have
two new query-string parameters:
- For CLI workflow, you'll need to strip anything other than digits from the string that the user gives you (e.g. leading and trailing spaces, and the hyphens in the code).
- For the browser-based workflow, your callback URL will now have two new query-string parameters:
You can now request the final 'access token':
- For the browser-based workflow:
$accessToken = $flickr->retrieveAccessToken($_GET['oauth_verifier'], $_GET['oauth_token']);
- For the CLI workflow, it's much the same,
but because you've still got access to the request token
you can leave it out when you run this request:
$verifier = '<9-digit code stripped of hyphens and spaces>'; $accessToken = $flickr->retrieveAccessToken($verifier);
- For the browser-based workflow:
Now you can save the two string parts of the access token (which you can get via the
$accessToken->getAccessTokenSecret()methods) and use this for future requests. The access token doesn't expire, and must be stored securely (the details of doing that are outside the scope of PhpFlickr).
Once you have an access token (see above), you can store it somewhere secure and use it to make authenticated requests at a later time. To do this, first create a storage object (again, as for the initial authentication process, you can choose between different storage types, but for many situations the in-memory storage is sufficient), and then store your access token in that object:
// Create storage. $storage = new \OAuth\Common\Storage\Memory(); // Create the access token from the strings you acquired before. $token = new \OAuth\OAuth1\Token\StdOAuth1Token(); $token->setAccessToken($accessToken); $token->setAccessTokenSecret($accessTokenSecret); // Add the token to the storage. $storage->storeAccessToken('Flickr', $token);
Now, you can pass the storage into PhpFlickr, and start making requests:
$flickr->setOauthStorage($storage); $recent = $phpFlickr->photos_getContactsPhotos();
See the Usage section above for more details on the request methods,
examples/recent_photos.php file for a working example.
To enable caching, pass a configured cache object to
All requests are cached for the same time duration, which by default is 10 minutes.
This can be changed with the
Uploading is pretty simple. Aside from being authenticated (see Authentication section) the very minimum that you'll have to pass is a path to an image file on your php server. You can do either synchronous or asynchronous uploading as follows:
synchronous: sync_upload("photo.jpg"); asynchronous: async_upload("photo.jpg");
The basic difference is that synchronous uploading waits around until Flickr processes the photo and returns a PhotoID. Asynchronous just uploads the picture and gets a "ticketid" that you can use to check on the status of your upload. Asynchronous is much faster, though the photoid won't be instantly available for you. You can read more about asynchronous uploading here:
Both of the functions take the same arguments which are:
Photo: The path of the file to upload.
Title: The title of the photo.
Description: A description of the photo. May contain some limited HTML.
Tags: A space-separated list of tags to apply to the photo.
is_public: Set to 0 for no, 1 for yes.
is_friend: Set to 0 for no, 1 for yes.
is_family: Set to 0 for no, 1 for yes.
Flickr has released API support for uploading a replacement photo. To use this new method, just use the "replace" function in phpFlickr. You'll be required to pass the file name and Flickr's photo ID. You need to authenticate your script with "write" permissions before you can replace a photo. The arguments are:
Photo: The path of the file to upload.
Photo ID: The numeric Flickr ID of the photo you want to replace.
Async (optional): Set to 0 for a synchronous call, 1 for asynchronous.
If you use the asynchronous call, it will return a ticketid instead of photoid.
Many of the methods have optional arguments. For these, I have implemented them in the same order that the Flickr API documentation lists them. PHP allows for optional arguments in function calls, but if you want to use the third optional argument, you have to fill in the others to the left first. You can use the "NULL" value (without quotes) in the place of an actual argument. For example:
$f->groups_pools_getPhotos($group_id, NULL, NULL, 10);
This will get the first ten photos from a specific group's pool. If you look at the documentation, you will see that there is another argument, "page". I've left it off because it appears after "per_page".
Some people will need to ues phpFlickr from behind a proxy server. I've implemented a method that will allow you to use an HTTP proxy for all of your traffic. Let's say that you have a proxy server on your local server running at port 8181. This is the code you would use:
$f = new phpFlickr("[api key]"); $f->setProxy("localhost", "8181");
After that, all of your calls will be automatically made through your proxy server.
This is a fork of Dan Coulter's original phpFlickr library, maintained by Sam Wilson. All the hard work was done by Dan!
Thanks also is greatly due to the many other contributors.