From 06f945f27840b53e57795dadbc38e76f7e11ab1c Mon Sep 17 00:00:00 2001 From: Horus3 Date: Mon, 24 Feb 2014 16:42:14 +0100 Subject: init --- .../manual/core/en/zend.gdata.photos.html | 959 +++++++++++++++++++++ 1 file changed, 959 insertions(+) create mode 100644 zend/documentation/manual/core/en/zend.gdata.photos.html (limited to 'zend/documentation/manual/core/en/zend.gdata.photos.html') diff --git a/zend/documentation/manual/core/en/zend.gdata.photos.html b/zend/documentation/manual/core/en/zend.gdata.photos.html new file mode 100644 index 0000000..036cd9b --- /dev/null +++ b/zend/documentation/manual/core/en/zend.gdata.photos.html @@ -0,0 +1,959 @@ + + + + + Using Picasa Web Albums - Zend Framework Manual + + + + + + + + +
+ + + + + + + + +
+ Using Google Apps Provisioning + +
Zend_Gdata
+ Programmer's Reference Guide
+ 		+ +
+
+

Using Picasa Web Albums

+ + +

+ Picasa Web Albums is a service which allows users to maintain albums of + their own pictures, and browse the albums and pictures of others. + The API offers a programmatic interface to this service, allowing + users to add to, update, and remove from their albums, as well as + providing the ability to tag and comment on photos. +

+ +

+ Access to public albums and photos is not restricted by account, + however, a user must be logged in for non-read-only access. +

+ +

+ For more information on the API, including + instructions for enabling API access, refer to the » Picasa + Web Albums Data API Overview. +

+ +

Note: Authentication
 + + + + The API provides authentication via AuthSub (recommended) + and ClientAuth. HTTP connections must be authenticated for write + support, but non-authenticated connections have read-only access. +
+

+ +

Connecting To The Service

+ + +

+ The Picasa Web Albums API, like all GData APIs, is + based off of the Atom Publishing Protocol (APP), an XML based format + for managing web-based resources. Traffic between a client and the servers occurs over + HTTP and allows for both authenticated and unauthenticated + connections. +

+ +

+ Before any transactions can occur, this connection needs to be made. Creating a + connection to the Picasa servers involves two steps: creating an HTTP + client and binding a Zend_Gdata_Photos + service instance to that client. +

+ +

Authentication

+ + +

+ The Google Picasa API allows access to both public and private + photo feeds. Public feeds do not require authentication, but are read-only and offer + reduced functionality. Private feeds offers the most complete functionality but + requires an authenticated connection to the Picasa servers. There are three + authentication schemes that are supported by Google Picasa : +

+ +
    +
  • +

    + ClientAuth + provides direct username/password authentication to the + Picasa servers. Since this scheme requires that users + provide your application with their password, this + authentication is only recommended when other + authentication schemes are insufficient. +

    +
    • + +
  • +

    + AuthSub + allows authentication to the Picasa servers via a + Google proxy server. This provides the same level of + convenience as ClientAuth but without the security + risk, making this an ideal choice for web-based + applications. +

    +
    • +
+ +

+ The + Zend_Gdata + library provides support for both authentication schemes. + The rest of this chapter will assume that you are familiar the + authentication schemes available and how to create an + appropriate authenticated connection. For more information, + please see section the + Authentication section + of this manual or the » Authentication Overview in the + Google Data API Developer's Guide. +

+
+ +

Creating A Service Instance

+ + +

+ In order to interact with the servers, this library provides the + Zend_Gdata_Photos service class. This class provides a common + interface to the Google Data and Atom Publishing Protocol models and assists in + marshaling requests to and from the servers. +

+ +

+ Once deciding on an authentication scheme, the next step is to create an instance of + Zend_Gdata_Photos. The class constructor takes an instance of + Zend_Http_Client as a single argument. This provides an + interface for AuthSub and ClientAuth authentication, as both of these require + creation of a special authenticated HTTP client. If no arguments + are provided, an unauthenticated instance of Zend_Http_Client + will be automatically created. +

+ +

+ The example below shows how to create a service class using ClientAuth + authentication: +

+ +
  1. // Parameters for ClientAuth authentication
    2. +
  2. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
    3. +
  3. $user = "sample.user@gmail.com";
    4. +
  4. $pass = "pa$$w0rd";
    5. +
  5.  
    6. +
  6. // Create an authenticated HTTP client
    7. +
  7. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
    8. +
  8.  
    9. +
  9. // Create an instance of the service
    10. +
  10. $service = new Zend_Gdata_Photos($client);
+ + +

+ A service instance using AuthSub can be created in a similar, though slightly more + lengthy fashion: +

+ +
    2. +
  2.  
    3. +
  3. /**
    4. +
  4. * Returns the full URL of the current page, based upon env variables
    5. +
  5. *
    6. +
  6. * Env variables used:
    7. +
  7. * $_SERVER['HTTPS'] = (on|off|)
    8. +
  8. * $_SERVER['HTTP_HOST'] = value of the Host: header
    9. +
  9. * $_SERVER['SERVER_PORT'] = port number (only used if not http/80,https/443)
    10. +
  10. * $_SERVER['REQUEST_URI'] = the URI after the method of the HTTP request
    11. +
  11. *
    12. +
  12. * @return string Current URL
    13. +
  13. */
    14. +
  14. function getCurrentUrl()
    15. +
  15. {
    16. +
  16.     global $_SERVER;
    17. +
  17.  
    18. +
  18.     /**
    19. +
  19.      * Filter php_self to avoid a security vulnerability.
    20. +
  20.      */
    21. +
  21.     $php_request_uri = htmlentities(substr($_SERVER['REQUEST_URI'], 0,
    22. +
  22.     strcspn($_SERVER['REQUEST_URI'], "\n\r")), ENT_QUOTES);
    23. +
  23.  
    24. +
  24.     if (isset($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) == 'on') {
    25. +
  25.         $protocol = 'https://';
    26. +
  26.     } else {
    27. +
  27.         $protocol = 'http://';
    28. +
  28.     }
    29. +
  29.     $host = $_SERVER['HTTP_HOST'];
    30. +
  30.     if ($_SERVER['SERVER_PORT'] != '' &&
    31. +
  31.         (($protocol == 'http://' && $_SERVER['SERVER_PORT'] != '80') ||
    32. +
  32.         ($protocol == 'https://' && $_SERVER['SERVER_PORT'] != '443'))) {
    33. +
  33.             $port = ':' . $_SERVER['SERVER_PORT'];
    34. +
  34.     } else {
    35. +
  35.         $port = '';
    36. +
  36.     }
    37. +
  37.     return $protocol . $host . $port . $php_request_uri;
    38. +
  38. }
    39. +
  39.  
    40. +
  40. /**
    41. +
  41. * Returns the AuthSub URL which the user must visit to authenticate requests
    42. +
  42. * from this application.
    43. +
  43. *
    44. +
  44. * Uses getCurrentUrl() to get the next URL which the user will be redirected
    45. +
  45. * to after successfully authenticating with the Google service.
    46. +
  46. *
    47. +
  47. * @return string AuthSub URL
    48. +
  48. */
    49. +
  49. function getAuthSubUrl()
    50. +
  50. {
    51. +
  51.     $next = getCurrentUrl();
    52. +
  52.     $scope = 'http://picasaweb.google.com/data';
    53. +
  53.     $secure = false;
    54. +
  54.     $session = true;
    55. +
  55.     return Zend_Gdata_AuthSub::getAuthSubTokenUri($next, $scope, $secure,
    56. +
  56.         $session);
    57. +
  57. }
    58. +
  58.  
    59. +
  59. /**
    60. +
  60. * Returns a HTTP client object with the appropriate headers for communicating
    61. +
  61. * with Google using AuthSub authentication.
    62. +
  62. *
    63. +
  63. * Uses the $_SESSION['sessionToken'] to store the AuthSub session token after
    64. +
  64. * it is obtained. The single use token supplied in the URL when redirected
    65. +
  65. * after the user succesfully authenticated to Google is retrieved from the
    66. +
  66. * $_GET['token'] variable.
    67. +
  67. *
    68. +
  68. * @return Zend_Http_Client
    69. +
  69. */
    70. +
  70. function getAuthSubHttpClient()
    71. +
  71. {
    72. +
  72.     global $_SESSION, $_GET;
    73. +
  73.     if (!isset($_SESSION['sessionToken']) && isset($_GET['token'])) {
    74. +
  74.         $_SESSION['sessionToken'] =
    75. +
  75.             Zend_Gdata_AuthSub::getAuthSubSessionToken($_GET['token']);
    76. +
  76.     }
    77. +
  77.     $client = Zend_Gdata_AuthSub::getHttpClient($_SESSION['sessionToken']);
    78. +
  78.     return $client;
    79. +
  79. }
    80. +
  80.  
    81. +
  81. /**
    82. +
  82. * Create a new instance of the service, redirecting the user
    83. +
  83. * to the AuthSub server if necessary.
    84. +
  84. */
    85. +
  85. $service = new Zend_Gdata_Photos(getAuthSubHttpClient());
+ + +

+ Finally, an unauthenticated server can be created for use with public feeds: +

+ +
  1. // Create an instance of the service using an unauthenticated HTTP client
    2. +
  2. $service = new Zend_Gdata_Photos();
+ +
+
+ +

Understanding and Constructing Queries

+ + +

+ The primary method to request data from the service is by constructing a query. There + are query classes for each of the following types: +

+ +
    +
  • +

    + User is used to specify the user whose data is being + searched for, and is specified as a username. if no user is provided, "default" + will be used instead to indicate the currently authenticated user (if + authenticated). +

    +
    • + +
  • +

    + Album is used to specify the album which is being + searched for, and is specified as either an id, or an album name. +

    +
    • + +
  • +

    + Photo is used to specify the photo which is being + searched for, and is specified as an id. +

    +
    • +
+ +

A new UserQuery can be constructed as followed:

+ +
  1. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
    2. +
  2. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
    3. +
  3. $service = new Zend_Gdata_Photos($client);
    4. +
  4.  
    5. +
  5. $query = new Zend_Gdata_Photos_UserQuery();
    6. +
  6. $query->setUser("sample.user");
+ + +

+ for each query, a number of parameters limiting the search can be requested, or + specified, with get(Parameter) and set(Parameter), respectively. They are as follows: +

+ +
    +
  • +

    + Projection sets the format of the data returned in the + feed, as either "api" or "base". Normally, "api" is desired. The default is + "api". +

    +
    • + +
  • +

    + Type sets the type of element to be returned, as either + "feed" or "entry". The default is "feed". +

    +
    • + +
  • +

    + Access sets the visibility of items to be returned, as + "all", "public", or "private". The default is "all". Non-public elements will + only be returned if the query is searching for the authenticated user. +

    +
    • + +
  • +

    + Tag sets a tag filter for returned items. When a tag is + set, only items tagged with this value will return. +

    +
    • + +
  • +

    + Kind sets the kind of elements to return. When kind is + specified, only entries that match this value will be returned. +

    +
    • + +
  • +

    + ImgMax sets the maximum image size for entries returned. + Only image entries smaller than this value will be returned. +

    +
    • + +
  • +

    + Thumbsize sets the thumbsize of entries that are + returned. Any retrieved entry will have a thumbsize equal to this value. +

    +
    • + +
  • +

    + User sets the user whose data is being searched for. The + default is "default". +

    +
    • + +
  • +

    + AlbumId sets the id of the album being searched for. This + element only applies to album and photo queries. In the case of photo queries, + this specifies the album that contains the requested photo. The album id is + mutually exclusive with the album's name. Setting one unsets the other. +

    +
    • + +
  • +

    + AlbumName sets the name of the album being searched for. + This element only applies to the album and photo queries. In the case of photo + queries, this specifies the album that contains the requested photo. The album + name is mutually exclusive with the album's id. Setting one unsets the other. +

    +
    • + +
  • +

    + PhotoId sets the id of the photo being searched for. This + element only applies to photo queries. +

    +
    • +
+
+ +

Retrieving Feeds And Entries

+ + +

+ The service has functions to retrieve a feed, or individual entries, for users, albums, + and individual photos. +

+ +

Retrieving A User

+ + +

+ The service supports retrieving a user feed and list of the user's content. If the + requested user is also the authenticated user, entries marked as + "hidden" will also be returned. +

+ +

+ The user feed can be accessed by passing the username to the + getUserFeed() method: +

+ +
  1. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
    2. +
  2. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
    3. +
  3. $service = new Zend_Gdata_Photos($client);
    4. +
  4.  
    5. +
  5. try {
    6. +
  6.     $userFeed = $service->getUserFeed("sample.user");
    7. +
  7. } catch (Zend_Gdata_App_Exception $e) {
    8. +
  8.     echo "Error: " . $e->getMessage();
    9. +
  9. }
+ + +

Or, the feed can be accessed by constructing a query, first:

+ +
  1. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
    2. +
  2. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
    3. +
  3. $service = new Zend_Gdata_Photos($client);
    4. +
  4.  
    5. +
  5. $query = new Zend_Gdata_Photos_UserQuery();
    6. +
  6. $query->setUser("sample.user");
    7. +
  7.  
    8. +
  8. try {
    9. +
  9.     $userFeed = $service->getUserFeed(null, $query);
    10. +
  10. } catch (Zend_Gdata_App_Exception $e) {
    11. +
  11.     echo "Error: " . $e->getMessage();
    12. +
  12. }
+ + +

+ Constructing a query also provides the ability to request a user entry object: +

+ +
  1. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
    2. +
  2. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
    3. +
  3. $service = new Zend_Gdata_Photos($client);
    4. +
  4.  
    5. +
  5. $query = new Zend_Gdata_Photos_UserQuery();
    6. +
  6. $query->setUser("sample.user");
    7. +
  7. $query->setType("entry");
    8. +
  8.  
    9. +
  9. try {
    10. +
  10.     $userEntry = $service->getUserEntry($query);
    11. +
  11. } catch (Zend_Gdata_App_Exception $e) {
    12. +
  12.     echo "Error: " . $e->getMessage();
    13. +
  13. }
+ +
+ +

Retrieving An Album

+ + +

+ The service supports retrieving an album feed and a list of the album's content. +

+ +

+ The album feed is accessed by constructing a query object and passing it to + getAlbumFeed(): +

+ +
  1. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
    2. +
  2. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
    3. +
  3. $service = new Zend_Gdata_Photos($client);
    4. +
  4.  
    5. +
  5. $query = new Zend_Gdata_Photos_AlbumQuery();
    6. +
  6. $query->setUser("sample.user");
    7. +
  7. $query->setAlbumId("1");
    8. +
  8.  
    9. +
  9. try {
    10. +
  10.     $albumFeed = $service->getAlbumFeed($query);
    11. +
  11. } catch (Zend_Gdata_App_Exception $e) {
    12. +
  12.     echo "Error: " . $e->getMessage();
    13. +
  13. }
+ + +

+ Alternatively, the query object can be given an album name with + setAlbumName(). Setting the album name is mutually + exclusive with setting the album id, and setting one will unset the other. +

+ +

+ Constructing a query also provides the ability to request an album entry object: +

+ +
  1. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
    2. +
  2. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
    3. +
  3. $service = new Zend_Gdata_Photos($client);
    4. +
  4.  
    5. +
  5. $query = new Zend_Gdata_Photos_AlbumQuery();
    6. +
  6. $query->setUser("sample.user");
    7. +
  7. $query->setAlbumId("1");
    8. +
  8. $query->setType("entry");
    9. +
  9.  
    10. +
  10. try {
    11. +
  11.     $albumEntry = $service->getAlbumEntry($query);
    12. +
  12. } catch (Zend_Gdata_App_Exception $e) {
    13. +
  13.     echo "Error: " . $e->getMessage();
    14. +
  14. }
+ +
+ +

Retrieving A Photo

+ + +

+ The service supports retrieving a photo feed and a list of associated comments and + tags. +

+ +

+ The photo feed is accessed by constructing a query object and passing it to + getPhotoFeed(): +

+ +
  1. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
    2. +
  2. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
    3. +
  3. $service = new Zend_Gdata_Photos($client);
    4. +
  4.  
    5. +
  5. $query = new Zend_Gdata_Photos_PhotoQuery();
    6. +
  6. $query->setUser("sample.user");
    7. +
  7. $query->setAlbumId("1");
    8. +
  8. $query->setPhotoId("100");
    9. +
  9.  
    10. +
  10. try {
    11. +
  11.     $photoFeed = $service->getPhotoFeed($query);
    12. +
  12. } catch (Zend_Gdata_App_Exception $e) {
    13. +
  13.     echo "Error: " . $e->getMessage();
    14. +
  14. }
+ + +

+ Constructing a query also provides the ability to request a photo entry object: +

+ +
  1. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
    2. +
  2. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
    3. +
  3. $service = new Zend_Gdata_Photos($client);
    4. +
  4.  
    5. +
  5. $query = new Zend_Gdata_Photos_PhotoQuery();
    6. +
  6. $query->setUser("sample.user");
    7. +
  7. $query->setAlbumId("1");
    8. +
  8. $query->setPhotoId("100");
    9. +
  9. $query->setType("entry");
    10. +
  10.  
    11. +
  11. try {
    12. +
  12.     $photoEntry = $service->getPhotoEntry($query);
    13. +
  13. } catch (Zend_Gdata_App_Exception $e) {
    14. +
  14.     echo "Error: " . $e->getMessage();
    15. +
  15. }
+ +
+ +

Retrieving A Comment

+ + +

+ The service supports retrieving comments from a feed of a different type. By setting + a query to return a kind of "comment", a feed request can return comments associated + with a specific user, album, or photo. +

+ +

+ Performing an action on each of the comments on a given photo can be accomplished + as follows: +

+ +
  1. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
    2. +
  2. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
    3. +
  3. $service = new Zend_Gdata_Photos($client);
    4. +
  4.  
    5. +
  5. $query = new Zend_Gdata_Photos_PhotoQuery();
    6. +
  6. $query->setUser("sample.user");
    7. +
  7. $query->setAlbumId("1");
    8. +
  8. $query->setPhotoId("100");
    9. +
  9. $query->setKind("comment");
    10. +
  10.  
    11. +
  11. try {
    12. +
  12.     $photoFeed = $service->getPhotoFeed($query);
    13. +
  13.  
    14. +
  14.     foreach ($photoFeed as $entry) {
    15. +
  15.         if ($entry instanceof Zend_Gdata_Photos_CommentEntry) {
    16. +
  16.             // Do something with the comment
    17. +
  17.         }
    18. +
  18.     }
    19. +
  19. } catch (Zend_Gdata_App_Exception $e) {
    20. +
  20.     echo "Error: " . $e->getMessage();
    21. +
  21. }
+ +
+ +

Retrieving A Tag

+ + +

+ The service supports retrieving tags from a feed of a different type. By setting a + query to return a kind of "tag", a feed request can return tags associated with a + specific photo. +

+ +

+ Performing an action on each of the tags on a given photo can be accomplished as + follows: +

+ +
  1. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
    2. +
  2. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
    3. +
  3. $service = new Zend_Gdata_Photos($client);
    4. +
  4.  
    5. +
  5. $query = new Zend_Gdata_Photos_PhotoQuery();
    6. +
  6. $query->setUser("sample.user");
    7. +
  7. $query->setAlbumId("1");
    8. +
  8. $query->setPhotoId("100");
    9. +
  9. $query->setKind("tag");
    10. +
  10.  
    11. +
  11. try {
    12. +
  12.     $photoFeed = $service->getPhotoFeed($query);
    13. +
  13.  
    14. +
  14.     foreach ($photoFeed as $entry) {
    15. +
  15.         if ($entry instanceof Zend_Gdata_Photos_TagEntry) {
    16. +
  16.             // Do something with the tag
    17. +
  17.         }
    18. +
  18.     }
    19. +
  19. } catch (Zend_Gdata_App_Exception $e) {
    20. +
  20.     echo "Error: " . $e->getMessage();
    21. +
  21. }
+ +
+
+ +

Creating Entries

+ + +

The service has functions to create albums, photos, comments, and tags.

+ +

Creating An Album

+ + +

The service supports creating a new album for an authenticated user:

+ +
  1. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
    2. +
  2. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
    3. +
  3. $service = new Zend_Gdata_Photos($client);
    4. +
  4.  
    5. +
  5. $entry = new Zend_Gdata_Photos_AlbumEntry();
    6. +
  6. $entry->setTitle($service->newTitle("test album"));
    7. +
  7.  
    8. +
  8. $service->insertAlbumEntry($entry);
+ +
+ +

Creating A Photo

+ + +

The service supports creating a new photo for an authenticated user:

+ +
  1. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
    2. +
  2. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
    3. +
  3. $service = new Zend_Gdata_Photos($client);
    4. +
  4.  
    5. +
  5. // $photo is the name of a file uploaded via an HTML form
    6. +
  6.  
    7. +
  7. $fd = $service->newMediaFileSource($photo["tmp_name"]);
    8. +
  8. $fd->setContentType($photo["type"]);
    9. +
  9.  
    10. +
  10. $entry = new Zend_Gdata_Photos_PhotoEntry();
    11. +
  11. $entry->setMediaSource($fd);
    12. +
  12. $entry->setTitle($service->newTitle($photo["name"]));
    13. +
  13.  
    14. +
  14. $albumQuery = new Zend_Gdata_Photos_AlbumQuery;
    15. +
  15. $albumQuery->setUser("sample.user");
    16. +
  16. $albumQuery->setAlbumId("1");
    17. +
  17.  
    18. +
  18. $albumEntry = $service->getAlbumEntry($albumQuery);
    19. +
  19.  
    20. +
  20. $service->insertPhotoEntry($entry, $albumEntry);
+ +
+ +

Creating A Comment

+ + +

The service supports creating a new comment for a photo:

+ +
  1. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
    2. +
  2. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
    3. +
  3. $service = new Zend_Gdata_Photos($client);
    4. +
  4.  
    5. +
  5. $entry = new Zend_Gdata_Photos_CommentEntry();
    6. +
  6. $entry->setTitle($service->newTitle("comment"));
    7. +
  7. $entry->setContent($service->newContent("comment"));
    8. +
  8.  
    9. +
  9. $photoQuery = new Zend_Gdata_Photos_PhotoQuery;
    10. +
  10. $photoQuery->setUser("sample.user");
    11. +
  11. $photoQuery->setAlbumId("1");
    12. +
  12. $photoQuery->setPhotoId("100");
    13. +
  13. $photoQuery->setType('entry');
    14. +
  14.  
    15. +
  15. $photoEntry = $service->getPhotoEntry($photoQuery);
    16. +
  16.  
    17. +
  17. $service->insertCommentEntry($entry, $photoEntry);
+ +
+ +

Creating A Tag

+ + +

The service supports creating a new tag for a photo:

+ +
  1. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
    2. +
  2. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
    3. +
  3. $service = new Zend_Gdata_Photos($client);
    4. +
  4.  
    5. +
  5. $entry = new Zend_Gdata_Photos_TagEntry();
    6. +
  6. $entry->setTitle($service->newTitle("tag"));
    7. +
  7.  
    8. +
  8. $photoQuery = new Zend_Gdata_Photos_PhotoQuery;
    9. +
  9. $photoQuery->setUser("sample.user");
    10. +
  10. $photoQuery->setAlbumId("1");
    11. +
  11. $photoQuery->setPhotoId("100");
    12. +
  12. $photoQuery->setType('entry');
    13. +
  13.  
    14. +
  14. $photoEntry = $service->getPhotoEntry($photoQuery);
    15. +
  15.  
    16. +
  16. $service->insertTagEntry($entry, $photoEntry);
+ +
+
+ +

Deleting Entries

+ + +

The service has functions to delete albums, photos, comments, and tags.

+ +

Deleting An Album

+ + +

The service supports deleting an album for an authenticated user:

+ +
  1. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
    2. +
  2. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
    3. +
  3. $service = new Zend_Gdata_Photos($client);
    4. +
  4.  
    5. +
  5. $albumQuery = new Zend_Gdata_Photos_AlbumQuery;
    6. +
  6. $albumQuery->setUser("sample.user");
    7. +
  7. $albumQuery->setAlbumId("1");
    8. +
  8. $albumQuery->setType('entry');
    9. +
  9.  
    10. +
  10. $entry = $service->getAlbumEntry($albumQuery);
    11. +
  11.  
    12. +
  12. $service->deleteAlbumEntry($entry, true);
+ +
+ +

Deleting A Photo

+ + +

The service supports deleting a photo for an authenticated user:

+ +
  1. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
    2. +
  2. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
    3. +
  3. $service = new Zend_Gdata_Photos($client);
    4. +
  4.  
    5. +
  5. $photoQuery = new Zend_Gdata_Photos_PhotoQuery;
    6. +
  6. $photoQuery->setUser("sample.user");
    7. +
  7. $photoQuery->setAlbumId("1");
    8. +
  8. $photoQuery->setPhotoId("100");
    9. +
  9. $photoQuery->setType('entry');
    10. +
  10.  
    11. +
  11. $entry = $service->getPhotoEntry($photoQuery);
    12. +
  12.  
    13. +
  13. $service->deletePhotoEntry($entry, true);
+ +
+ +

Deleting A Comment

+ + +

The service supports deleting a comment for an authenticated user:

+ +
  1. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
    2. +
  2. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
    3. +
  3. $service = new Zend_Gdata_Photos($client);
    4. +
  4.  
    5. +
  5. $photoQuery = new Zend_Gdata_Photos_PhotoQuery;
    6. +
  6. $photoQuery->setUser("sample.user");
    7. +
  7. $photoQuery->setAlbumId("1");
    8. +
  8. $photoQuery->setPhotoId("100");
    9. +
  9. $photoQuery->setType('entry');
    10. +
  10.  
    11. +
  11. $path = $photoQuery->getQueryUrl() . '/commentid/' . "1000";
    12. +
  12.  
    13. +
  13. $entry = $service->getCommentEntry($path);
    14. +
  14.  
    15. +
  15. $service->deleteCommentEntry($entry, true);
+ +
+ +

Deleting A Tag

+ + +

The service supports deleting a tag for an authenticated user:

+ +
  1. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
    2. +
  2. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
    3. +
  3. $service = new Zend_Gdata_Photos($client);
    4. +
  4.  
    5. +
  5. $photoQuery = new Zend_Gdata_Photos_PhotoQuery;
    6. +
  6. $photoQuery->setUser("sample.user");
    7. +
  7. $photoQuery->setAlbumId("1");
    8. +
  8. $photoQuery->setPhotoId("100");
    9. +
  9. $photoQuery->setKind("tag");
    10. +
  10. $query = $photoQuery->getQueryUrl();
    11. +
  11.  
    12. +
  12. $photoFeed = $service->getPhotoFeed($query);
    13. +
  13.  
    14. +
  14. foreach ($photoFeed as $entry) {
    15. +
  15.     if ($entry instanceof Zend_Gdata_Photos_TagEntry) {
    16. +
  16.         if ($entry->getContent() == $tagContent) {
    17. +
  17.             $tagEntry = $entry;
    18. +
  18.         }
    19. +
  19.     }
    20. +
  20. }
    21. +
  21.  
    22. +
  22. $service->deleteTagEntry($tagEntry, true);
+ +
+ +

Optimistic Concurrency (Notes On Deletion)

+ + +

+ GData feeds, including those of the Picasa Web Albums service, implement optimistic + concurrency, a versioning system that prevents users from overwriting changes, + inadvertently. When deleting a entry through the service class, if the entry has + been modified since it was last fetched, an exception will be thrown, unless + explicitly set otherwise (in which case the deletion is retried on the updated + entry). +

+ +

+ An example of how to handle versioning during a deletion is shown by + deleteAlbumEntry(): +

+ +
  1. // $album is the albumEntry to be deleted
    2. +
  2. try {
    3. +
  3.     $this->delete($album);
    4. +
  4. } catch (Zend_Gdata_App_HttpException $e) {
    5. +
  5.     if ($e->getMessage()->getStatus() === 409) {
    6. +
  6.         $entry =
    7. +
  7.             new Zend_Gdata_Photos_AlbumEntry($e->getMessage()->getBody());
    8. +
  8.         $this->delete($entry->getLink('edit')->href);
    9. +
  9.     } else {
    10. +
  10.         throw $e;
    11. +
  11.     }
    12. +
  12. }
+ +
+
+
+
+ + + + + + + + + +
+ Using Google Apps Provisioning + +
Zend_Gdata
+ Programmer's Reference Guide
+ 		+ +
+		 + +
+ + \ No newline at end of file -- cgit v1.2.3