Docs For Class Flickr

Description

Located in File: /services/Flickr.php

Class Variables

Summary:

mixed $api

mixed $API_KEY

mixed $SHARED_SECRET

$api (line 20)

Data type : mixed

$API_KEY = "e7efb59164979981686e62d8bcc473be" (line 18)

Data type : mixed

$SHARED_SECRET = "2be064bed40b0b78" (line 19)

Data type : mixed

Class Constants

Summary:

Method Detail

Summary:

Flickr Flickr ()

List activityUserComments ((str) $token, [(int, $perPage = NULL], [(int, $page = NULL])

List activityUserPhotos ((str) $token, [(str, $timeframe = NULL], [(int, $perPage = NULL], [(int, $page = NULL])

(str) authGetFrob ()

(str) authGetToken ((str) $frob)

(str) authGetUrl ((str) $frob, [(str, $perms = "read"])

List blogsGetList ((str) $token)

(bool) blogsPostPhoto ((str) $token, (str) $blogId, (str) $photoId, (str) $title, (str) $description, [(str) $blogPassword = NULL])

List contactsGetList ((str) $token, [(str, $filter = NULL], [(int, $page = NULL], [(int, $per_page = NULL])

List contactsGetPublicList ((str) $userId, [(int, $page = NULL], [(int, $perPage = NULL])

True/False favoritesAdd ((str) $token, (str) $photoId)

List favoritesGetList ((str) $token, [(str, $userId = NULL], [(str, $extras = NULL], [(int, $perPage = NULL], [(int, $page = NULL])

List favoritesGetPublicList ((str) $userId, [(str, $extras = NULL], [(int, $perPage = NULL], [(int, $page = NULL])

True/False favoritesRemove ((str) $token, (str) $photoId)

void getUserPhotos (Flickr $userName, [Style $photoStyle = "medium"], [Number $numPhotos = 10], [ $page = 1])

Category groupsBrowse ((str) $token, [(str, $catId = NULL])

Information groupsGetInfo ((str) $groupId)

True/False groupsPoolAdd ((str) $token, (str) $photoId, (str) $groupId)

The groupsPoolsGetContext ((str) $photoId, (str) $groupId)

List groupsPoolsGetGroups ((str) $token, [(int, $page = NULL], [(int, $perPage = NULL])

List groupsPoolsGetPhotos ((str) $groupId, [(str, $tags = NULL], [(str, $userId = NULL], [(str, $extras = NULL], [(int, $perPage = NULL], [(int, $page = NULL])

True/Error groupsPoolsRemove ((str) $token, (str) $photoId, (str) $groupId)

List groupsSearch ((str) $text, [(int) $perPage = NULL], [(int) $page = NULL], [(str; $token = NULL])

List interestingnessGetList ([(str, $date = NULL], [(str, $extras = NULL], [(int, $perPage = NULL], [(int, $page = NULL])

User's peopleFindByEmail ((str) $findEmail)

User's peopleFindByUsername ((str) $userName)

User peopleGetInfo ((str) $userId, [(str, $token = NULL])

List peopleGetPublicGroups ((str) $userId)

List peopleGetPublicPhotos ((str) $userId, [(str, $extra = NULL], [(int, $perPage = NULL], [(int, $page = NULL])

Information peopleGetUploadStatus ((str) $token)

True/False photosAddTags ((str) $token, (str) $photoId, (str) $tags)

True/False photosDelete ((str) $token, (str) $photoId)

All photosGetAllContexts ((str) $photoId)

List photosGetContactsPhotos ((str) $token, [(int, $count = NULL], [(int, $justFriends = NULL], [(?, $singlePhoto = NULL], [(int, $includeSelf = NULL], [(str, $extras = NULL])

List photosGetContactsPublicPhotos ((str) $userId, [(int, $count = NULL], [(int, $justFriends = NULL], [(?, $singlePhoto = NULL], [(int, $includeSelf = NULL], [(str, $extras = NULL])

Next photosGetContext ((str) $photoId)

List photosGetCounts ((str) $token, [(str, $dates = NULL], [(str, $takenDates = NULL])

List photosGetExif ((str) $photoId, [(str, $secret = NULL])

List photosGetFavorites ((str) $photoId, [(int, $page = NULL], [(int, $perPage = NULL])

Information photosGetInfo ((str) $photoId, [(str, $secret = NULL])

List photosGetNotInSet ((str) $token, [(str, $minUploadDate = NULL], [(str, $maxUploadDate = NULL], [(str, $minTakenDate = NULL], [(str, $maxTakenDate = NULL], [(int, $privacyFilter = NULL], [(str, $extras = NULL], [(int, $perPage = NULL], [(int, $page = NULL])

Permissions photosGetPerms ((str) $token, (str) $photoId)

List photosGetRecent ([(str, $extras = NULL], [(int, $perPage = NULL], [(int, $page = NULL])

The photosGetSizes ((str) $photoId)

List photosGetUntagged ((str) $token, [(str, $minUploadDate = NULL], [(str, $maxUploadDate = NULL], [(str, $minTakenDate = NULL], [(str, $maxTakenDate = NULL], [(int, $privacyFilter = NULL], [(str, $extras = NULL], [(int, $perPage = NULL], [(int, $page = NULL])

List photosGetWithGeoData ((str) $token, [(str, $minUploadDate = NULL], [(str, $maxUploadDate = NULL], [(str, $minTakenDate = NULL], [(str, $maxTakenDate = NULL], [(int, $privacyFilter = NULL], [(str, $sort = NULL], [(int, $extras = NULL], [(int, $perPage = NULL], [ $page = NULL])

List photosGetWithoutGeoData ((str) $token, [(str, $minUploadDate = NULL], [(str, $maxUploadDate = NULL], [(str, $minTakenDate = NULL], [(str, $maxTakenDate = NULL], [(int, $privacyFilter = NULL], [(str, $sort = NULL], [(int, $extras = NULL], [(int, $perPage = NULL], [ $page = NULL])

List photosRecentlyUpdated ((str) $token, [(str) $minDate = NULL], [(str, $extras = NULL], [(int, $perPage = NULL], [(int, $page = NULL])

True photosRemoveTag ((str) $token, (str) $tagId)

List photosSearch ([(str, $token = NULL], [(str, $userId = NULL], [(str, $tags = NULL], [(str, $tagMode = NULL], [(str, $text = NULL], [(str, $minUploadDate = NULL], [(str, $maxUploadDate = NULL], [(str, $minTakenDate = NULL], [(str, $maxTakenDate = NULL], [(str, $license = NULL], [(str, $sort = NULL], [(int, $privacyFilter = NULL], [(str, $bbox = NULL], [(int, $accuracy = NULL], [(int, $safeSearch = NULL], [(int, $contentType = NULL], [(str, $machineTags = NULL], [(str, $machineTagMode = NULL], [(str, $groupId = NULL], [(str, $extras = NULL], [(int, $perPage = NULL], [(int, $page = NULL])

void _getResult ( $result)

Constructor Flickr (line 22)

Flickr Flickr( )

Info

Method activityUserComments (line 117)

List activityUserComments( (str) $token, [(int, $perPage = NULL], [(int, $page = NULL])

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.

Parameters

(str) $token: The auth token that was returned by authGetToken().
(int, $perPage: optional) Number of items to return per page. If this argument is omitted, it defaults to 10. The maximum allowed value is 50.
(int, $page: optional) The page of results to return. If this argument is omitted, it defaults to 1.

Info

return - of recent activity on photos commented on by the calling user.
author - Aral Balkan

Method activityUserPhotos (line 143)

List activityUserPhotos( (str) $token, [(str, $timeframe = NULL], [(int, $perPage = NULL], [(int, $page = NULL])

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.

Parameters

(str) $token: The auth token that was returned by authGetToken().
(str, $timeframe: 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.
(int, $perPage: optional) Number of items to return per page. If this argument is omitted, it defaults to 10. The maximum allowed value is 50.
(int, $page: optional) The page of results to return. If this argument is omitted, it defaults to 1.

Info

return - of recent activity on photos belonging to the calling user.
author - Aral Balkan

Method authGetFrob (line 179)

(str) authGetFrob( )

Returns a frob to be used during authentication.

To authenticate a user using the SWX Flickr API:

First call this method and get the magic frob value.
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.
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.
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

Info

return - Frob.
author - Aral Balkan

Method authGetToken (line 227)

(str) authGetToken( (str) $frob)

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

Parameters

(str) $frob: The frob that was returned by the authGetFrob() method.

Info

return - Flickr auth token.
author - Aral Balkan

Method authGetUrl (line 201)

(str) authGetUrl( (str) $frob, [(str, $perms = "read"])

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.

Parameters

(str) $frob: The frob that was returned by the authGetFrob() method.
(str, $perms: optional) The permissions being requested ("read"|"write"|"delete"). Write includes read, and delete includes both read and write permissions. Defaults to read.

Info

return - URL to send user to so they can authorize the application.
author - Aral Balkan

Method blogsGetList (line 252)

List blogsGetList( (str) $token)

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.

Parameters

(str) $token: The auth token that was returned by authGetToken().

Info

return - of blogs for the calling user.
author - Aral Balkan

Method blogsPostPhoto (line 279)

(bool) blogsPostPhoto( (str) $token, (str) $blogId, (str) $photoId, (str) $title, (str) $description, [(str) $blogPassword = NULL])

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

Parameters

(str) $token: The auth token that was returned by authGetToken().
(str) $blogId: The id of the blog to post to.
(str) $photoId: The id of the photo to blog.
(str) $title: The blog post title.
(str) $description: The blog post body.
(str) $blogPassword: The password for the blog (used when the blog does not have a stored password).

Info

return - True/False depending on whether the call succeeded or failed.
author - Aral Balkan

Method contactsGetList (line 316)

List contactsGetList( (str) $token, [(str, $filter = NULL], [(int, $page = NULL], [(int, $per_page = NULL])

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.

Parameters

(str) $token: The auth token that was returned by authGetToken().
(str, $filter: optional) An optional filter of the results.
(int, $page: optional) The page of results to return. If this argument is omitted, it defaults to 1.
(int, $per_page: optional) Number of photos to return per page. If this argument is omitted, it defaults to 1000. The maximum allowed value is 1000.

Info

return - of contacts or false on error.
author - Aral Balkan

Method contactsGetPublicList (line 343)

List contactsGetPublicList( (str) $userId, [(int, $page = NULL], [(int, $perPage = NULL])

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.

Parameters

(str) $userId: The NSID of the user to fetch the contact list for.
(int, $page: optional) The page of results to return. If this argument is omitted, it defaults to 1.
(int, $perPage: optional) Number of contacts to return per page. If this argument is omitted, it defaults to 1000. The maximum allowed value is 1000.

Info

return - of contacts for the user.
author - Aral Balkan

Method favoritesAdd (line 421)

True/False favoritesAdd( (str) $token, (str) $photoId)

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.

Parameters

(str) $token: The auth token that was returned by authGetToken().
(str) $photoId: The id of the photo to add to the user's favorites.

Info

return - depending on whether call was successful.
author - Aral Balkan

Method favoritesGetList (line 374)

List favoritesGetList( (str) $token, [(str, $userId = NULL], [(str, $extras = NULL], [(int, $perPage = NULL], [(int, $page = NULL])

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.

Parameters

(str) $token: The auth token that was returned by authGetToken().
(str, $userId: 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.
(str, $extras: 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.
(int, $perPage: optional) Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.
(int, $page: optional) The page of results to return. If this argument is omitted, it defaults to 1.

Info

return - of user's favorite photos.
author - Aral Balkan

Method favoritesGetPublicList (line 399)

List favoritesGetPublicList( (str) $userId, [(str, $extras = NULL], [(int, $perPage = NULL], [(int, $page = NULL])

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.

Parameters

(str) $userId: The user to fetch the favorites list for.
(str, $extras: 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.
(int, $perPage: optional) Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.
(int, $page: optional) The page of results to return. If this argument is omitted, it defaults to 1.

Info

return - of favorite public photos for the given user.
author - Aral Balkan

Method favoritesRemove (line 444)

True/False favoritesRemove( (str) $token, (str) $photoId)

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.

Parameters

(str) $token: The auth token that was returned by authGetToken().
(str) $photoId: The id of the photo to remove from the user's favorites.

Info

return - depending on whether call was successful.
author - Aral Balkan

Method getUserPhotos (line 44)

void getUserPhotos( Flickr $userName, [Style $photoStyle = "medium"], [Number $numPhotos = 10], [ $page = 1])

Returns the requested number of photos for the specified user.

Parameters

Flickr $userName: user name
Style $photoStyle: of photo as string (square, thumbnail, small, medium, large, original)
Number $numPhotos: of photos to receive
$page:

Info

author - Aral Balkan

Method groupsBrowse (line 472)

Category groupsBrowse( (str) $token, [(str, $catId = NULL])

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.

Parameters

(str) $token: The auth token that was returned by authGetToken().
(str, $catId: 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.

Info

return - information.
author - Aral Balkan

Method groupsGetInfo (line 523)

Information groupsGetInfo( (str) $groupId)

Get information about a group.

Official Flickr API documentation: http://www.flickr.com/services/api/flickr.groups.getInfo.html

Does not require authentication.

Parameters

(str) $groupId: The NSID of the group to fetch information for.

Info

return - on requested group.
author - Aral Balkan

Method groupsPoolAdd (line 551)

True/False groupsPoolAdd( (str) $token, (str) $photoId, (str) $groupId)

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.

Parameters

(str) $token: The auth token that was returned by authGetToken().
(str) $photoId: The id of the photo to add to the group pool. The photo must belong to the calling user.
(str) $groupId: The NSID of the group who's pool the photo is to be added to.

Info

return - depending on whether call was successful.
author - Aral Balkan

Method groupsPoolsGetContext (line 574)

The groupsPoolsGetContext( (str) $photoId, (str) $groupId)

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.

Parameters

(str) $photoId: The id of the photo to fetch the context for.
(str) $groupId: The nsid of the group who's pool to fetch the photo's context for.

Info

return - next and previous photos for requested photo, in the requested group.
author - Aral Balkan

Method groupsPoolsGetGroups (line 597)

List groupsPoolsGetGroups( (str) $token, [(int, $page = NULL], [(int, $perPage = NULL])

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.

Parameters

(str) $token: The auth token that was returned by authGetToken().
(int, $page: optional) The page of results to return. If this argument is omitted, it defaults to 1.
(int, $perPage: optional) Number of groups to return per page. If this argument is omitted, it defaults to 400. The maximum allowed value is 400.

Info

return - of groups to which you can add photos.
author - Aral Balkan

Method groupsPoolsGetPhotos (line 625)

List groupsPoolsGetPhotos( (str) $groupId, [(str, $tags = NULL], [(str, $userId = NULL], [(str, $extras = NULL], [(int, $perPage = NULL], [(int, $page = NULL])

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.

Parameters

(str) $groupId: The id of the group who's pool you which to get the photo list for.
(str, $tags: optional) A tag to filter the pool with. At the moment only one tag at a time is supported.
(str, $userId: 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.
(str, $extras: 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.
(int, $perPage: optional) Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.
(int, $page: optional) The page of results to return. If this argument is omitted, it defaults to 1.

Info

return - of pool photos for a given group.
author - Aral Balkan

Method groupsPoolsRemove (line 648)

True/Error groupsPoolsRemove( (str) $token, (str) $photoId, (str) $groupId)

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.

Parameters

(str) $token: The auth token that was returned by authGetToken().
(str) $photoId: 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.
(str) $groupId: The NSID of the group who's pool the photo is to removed from.

Info

return - obj depending on whether call was successful.
author - Aral Balkan

Method groupsSearch (line 498)

List groupsSearch( (str) $text, [(int) $perPage = NULL], [(int) $page = NULL], [(str; $token = NULL])

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.

Parameters

(str) $text: Text to search for.
(int) $perPage: Number of groups to return per page. If this argument is ommited, it defaults to 100. The maximum allowed value is 500.
(int) $page: The page of results to return. If this argument is ommited, it defaults to 1.
(str; $token: optional) The auth token that was returned by authGetToken(). Only required to receive 18+ groups.

Info

return - of groups matching the search.
author - Aral Balkan

Method interestingnessGetList (line 677)

List interestingnessGetList( [(str, $date = NULL], [(str, $extras = NULL], [(int, $perPage = NULL], [(int, $page = NULL])

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.

Parameters

(str, $date: optional) A specific date, formatted as YYYY-MM-DD, to return interesting photos for.
(str, $extras: 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.
(int, $perPage: optional) Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.
(int, $page: optional) The page of results to return. If this argument is omitted, it defaults to 1.

Info

return - of interesting photos for the most recent day or a user-specified date.
author - Aral Balkan

Method peopleFindByEmail (line 701)

User's peopleFindByEmail( (str) $findEmail)

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.

Parameters

(str) $findEmail: The email address of the user to find (may be primary or secondary).

Info

return - NSID.
author - Aral Balkan

Method peopleFindByUsername (line 722)

User's peopleFindByUsername( (str) $userName)

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.

Parameters

(str) $userName: The username of the user to lookup.

Info

return - NSID.
author - Aral Balkan

Method peopleGetInfo (line 745)

User peopleGetInfo( (str) $userId, [(str, $token = NULL])

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.

Parameters

(str) $userId: The NSID of the user to fetch information about.
(str, $token: optional) The auth token that was returned by authGetToken().

Info

return - info.
author - Aral Balkan

Method peopleGetPublicGroups (line 771)

List peopleGetPublicGroups( (str) $userId)

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.

Parameters

(str) $userId: The NSID of the user to fetch groups for.

Info

return - of public groups a user is a member of.
author - Aral Balkan

Method peopleGetPublicPhotos (line 795)

List peopleGetPublicPhotos( (str) $userId, [(str, $extra = NULL], [(int, $perPage = NULL], [(int, $page = NULL])

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.

Parameters

(str) $userId: The NSID of the user who's photos to return.
(str, $extra: 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.
(int, $perPage: optional) Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.
(int, $page: optional) The page of results to return. If this argument is omitted, it defaults to 1.

Info

return - of public photos for the given user.
author - Aral Balkan

Method peopleGetUploadStatus (line 816)

Information peopleGetUploadStatus( (str) $token)

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.

Parameters

(str) $token: The auth token that was returned by authGetToken().

Info

return - for the calling user related to photo uploads.
author - Aral Balkan

Method photosAddTags (line 845)

True/False photosAddTags( (str) $token, (str) $photoId, (str) $tags)

Add tags to a photo.

Official Flickr API documentation: http://www.flickr.com/services/api/flickr.photos.addTags.html

Requires write authentication.

Parameters

(str) $token: The auth token that was returned by authGetToken().
(str) $photoId: The id of the photo to add tags to.
(str) $tags: The tags to add to the photo.

Info

return - depending on result of the call.
author - Aral Balkan

Method photosDelete (line 869)

True/False photosDelete( (str) $token, (str) $photoId)

Delete a photo from flickr.

Official Flickr API documentation: http://www.flickr.com/services/api/flickr.photos.delete.html

This method requires delete authentication.

Parameters

(str) $token: The auth token that was returned by authGetToken().
(str) $photoId: The id of the photo to delete.

Info

return - depending on result of the call.
author - Aral Balkan

Method photosGetAllContexts (line 892)

All photosGetAllContexts( (str) $photoId)

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.

Parameters

(str) $photoId: The photo to return information for.

Info

return - visible sets and pools the photo belongs to.
author - Aral Balkan

Method photosGetContactsPhotos (line 918)

List photosGetContactsPhotos( (str) $token, [(int, $count = NULL], [(int, $justFriends = NULL], [(?, $singlePhoto = NULL], [(int, $includeSelf = NULL], [(str, $extras = NULL])

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.

Parameters

(str) $token: The auth token that was returned by authGetToken().
(int, $count: optional) Number of photos to return. Defaults to 10, maximum 50. This is only used if single_photo is not passed.
(int, $justFriends: optional) Set as 1 to only show photos from friends and family (excluding regular contacts).
(?, $singlePhoto: optional) Only fetch one photo (the latest) per contact, instead of all photos in chronological order.
(int, $includeSelf: optional) Set to 1 to include photos from the calling user.
(str, $extras: 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.

Info

return - of recent photos from the calling users' contacts.
author - Aral Balkan

Method photosGetContactsPublicPhotos (line 944)

List photosGetContactsPublicPhotos( (str) $userId, [(int, $count = NULL], [(int, $justFriends = NULL], [(?, $singlePhoto = NULL], [(int, $includeSelf = NULL], [(str, $extras = NULL])

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

Parameters

(str) $userId: The NSID of the user to fetch photos for.
(int, $count: optional) Number of photos to return. Defaults to 10, maximum 50. This is only used if single_photo is not passed.
(int, $justFriends: optional) Set as 1 to only show photos from friends and family (excluding regular contacts).
(?, $singlePhoto: optional) Only fetch one photo (the latest) per contact, instead of all photos in chronological order.
(int, $includeSelf: optional) Set to 1 to include photos from the calling user.
(str, $extras: 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.

Info

return - of recent public photos from a users' contacts.
author - Aral Balkan

Method photosGetContext (line 965)

Next photosGetContext( (str) $photoId)

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.

Parameters

(str) $photoId: The id of the photo to fetch the context for.

Info

return - and previous photos for a photo in a photostream.
author - Aral Balkan

Method photosGetCounts (line 988)

List photosGetCounts( (str) $token, [(str, $dates = NULL], [(str, $takenDates = NULL])

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.

Parameters

(str) $token: The auth token that was returned by authGetToken().
(str, $dates: 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.
(str, $takenDates: 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.

Info

return - of photo counts for the given date ranges for the calling user.
author - Aral Balkan

Method photosGetExif (line 1012)

List photosGetExif( (str) $photoId, [(str, $secret = NULL])

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.

Parameters

(str) $photoId: The id of the photo to fetch information for.
(str, $secret: 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.

Info

return - of EXIF/TIFF/GPS tags for a given photo.
author - Aral Balkan

Method photosGetFavorites (line 1035)

List photosGetFavorites( (str) $photoId, [(int, $page = NULL], [(int, $perPage = NULL])

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.

Parameters

(str) $photoId: The ID of the photo to fetch the favoriters list for.
(int, $page: optional) The page of results to return. If this argument is omitted, it defaults to 1.
(int, $perPage: optional) Number of usres to return per page. If this argument is omitted, it defaults to 10. The maximum allowed value is 50.

Info

return - of people who have favorited a given photo.
author - Aral Balkan

Method photosGetInfo (line 1056)

Information photosGetInfo( (str) $photoId, [(str, $secret = NULL])

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

Parameters

(str) $photoId: The id of the photo to get information for.
(str, $secret: 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.

Info

return - about a photo.
author - Aral Balkan

Method photosGetNotInSet (line 1085)

List photosGetNotInSet( (str) $token, [(str, $minUploadDate = NULL], [(str, $maxUploadDate = NULL], [(str, $minTakenDate = NULL], [(str, $maxTakenDate = NULL], [(int, $privacyFilter = NULL], [(str, $extras = NULL], [(int, $perPage = NULL], [(int, $page = NULL])

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.

Parameters

(str) $token: The auth token that was returned by authGetToken().
(str, $minUploadDate: 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.
(str, $maxUploadDate: 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.
(str, $minTakenDate: 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.
(str, $maxTakenDate: 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.
(int, $privacyFilter: 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
(str, $extras: 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.
(int, $perPage: optional) Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.
(int, $page: optional) The page of results to return. If this argument is omitted, it defaults to 1.

Info

return - of your photos that are not part of any sets.
author - Aral Balkan

Method photosGetPerms (line 1108)

Permissions photosGetPerms( (str) $token, (str) $photoId)

Get permissions for a photo.

Official Flickr API documentation: http://www.flickr.com/services/api/flickr.photos.getPerms.html

Requires read authentication.

Parameters

(str) $token: The auth token that was returned by authGetToken().
(str) $photoId: The id of the photo to get permissions for.

Info

return - for a photo.
author - Aral Balkan

Method photosGetRecent (line 1133)

List photosGetRecent( [(str, $extras = NULL], [(int, $perPage = NULL], [(int, $page = NULL])

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.

Parameters

(str, $extras: 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.
(int, $perPage: optional) Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.
(int, $page: optional) The page of results to return. If this argument is omitted, it defaults to 1.

Info

return - of the latest public photos uploaded to flickr.
author - Aral Balkan

Method photosGetSizes (line 1155)

The photosGetSizes( (str) $photoId)

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.

Parameters

(str) $photoId: The id of the photo to fetch size information for.

Info

return - available sizes for a photo.
author - Aral Balkan

Method photosGetUntagged (line 1184)

List photosGetUntagged( (str) $token, [(str, $minUploadDate = NULL], [(str, $maxUploadDate = NULL], [(str, $minTakenDate = NULL], [(str, $maxTakenDate = NULL], [(int, $privacyFilter = NULL], [(str, $extras = NULL], [(int, $perPage = NULL], [(int, $page = NULL])

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.

Parameters

(str) $token: The auth token that was returned by authGetToken().
(str, $minUploadDate: 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.
(str, $maxUploadDate: 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.
(str, $minTakenDate: 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.
(str, $maxTakenDate: 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.
(int, $privacyFilter: 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
(str, $extras: 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.
(int, $perPage: optional) Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.
(int, $page: optional) The page of results to return. If this argument is omitted, it defaults to 1.

Info

return - of your photos with no tags.
author - Aral Balkan

Method photosGetWithGeoData (line 1214)

List photosGetWithGeoData( (str) $token, [(str, $minUploadDate = NULL], [(str, $maxUploadDate = NULL], [(str, $minTakenDate = NULL], [(str, $maxTakenDate = NULL], [(int, $privacyFilter = NULL], [(str, $sort = NULL], [(int, $extras = NULL], [(int, $perPage = NULL], [ $page = NULL])

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.

Parameters

(str) $token: The auth token that was returned by authGetToken().
(str, $minUploadDate: 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.
(str, $maxUploadDate: 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.
(str, $minTakenDate: 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.
(str, $maxTakenDate: 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.
(int, $privacyFilter: 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
(str, $sort: 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.
(int, $extras: optional) Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.
(int, $perPage: optional) The page of results to return. If this argument is omitted, it defaults to 1.
$page:

Info

return - of your geo-tagged photos.
author - Aral Balkan

Method photosGetWithoutGeoData (line 1249)

List photosGetWithoutGeoData( (str) $token, [(str, $minUploadDate = NULL], [(str, $maxUploadDate = NULL], [(str, $minTakenDate = NULL], [(str, $maxTakenDate = NULL], [(int, $privacyFilter = NULL], [(str, $sort = NULL], [(int, $extras = NULL], [(int, $perPage = NULL], [ $page = NULL])

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.

Parameters

(str) $token: The auth token that was returned by authGetToken().
(str, $minUploadDate: 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.
(str, $maxUploadDate: 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.
(str, $minTakenDate: 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.
(str, $maxTakenDate: 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.
(int, $privacyFilter: 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
(str, $sort: 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.
(int, $extras: optional) Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.
(int, $perPage: optional) The page of results to return. If this argument is omitted, it defaults to 1.
$page:

Info

return - of your photos which haven't been geo-tagged.
author - Aral Balkan

Method photosRecentlyUpdated (line 1284)

List photosRecentlyUpdated( (str) $token, [(str) $minDate = NULL], [(str, $extras = NULL], [(int, $perPage = NULL], [(int, $page = NULL])

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.

Parameters

(str) $token: The auth token that was returned by authGetToken().
(str) $minDate: A Unix timestamp indicating the date from which modifications should be compared.
(str, $extras: 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.
(int, $perPage: optional) Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.
(int, $page: optional) The page of results to return. If this argument is omitted, it defaults to 1.

Info

return - of your photos that have been recently created or which have been recently modified.
author - Aral Balkan

Method photosRemoveTag (line 1308)

True photosRemoveTag( (str) $token, (str) $tagId)

Remove a tag from a photo.

Official Flickr API documentation: http://www.flickr.com/services/api/flickr.photos.removeTag.html

Requires write authentication.

Parameters

(str) $token: The auth token that was returned by authGetToken().
(str) $tagId: The tag to remove from the photo. This parameter should contain a tag id, as returned by photosGetInfo().

Info

return - on success, or error object.
author - Aral Balkan

Method photosSearch (line 1356)

List photosSearch( [(str, $token = NULL], [(str, $userId = NULL], [(str, $tags = NULL], [(str, $tagMode = NULL], [(str, $text = NULL], [(str, $minUploadDate = NULL], [(str, $maxUploadDate = NULL], [(str, $minTakenDate = NULL], [(str, $maxTakenDate = NULL], [(str, $license = NULL], [(str, $sort = NULL], [(int, $privacyFilter = NULL], [(str, $bbox = NULL], [(int, $accuracy = NULL], [(int, $safeSearch = NULL], [(int, $contentType = NULL], [(str, $machineTags = NULL], [(str, $machineTagMode = NULL], [(str, $groupId = NULL], [(str, $extras = NULL], [(int, $perPage = NULL], [(int, $page = NULL])

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

Parameters

(str, $token: optional) The auth token that was returned by authGetToken().
(str, $userId: 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.
(str, $tags: optional) A comma-delimited list of tags. Photos with one or more of the tags listed will be returned.
(str, $tagMode: optional) Either 'any' for an OR combination of tags, or 'all' for an AND combination. Defaults to 'any' if not specified.
(str, $text: optional) A free text search. Photos who's title, description or tags contain the text will be returned.
(str, $minUploadDate: 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.
(str, $maxUploadDate: 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.
(str, $minTakenDate: 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.
(str, $maxTakenDate: 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.
(str, $license: optional) The license id for photos (for possible values see the flickr.photos.licenses.getInfo method). Multiple licenses may be comma-separated.
(str, $sort: 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.
(int, $privacyFilter: 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
(str, $bbox: 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).
(int, $accuracy: 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.
(int, $safeSearch: optional) Safe search setting: 1 for safe. 2 for moderate. 3 for restricted. (Please note: Un-authed calls can only see Safe content.)
(int, $contentType: 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).
(str, $machineTags: 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).
(str, $machineTagMode: 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.
(str, $groupId: 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.
(str, $extras: 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.
(int, $perPage: optional) Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.
(int, $page: optional) The page of results to return. If this argument is omitted, it defaults to 1.

Info

return - of photos matching the criteria.
author - Aral Balkan

Method _getResult (line 1377)

void _getResult( $result)

Parameters

$result: