Zend_Gdata_Photos.xml 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752
  1. <!-- EN-Revision: 13842 -->
  2. <sect1 id="zend.gdata.photos">
  3. <title>Utilisation des albums Web Picasa</title>
  4. <para>Les albums Web Picasa représentent un service Google permettant de maintenir à jour des albums photos, tout en
  5. pouvant récupérer des photos de l'album d'un membre. L'API propose des services pour ajouter, mettre à jour ou
  6. supprimer des photos d'un album, de même que gérer des mots-clés ou des commentaires sur des images(photos).</para>
  7. <para>L'accès public à un album, en lecture donc, n'est pas sujet à demande d'authentification. En revanche, toute
  8. autre manipulation telle que la mise à jour ou la suppression, nécessitera que vous vous authentifiez.</para>
  9. <para>Pour plus d'informations sur l'API, voyez <ulink
  10. url="http://code.google.com/apis/picasaweb/overview.html">l'API Picasa Web Albums</ulink>.</para>
  11. <note>
  12. <title>Authentification</title>
  13. <para>L'API propose les deux modes d'authentification, AuthSub (recommandé) et ClientAuth. Pour toute opération
  14. d'écriture vers le service, une authentification sera demandée, la lecture est elle, libre, au regard de
  15. l'API.</para>
  16. </note>
  17. <sect2 id="zend.gdata.photos.connecting">
  18. <title>Se connecter au service</title>
  19. <para>L'API Picasa, comme tous les autres services Web Google Gdata, est basée sur le protocole Atom Publishing
  20. Protocol (APP), et le XML. Le trafic entre le client et le serveur se fait sur HTTP, et autorise des connexions
  21. authentifiées, ou non.</para>
  22. <para>Avant tout, il faut donc se connecter. Ceci se fait en deux étapes : créer un client HTTP, et insérer un
  23. <classname>Zend_Gdata_Photos</classname> dans celui-ci.</para>
  24. <sect3 id="zend.gdata.photos.connecting.authentication">
  25. <title>Authentification</title>
  26. <para>L'API propose un accès à la fois aux données publiques, et aux données privées. Les données publiques
  27. ne requièrent pas d'authentification, mais ne sont accessibles qu'en lecture seule. L'écriture et l'accès
  28. aux données privées requièrent une authentification, qui peut s'effectuer de trois manières différentes
  29. :</para>
  30. <itemizedlist>
  31. <listitem>
  32. <para><firstterm>ClientAuth</firstterm> permet une authentification directe en donnant un couple
  33. login/password. Les utilisateurs devront donc renseigner ces 2 paramètres sur votre site
  34. directement.</para>
  35. </listitem>
  36. <listitem>
  37. <para><firstterm>AuthSub</firstterm> permet l'authentification en passant par un serveur proxy de
  38. Google. Les risques liés à la sécurité sont donc moindre avec cette méthode.</para>
  39. </listitem>
  40. </itemizedlist>
  41. <para>La librairie <classname>Zend_Gdata</classname> permet ces 2 types d'authentification. Le reste de ce chapitre
  42. supposera que vous soyez habitué à l'authentification avec les service Web Google GData. Si ce n'est pas le
  43. cas, nous vous conseillons de consulter <link linkend="zend.gdata.introduction.authentication">la section
  44. authentification</link> de ce manuel, ou encore <ulink url="http://code.google.com/apis/gdata/auth.html">le
  45. guide d'authentification Google GData webservices API</ulink>.</para>
  46. </sect3>
  47. <sect3 id="zend.gdata.photos.connecting.service">
  48. <title>Créer une instance du service</title>
  49. <para>Pour interagir avec les serveurs, la classe <classname>Zend_Gdata_Photos</classname> sera nécessaire. Elle
  50. abstrait toute la logique de communication avec le Protocol Atom Publishing vers les serveurs de
  51. Google.</para>
  52. <para>Une fois que vous avez choisi une méthode d'authentification, vous devez créer une instance de
  53. <classname>Zend_Gdata_Photos</classname>. Le constructeur prend en paramètre une instance de
  54. <classname>Zend_Http_Client</classname>. Cette classe est l'interface AuthSub ou ClientAuth authentification. Si vous
  55. ne passez pas cette instance en argument, alors une instance de <classname>Zend_Http_Client</classname> sera crée
  56. automatiquement, mais en mode non authentifié.</para>
  57. <para>Voici un exemple qui démontre comment créer une classe vers le service avec le procédé
  58. d'authentification ClientAuth :</para>
  59. <programlisting role="php"><![CDATA[
  60. // Paramètres pour ClientAuth authentification
  61. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
  62. $user = "sample.user@gmail.com";
  63. $pass = "pa$$w0rd";
  64. // Création d'une client HTTP authentifié
  65. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
  66. // Création de l'instance du service
  67. $service = new Zend_Gdata_Photos($client);
  68. ]]></programlisting>
  69. <para>Au sujet du procédé AuthSub, voici la démarche :</para>
  70. <programlisting role="php"><![CDATA[
  71. session_start();
  72. /**
  73. * Retourne l'URL complet de la page actuelle,
  74. * en fonction des variables d'environnement
  75. *
  76. * Env variables utilisées:
  77. * $_SERVER['HTTPS'] = (on|off|)
  78. * $_SERVER['HTTP_HOST'] = value of the Host: header
  79. * $_SERVER['SERVER_PORT'] = port number (only used if not http/80,https/443)
  80. * $_SERVER['REQUEST_URI'] = the URI after the method of the HTTP request
  81. *
  82. * @return string Current URL
  83. */
  84. function getCurrentUrl()
  85. {
  86. global $_SERVER;
  87. /**
  88. * Filtre php_self pour éviter des problèmes de sécurité
  89. */
  90. $php_request_uri = htmlentities(substr($_SERVER['REQUEST_URI'], 0,
  91. strcspn($_SERVER['REQUEST_URI'], "\n\r")), ENT_QUOTES);
  92. if (isset($_SERVER['HTTPS'])
  93. && strtolower($_SERVER['HTTPS']) == 'on') {
  94. $protocol = 'https://';
  95. } else {
  96. $protocol = 'http://';
  97. }
  98. $host = $_SERVER['HTTP_HOST'];
  99. if ($_SERVER['SERVER_PORT'] != '' &&
  100. (($protocol == 'http://' && $_SERVER['SERVER_PORT'] != '80') ||
  101. ($protocol == 'https://' && $_SERVER['SERVER_PORT'] != '443'))) {
  102. $port = ':' . $_SERVER['SERVER_PORT'];
  103. } else {
  104. $port = '';
  105. }
  106. return $protocol . $host . $port . $php_request_uri;
  107. }
  108. /**
  109. * Retourne l'URL AuthSub que l'utilisateur doit visiter
  110. * pour authentifier ses requêtes
  111. *
  112. * Utilise getCurrentUrl() pour récupérer le prochain URL
  113. * vers lequel l'utilisateur sera redirigé après
  114. * s'être authentifié.
  115. *
  116. * @return string AuthSub URL
  117. */
  118. function getAuthSubUrl()
  119. {
  120. $next = getCurrentUrl();
  121. $scope = 'http://picasaweb.google.com/data';
  122. $secure = false;
  123. $session = true;
  124. return Zend_Gdata_AuthSub::getAuthSubTokenUri($next,
  125. $scope,
  126. $secure,
  127. $session);
  128. }
  129. /**
  130. * Retourne un objet servant de client HTTP avec les bons en-têtes,
  131. * permettant de communiquer avec les services Google, et utilisant
  132. * l'authentification AuthSub.
  133. *
  134. * Utilise $_SESSION['sessionToken'] pour stocker le jeton de session
  135. * AuthSub après l'avoir obtenu. $_GET['token'] récupère ce jeton
  136. * après la redirection d'authentification
  137. *
  138. * @return Zend_Http_Client
  139. */
  140. function getAuthSubHttpClient()
  141. {
  142. global $_SESSION, $_GET;
  143. if (!isset($_SESSION['sessionToken']) && isset($_GET['token'])) {
  144. $_SESSION['sessionToken'] =
  145. Zend_Gdata_AuthSub::getAuthSubSessionToken($_GET['token']);
  146. }
  147. $client =
  148. Zend_Gdata_AuthSub::getHttpClient($_SESSION['sessionToken']);
  149. return $client;
  150. }
  151. /**
  152. * Créer une instance du service, redirigeant l'utilisateur
  153. * vers le serveur AuthSub si nécéssaire.
  154. */
  155. $service = new Zend_Gdata_Photos(getAuthSubHttpClient());
  156. ]]></programlisting>
  157. <para>Enfin, un client non authentifié peut aussi être crée :</para>
  158. <programlisting role="php"><![CDATA[
  159. // Création d'une instance du service en mode non authentifié
  160. $service = new Zend_Gdata_Photos();
  161. ]]></programlisting>
  162. </sect3>
  163. </sect2>
  164. <sect2 id="zend.gdata.photos.queries">
  165. <title>Comprendre et construire des requêtes</title>
  166. <para>Pour créer des requêtes vers le service Web, vous devrez utiliser une de ces classes :</para>
  167. <itemizedlist>
  168. <listitem>
  169. <para><firstterm>User</firstterm> Cette classe requêtera tout ce qui concerne un utilisateur du service.
  170. Sans spécifier d'utilisateur, "default" sera utilisé.</para>
  171. </listitem>
  172. <listitem>
  173. <para><firstterm>Album</firstterm> Cette classe va servir de base pour toutes les requêtes concernant
  174. les albums Picasa.</para>
  175. </listitem>
  176. <listitem>
  177. <para><firstterm>Photo</firstterm> Cette classe va servir de base pour toutes les requêtes concernant
  178. les photos Picasa.</para>
  179. </listitem>
  180. </itemizedlist>
  181. <para>Une <code>UserQuery</code> peut être construite comme suit :</para>
  182. <programlisting role="php"><![CDATA[
  183. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
  184. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
  185. $service = new Zend_Gdata_Photos($client);
  186. $query = new Zend_Gdata_Photos_UserQuery();
  187. $query->setUser("sample.user");
  188. ]]></programlisting>
  189. <para>Pour chaque requête, des paramètres de limitations de la recherche peuvent être passés grâce aux méthodes
  190. get(Paramètre) and set(Paramètre) :</para>
  191. <itemizedlist>
  192. <listitem>
  193. <para><firstterm>Projection</firstterm> spécifie le format de retour des données dans le flux. Peut être
  194. "api" ou "base". En temps normal, "api" est conseillé, c'est la valeur par défaut d'ailleurs.</para>
  195. </listitem>
  196. <listitem>
  197. <para><firstterm>Type</firstterm> détermine le type des éléments retournés, "feed"(défaut) ou
  198. "entry".</para>
  199. </listitem>
  200. <listitem>
  201. <para><firstterm>Access</firstterm> détermine la visibilité des éléments retournés, "all"(défaut),
  202. "public", ou "private". Les éléments non publics ne seront retournés que si le client est
  203. authentifié.</para>
  204. </listitem>
  205. <listitem>
  206. <para><firstterm>Tag</firstterm> fournit un filtre par mots-clés sur les éléments retournés.</para>
  207. </listitem>
  208. <listitem>
  209. <para><firstterm>Kind</firstterm> détermine un filtre sur la sorte (le type) d'éléments
  210. retournés.</para>
  211. </listitem>
  212. <listitem>
  213. <para><firstterm>ImgMax</firstterm> spécifie un filtre par dimension maximale sur les éléments
  214. retournés.</para>
  215. </listitem>
  216. <listitem>
  217. <para><firstterm>Thumbsize</firstterm> spécifie un filtre par dimension maximale des miniatures
  218. retournées.</para>
  219. </listitem>
  220. <listitem>
  221. <para><firstterm>User</firstterm> spécifie l'utilisateur dont les éléments sont recherchés. Par défaut,
  222. "default".</para>
  223. </listitem>
  224. <listitem>
  225. <para><firstterm>AlbumId</firstterm> spécifie l'identifiant de l'album recherché. Ceci ne s'applique
  226. qu'aux requêtes album et photo. Dans le cas d'une recherche de photo, ceci indique l'album dans lequel
  227. effectuer la requête de recherche. Ce paramètre annule et remplace AlbumName, si spécifié.</para>
  228. </listitem>
  229. <listitem>
  230. <para><firstterm>AlbumName</firstterm> spécifie le nom de l'album recherché. Ceci ne s'applique qu'aux
  231. requêtes album et photo. Dans le cas d'une recherche de photo, ceci indique l'album dans lequel
  232. effectuer la requête de recherche. Ce paramètre annule et remplace AlbumId, si spécifié.</para>
  233. </listitem>
  234. <listitem>
  235. <para><firstterm>PhotoId</firstterm> spécifie l'identifiant de la photo recherchée. Ceci ne s'applique
  236. qu'aux requêtes photo.</para>
  237. </listitem>
  238. </itemizedlist>
  239. </sect2>
  240. <sect2 id="zend.gdata.photos.retrieval">
  241. <title>Récupérer des flux et des éléments</title>
  242. <para>Le service propose des méthodes de récupération de flux, ou d'éléments simples, concernant les
  243. utilisateurs, albums, ou photos.</para>
  244. <sect3 id="zend.gdata.photos.user_retrieval">
  245. <title>Récupérer un utilisateur</title>
  246. <para>Le service propose de récupérer un utilisateur, et toutes les infos de son flux, comme ses photos, ses
  247. albums.... Si le client est authentifié et demande des informations sur son propre compte, alors les
  248. éléments marqués comme "<code>hidden</code>" seront aussi retournés.</para>
  249. <para>Le flux de l'utilisateur est accessible en passant son nom à la méthode <code>getUserFeed</code>
  250. :</para>
  251. <programlisting role="php"><![CDATA[
  252. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
  253. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
  254. $service = new Zend_Gdata_Photos($client);
  255. try {
  256. $userFeed = $service->getUserFeed("sample.user");
  257. } catch (Zend_Gdata_App_Exception $e) {
  258. echo "Error: " . $e->getMessage();
  259. }
  260. ]]></programlisting>
  261. <para>Ou alors, le flux peut être requêté directement :</para>
  262. <programlisting role="php"><![CDATA[
  263. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
  264. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
  265. $service = new Zend_Gdata_Photos($client);
  266. $query = new Zend_Gdata_Photos_UserQuery();
  267. $query->setUser("sample.user");
  268. try {
  269. $userFeed = $service->getUserFeed(null, $query);
  270. } catch (Zend_Gdata_App_Exception $e) {
  271. echo "Error: " . $e->getMessage();
  272. }
  273. ]]></programlisting>
  274. <para>Construire une requête donne aussi accès aux éléments d'un utilisateur :</para>
  275. <programlisting role="php"><![CDATA[
  276. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
  277. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
  278. $service = new Zend_Gdata_Photos($client);
  279. $query = new Zend_Gdata_Photos_UserQuery();
  280. $query->setUser("sample.user");
  281. $query->setType("entry");
  282. try {
  283. $userEntry = $service->getUserEntry($query);
  284. } catch (Zend_Gdata_App_Exception $e) {
  285. echo "Error: " . $e->getMessage();
  286. }
  287. ]]></programlisting>
  288. </sect3>
  289. <sect3 id="zend.gdata.photos.album_retrieval">
  290. <title>Récupérer un album</title>
  291. <para>Le service donne accès aux flux d'albums et à leurs contenus.</para>
  292. <para>Le flux d'albums est disponible en construisant un objet de requête et en le passant à
  293. <code>getAlbumFeed</code> :</para>
  294. <programlisting role="php"><![CDATA[
  295. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
  296. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
  297. $service = new Zend_Gdata_Photos($client);
  298. $query = new Zend_Gdata_Photos_AlbumQuery();
  299. $query->setUser("sample.user");
  300. $query->setAlbumId("1");
  301. try {
  302. $albumFeed = $service->getAlbumFeed($query);
  303. } catch (Zend_Gdata_App_Exception $e) {
  304. echo "Error: " . $e->getMessage();
  305. }
  306. ]]></programlisting>
  307. <para>L'objet de requête accepte aussi un nom d'album avec <code>setAlbumName</code>. Attention, ceci annule
  308. un identifiant d'album éventuellement précédemment spécifié.</para>
  309. <para>Construire une requête donne aussi accès au requêtage d'un album :</para>
  310. <programlisting role="php"><![CDATA[
  311. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
  312. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
  313. $service = new Zend_Gdata_Photos($client);
  314. $query = new Zend_Gdata_Photos_AlbumQuery();
  315. $query->setUser("sample.user");
  316. $query->setAlbumId("1");
  317. $query->setType("entry");
  318. try {
  319. $albumEntry = $service->getAlbumEntry($query);
  320. } catch (Zend_Gdata_App_Exception $e) {
  321. echo "Error: " . $e->getMessage();
  322. }
  323. ]]></programlisting>
  324. </sect3>
  325. <sect3 id="zend.gdata.photos.photo_retrieval">
  326. <title>Récupérer une Photo</title>
  327. <para>Le service permet la récupération de flux de photos, et des commentaires et/ou mots-clés
  328. associés</para>
  329. <para>Le flux de photos est accessible en construisant un objet de requête et en le passant à la méthode
  330. <code>getPhotoFeed</code> :</para>
  331. <programlisting role="php"><![CDATA[
  332. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
  333. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
  334. $service = new Zend_Gdata_Photos($client);
  335. $query = new Zend_Gdata_Photos_PhotoQuery();
  336. $query->setUser("sample.user");
  337. $query->setAlbumId("1");
  338. $query->setPhotoId("100");
  339. try {
  340. $photoFeed = $service->getPhotoFeed($query);
  341. } catch (Zend_Gdata_App_Exception $e) {
  342. echo "Error: " . $e->getMessage();
  343. }
  344. ]]></programlisting>
  345. <para>Construire une requête donne aussi accès au requêtage d'une photo :</para>
  346. <programlisting role="php"><![CDATA[
  347. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
  348. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
  349. $service = new Zend_Gdata_Photos($client);
  350. $query = new Zend_Gdata_Photos_PhotoQuery();
  351. $query->setUser("sample.user");
  352. $query->setAlbumId("1");
  353. $query->setPhotoId("100");
  354. $query->setType("entry");
  355. try {
  356. $photoEntry = $service->getPhotoEntry($query);
  357. } catch (Zend_Gdata_App_Exception $e) {
  358. echo "Error: " . $e->getMessage();
  359. }
  360. ]]></programlisting>
  361. </sect3>
  362. <sect3 id="zend.gdata.photos.comment_retrieval">
  363. <title>Récupérer des commentaires</title>
  364. <para>Vous pouvez récupérer des commentaires depuis des éléments divers de flux. En spécifiant à votre
  365. requête un paramètre de "comment", celle-ci retournera les mots-clés associés à la ressource demandée (user,
  366. album ou photo)</para>
  367. <para>Voici comment effectuer des actions sur les commentaires récupérés d'une photo :</para>
  368. <programlisting role="php"><![CDATA[
  369. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
  370. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
  371. $service = new Zend_Gdata_Photos($client);
  372. $query = new Zend_Gdata_Photos_PhotoQuery();
  373. $query->setUser("sample.user");
  374. $query->setAlbumId("1");
  375. $query->setPhotoId("100");
  376. $query->setKind("comment");
  377. try {
  378. $photoFeed = $service->getPhotoFeed($query);
  379. foreach ($photoFeed as $entry) {
  380. if ($entry instanceof Zend_Gdata_Photos_CommentEntry) {
  381. // Faites quelque chose avec le commentaire
  382. }
  383. }
  384. } catch (Zend_Gdata_App_Exception $e) {
  385. echo "Error: " . $e->getMessage();
  386. }
  387. ]]></programlisting>
  388. </sect3>
  389. <sect3 id="zend.gdata.photos.tag_retrieval">
  390. <title>Récupérer des mots-clés</title>
  391. <para>Vous pouvez récupérer des mots-clés depuis des éléments divers de flux. En spécifiant à votre requête
  392. un paramètre de "tag", celle-ci retournera les mots-clés associés à la ressource demandée.</para>
  393. <para>Voici comment effectuer des actions sur les mots-clés récupérés d'une photo :</para>
  394. <programlisting role="php"><![CDATA[
  395. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
  396. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
  397. $service = new Zend_Gdata_Photos($client);
  398. $query = new Zend_Gdata_Photos_PhotoQuery();
  399. $query->setUser("sample.user");
  400. $query->setAlbumId("1");
  401. $query->setPhotoId("100");
  402. $query->setKind("tag");
  403. try {
  404. $photoFeed = $service->getPhotoFeed($query);
  405. foreach ($photoFeed as $entry) {
  406. if ($entry instanceof Zend_Gdata_Photos_TagEntry) {
  407. // Faites quelque chose avec le mot-clé
  408. }
  409. }
  410. } catch (Zend_Gdata_App_Exception $e) {
  411. echo "Error: " . $e->getMessage();
  412. }
  413. ]]></programlisting>
  414. </sect3>
  415. </sect2>
  416. <sect2 id="zend.gdata.photos.creation">
  417. <title>Créer des ressources</title>
  418. <para>Des opérations de création sont possible, qu'il s'agisse d'albums, photos, commentaires, ou
  419. mots-clés.</para>
  420. <sect3 id="zend.gdata.photos.album_creation">
  421. <title>Créer un album</title>
  422. <para>Il est possible de créer un album, pour les clients authentifiés :</para>
  423. <programlisting role="php"><![CDATA[
  424. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
  425. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
  426. $service = new Zend_Gdata_Photos($client);
  427. $entry = new Zend_Gdata_Photos_AlbumEntry();
  428. $entry->setTitle($service->newTitle("test album"));
  429. $service->insertAlbumEntry($entry);
  430. ]]></programlisting>
  431. </sect3>
  432. <sect3 id="zend.gdata.photos.photo_creation">
  433. <title>Créer une photo</title>
  434. <para>Créer une photo est possible pour les clients authentifiés, procédez comme suit :</para>
  435. <programlisting role="php"><![CDATA[
  436. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
  437. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
  438. $service = new Zend_Gdata_Photos($client);
  439. // $photo est le nom d'un fichier issu d'un formulaire d'uplaod
  440. $fd = $service->newMediaFileSource($photo["tmp_name"]);
  441. $fd->setContentType($photo["type"]);
  442. $entry = new Zend_Gdata_Photos_PhotoEntry();
  443. $entry->setMediaSource($fd);
  444. $entry->setTitle($service->newTitle($photo["name"]));
  445. $albumQuery = new Zend_Gdata_Photos_AlbumQuery;
  446. $albumQuery->setUser("sample.user");
  447. $albumQuery->setAlbumId("1");
  448. $albumEntry = $service->getAlbumEntry($albumQuery);
  449. $service->insertPhotoEntry($entry, $albumEntry);
  450. ]]></programlisting>
  451. </sect3>
  452. <sect3 id="zend.gdata.photos.comment_creation">
  453. <title>Créer un commentaire pour une photo</title>
  454. <para>Il est possible de créer un commentaire pour une photo, voici un exemple :</para>
  455. <programlisting role="php"><![CDATA[
  456. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
  457. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
  458. $service = new Zend_Gdata_Photos($client);
  459. $entry = new Zend_Gdata_Photos_CommentEntry();
  460. $entry->setTitle($service->newTitle("comment"));
  461. $entry->setContent($service->newContent("comment"));
  462. $photoQuery = new Zend_Gdata_Photos_PhotoQuery;
  463. $photoQuery->setUser("sample.user");
  464. $photoQuery->setAlbumId("1");
  465. $photoQuery->setPhotoId("100");
  466. $photoQuery->setType('entry');
  467. $photoEntry = $service->getPhotoEntry($photoQuery);
  468. $service->insertCommentEntry($entry, $photoEntry);
  469. ]]></programlisting>
  470. </sect3>
  471. <sect3 id="zend.gdata.photos.tag_creation">
  472. <title>Créer un mot-clé pour une photo</title>
  473. <para>Il est possible de créer un mot-clé pour une photo, voici un exemple :</para>
  474. <programlisting role="php"><![CDATA[
  475. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
  476. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
  477. $service = new Zend_Gdata_Photos($client);
  478. $entry = new Zend_Gdata_Photos_TagEntry();
  479. $entry->setTitle($service->newTitle("tag"));
  480. $photoQuery = new Zend_Gdata_Photos_PhotoQuery;
  481. $photoQuery->setUser("sample.user");
  482. $photoQuery->setAlbumId("1");
  483. $photoQuery->setPhotoId("100");
  484. $photoQuery->setType('entry');
  485. $photoEntry = $service->getPhotoEntry($photoQuery);
  486. $service->insertTagEntry($entry, $photoEntry);
  487. ]]></programlisting>
  488. </sect3>
  489. </sect2>
  490. <sect2 id="zend.gdata.photos.deletion">
  491. <title>Supprimer des éléments</title>
  492. <para>Il est possible de supprimer albums, photos, commentaires, et mots-clés.</para>
  493. <sect3 id="zend.gdata.photos.album_deletion">
  494. <title>Supprimer un album</title>
  495. <para>Supprimer un album est possible si le client est authentifié :</para>
  496. <programlisting role="php"><![CDATA[
  497. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
  498. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
  499. $service = new Zend_Gdata_Photos($client);
  500. $albumQuery = new Zend_Gdata_Photos_AlbumQuery;
  501. $albumQuery->setUser("sample.user");
  502. $albumQuery->setAlbumId("1");
  503. $albumQuery->setType('entry');
  504. $entry = $service->getAlbumEntry($albumQuery);
  505. $service->deleteAlbumEntry($entry, true);
  506. ]]></programlisting>
  507. </sect3>
  508. <sect3 id="zend.gdata.photos.photo_deletion">
  509. <title>Supprimer une photo</title>
  510. <para>Supprimer une photo est possible si le client est authentifié :</para>
  511. <programlisting role="php"><![CDATA[
  512. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
  513. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
  514. $service = new Zend_Gdata_Photos($client);
  515. $photoQuery = new Zend_Gdata_Photos_PhotoQuery;
  516. $photoQuery->setUser("sample.user");
  517. $photoQuery->setAlbumId("1");
  518. $photoQuery->setPhotoId("100");
  519. $photoQuery->setType('entry');
  520. $entry = $service->getPhotoEntry($photoQuery);
  521. $service->deletePhotoEntry($entry, true);
  522. ]]></programlisting>
  523. </sect3>
  524. <sect3 id="zend.gdata.photos.comment_deletion">
  525. <title>Supprimer un commentaire</title>
  526. <para>Supprimer un commentaire est possible si le client est authentifié :</para>
  527. <programlisting role="php"><![CDATA[
  528. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
  529. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
  530. $service = new Zend_Gdata_Photos($client);
  531. $photoQuery = new Zend_Gdata_Photos_PhotoQuery;
  532. $photoQuery->setUser("sample.user");
  533. $photoQuery->setAlbumId("1");
  534. $photoQuery->setPhotoId("100");
  535. $photoQuery->setType('entry');
  536. $path = $photoQuery->getQueryUrl() . '/commentid/' . "1000";
  537. $entry = $service->getCommentEntry($path);
  538. $service->deleteCommentEntry($entry, true);
  539. ]]></programlisting>
  540. </sect3>
  541. <sect3 id="zend.gdata.photos.tag_deletion">
  542. <title>Supprimer un mot-clé</title>
  543. <para>Supprimer un mot-clé est possible, si le client est authentifié :</para>
  544. <programlisting role="php"><![CDATA[
  545. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
  546. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
  547. $service = new Zend_Gdata_Photos($client);
  548. $photoQuery = new Zend_Gdata_Photos_PhotoQuery;
  549. $photoQuery->setUser("sample.user");
  550. $photoQuery->setAlbumId("1");
  551. $photoQuery->setPhotoId("100");
  552. $photoQuery->setKind("tag");
  553. $query = $photoQuery->getQueryUrl();
  554. $photoFeed = $service->getPhotoFeed($query);
  555. foreach ($photoFeed as $entry) {
  556. if ($entry instanceof Zend_Gdata_Photos_TagEntry) {
  557. if ($entry->getContent() == $tagContent) {
  558. $tagEntry = $entry;
  559. }
  560. }
  561. }
  562. $service->deleteTagEntry($tagEntry, true);
  563. ]]></programlisting>
  564. </sect3>
  565. <sect3 id="zend.gdata.photos.optimistic_concurrenty">
  566. <title>Gestion des accès concurrents</title>
  567. <para>Les flux GData, dont ceux de Picasa Web Albums, implémentent un système d'accès concurrent qui empêche
  568. les changements avec écrasements par inadvertance. Si vous demandez l'effacement d'une ressource qui a été
  569. modifiée depuis votre dernière requête, alors une exception sera levée, sauf si vous demandez le contraire
  570. explicitement (dans un tel cas, la procédure d'effacement sera réessayée sur l'élément mis à jour).</para>
  571. <para>Voici un exemple de gestion des versions et accès concurrent sur un effacement avec
  572. <code>deleteAlbumEntry</code>:</para>
  573. <programlisting role="php"><![CDATA[
  574. // $album est l'albumEntry à effacer
  575. try {
  576. $this->delete($album);
  577. } catch (Zend_Gdata_App_HttpException $e) {
  578. if ($e->getMessage()->getStatus() === 409) {
  579. $entry =
  580. new Zend_Gdata_Photos_AlbumEntry($e->getMessage()
  581. ->getBody());
  582. $this->delete($entry->getLink('edit')->href);
  583. } else {
  584. throw $e;
  585. }
  586. }
  587. ]]></programlisting>
  588. </sect3>
  589. </sect2>
  590. </sect1>