Zend_Gdata_Photos.xml 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 24249 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.gdata.photos">
  5. <title>Picasa Web Alben verwenden</title>
  6. <para>
  7. Picasa Web Alben ist ein Service der es Benutzer erlaubt Alben von Ihren eigenen Bildern zu
  8. verwalten, und die Alben und Bilder von anderen anzusehen. Die <acronym>API</acronym> bietet
  9. ein programmtechnisches Interface für diesen Service, der es Benutzer erlaubt hinzuzufügen,
  10. zu aktualisieren, und von Ihren Alben zu löschen, genauso wie die Möglichkeit Tags und
  11. Kommentare auf Fotos zu gestatten.
  12. </para>
  13. <para>
  14. Der Zugriff auf öffentliche Alben und Photos ist nicht durch einen Zugang beschränkt.
  15. Trotzdem muß ein Benutzer angemeldet sein für einen nicht-nur-lesenden Zugriff.
  16. </para>
  17. <para>
  18. Für weitere Informationen über die <acronym>API</acronym>, inklusive Anleitungen für das
  19. Aktivieren des <acronym>API</acronym> Zugriffs, sollte in die <ulink
  20. url="http://code.google.com/apis/picasaweb/overview.html">Picasa Web Alben Daten
  21. <acronym>API</acronym> Übersicht</ulink> gesehen werden.
  22. </para>
  23. <note>
  24. <title>Authentifizierung</title>
  25. <para>
  26. Die <acronym>API</acronym> bietet Authentifizierung über AuthSub (vorgeschlagen) und
  27. ClientAuth. <acronym>HTTP</acronym> Verbindungen müssen für einen Lesezugriff
  28. authentifiziert sein, aber nicht-authentifizierte Verbindungen haben nur-lesenden
  29. Zugriff.
  30. </para>
  31. </note>
  32. <sect2 id="zend.gdata.photos.connecting">
  33. <title>Zum Service verbinden</title>
  34. <para>
  35. Die Picasa Web Album <acronym>API</acronym> basiert, wie alle GData
  36. <acronym>API</acronym>s, auf dem Atom Publishing Protokoll (APP), einem
  37. <acronym>XML</acronym> basierenden Format für gemanagte web-basierende Ressourcen. Der
  38. Verkehr zwischen Client und den Servers tritt über <acronym>HTTP</acronym> auf, und
  39. erlaubt sowohl authentifizierte als auch nicht authentifizierte Verbindungen.
  40. </para>
  41. <para>
  42. Bevor irgendeine Transaktion stattfinden kann muß diese Verbindung hergestellt werden.
  43. Die Erstellung einer Verbindung zum Picasa Servern beinhaltet zwei Schritte:
  44. Erstellung eines <acronym>HTTP</acronym> Clients und Binden einer
  45. <classname>Zend_Gdata_Photos</classname> Instanz an diesen Client.
  46. </para>
  47. <sect3 id="zend.gdata.photos.connecting.authentication">
  48. <title>Authentifikation</title>
  49. <para>
  50. Die Google Picasa <acronym>API</acronym> erlaubt erlaubt den Zugriff sowohl auf
  51. öffentliche als auch auf private Kalender Feeds. Öffentliche Feeds benötigen keine
  52. Authentifizierung sind aber nur-lesend und bieten eine reduzierte Funktionalität.
  53. Private Feeds bieten die kompletteste Funktionalität benötigen aber eine
  54. authentifizierte Verbindung zum Picasa Server. Es gibt drei Authentifizierungs
  55. Schemata die von Google Picasa unterstützt werden:
  56. </para>
  57. <itemizedlist>
  58. <listitem>
  59. <para>
  60. <firstterm>ClientAuth</firstterm> bietet direkte Benutzername/Passwort
  61. Authentifizierung zu den Picasa Servern. Da dieses Schema erfordert das
  62. Benutzer die Anwendung mit Ihrem Passwort versorgen, ist diese
  63. Authentifizierung nur zu empfehlen wenn andere Authentifizierungs Schemas
  64. nicht anwendbar sind.
  65. </para>
  66. </listitem>
  67. <listitem>
  68. <para>
  69. <firstterm>AuthSub</firstterm> erlaubt die Authentifizierung zu den Picasa
  70. Servern über einen Google Proxy Server. Das bietet den gleichen Level von
  71. Bequemlichkeit wie ClientAuth aber ohne die Sicherheits Risiken, was es zu
  72. einer idealen Wahl für Web basierende Anwendungen macht.
  73. </para>
  74. </listitem>
  75. </itemizedlist>
  76. <para>
  77. Die <classname>Zend_Gdata</classname> Bibliothek bietet Unterstützung für beide
  78. Authentifizierungs Schemas. Der Rest dieses Kapitels nimmt an das die vorhandenen
  79. Authentifizierungs Schemas geläufig sind und wie eine korrekte Authentifizierte
  80. Verbindung erstellt wird. Für weitere Details kann in die <link
  81. linkend="zend.gdata.introduction.authentication">Authentifizierungs
  82. Sektion</link> dieses Handbuches, oder in die <ulink
  83. url="http://code.google.com/apis/gdata/auth.html">Authentifizierungs Übersicht
  84. im Google Data <acronym>API</acronym> Entwickler Guide</ulink> gesehen werden.
  85. </para>
  86. </sect3>
  87. <sect3 id="zend.gdata.photos.connecting.service">
  88. <title>Erstellen einer Service Instanz</title>
  89. <para>
  90. Um mit den Servern zu interagieren, bietet diese Bibliothek die
  91. <classname>Zend_Gdata_Photos</classname> Service Klasse. Diese Klasse bietet ein
  92. übliches Interface zu den Google Data und Atom Publishing Protocol Modellen und
  93. assistiert in der Behandlung der Anfragen zum und von den Kalender Servern.
  94. </para>
  95. <para>
  96. Sobald ein Authentifizierung Schema ausgewählt wurde, besteht der nächste Schritt
  97. darin eine Instanz von <classname>Zend_Gdata_Photos</classname> zu erstellen. Der
  98. Klassen Konstruktor nimmt eine Instanz von <classname>Zend_Http_Client</classname>
  99. als einzelnes Argument. Das bietet ein Interface für AuthSub und ClientAuth
  100. Authentifizierungen, da beide von Ihnen die Erstellung eines speziellen
  101. authentifizierten <acronym>HTTP</acronym> Clients benötigen. Wenn keine Argumente
  102. angegeben werden, wird automatisch eine unauthentifizierte Instanz von
  103. <classname>Zend_Http_Client</classname> erstellt.
  104. </para>
  105. <para>
  106. Das folgende Beispiel zeigt wie man eine Service Klasse erstellt und dabei die
  107. ClientAuth Authentifizierung verwendet:
  108. </para>
  109. <programlisting language="php"><![CDATA[
  110. // Parameter für die ClientAuth Authentifizierung
  111. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
  112. $user = "sample.user@gmail.com";
  113. $pass = "pa$$w0rd";
  114. // Erstellt einen authentifizierten HTTP Client
  115. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
  116. // Erstellt eine Instanz des Kalender Services
  117. $service = new Zend_Gdata_Photos($client);
  118. ]]></programlisting>
  119. <para>
  120. Eine Service Instanz die AuthSub verwendet, kann ähnlich erstellt werden, aber durch
  121. eine etwas längere Schreibweise:
  122. </para>
  123. <programlisting language="php"><![CDATA[
  124. session_start();
  125. /**
  126. * Gibt die komplette URL der aktuellen Seite zurück, basierend auf den env Variablen
  127. *
  128. * Verwendete Env Variablen:
  129. * $_SERVER['HTTPS'] = (on|off|)
  130. * $_SERVER['HTTP_HOST'] = Wert des Hosts: header
  131. * $_SERVER['SERVER_PORT'] = Port Nummer (nur verwendet wenn nicht http/80,https/443)
  132. * $_SERVER['REQUEST_URI'] = Die URI nach der Methode der HTTP Anfrage
  133. *
  134. * @return string Current URL
  135. */
  136. function getCurrentUrl()
  137. {
  138. global $_SERVER;
  139. /**
  140. * php_self filtern um Sicherheits Lücken zu vermeiden.
  141. */
  142. $php_request_uri = htmlentities(substr($_SERVER['REQUEST_URI'], 0,
  143. strcspn($_SERVER['REQUEST_URI'], "\n\r")), ENT_QUOTES);
  144. if (isset($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) == 'on') {
  145. $protocol = 'https://';
  146. } else {
  147. $protocol = 'http://';
  148. }
  149. $host = $_SERVER['HTTP_HOST'];
  150. if ($_SERVER['SERVER_PORT'] != '' &&
  151. (($protocol == 'http://' && $_SERVER['SERVER_PORT'] != '80') ||
  152. ($protocol == 'https://' && $_SERVER['SERVER_PORT'] != '443'))) {
  153. $port = ':' . $_SERVER['SERVER_PORT'];
  154. } else {
  155. $port = '';
  156. }
  157. return $protocol . $host . $port . $php_request_uri;
  158. }
  159. /**
  160. * Gibt die AuthSub URL zurück welche der Benutzer besuchen muß um Anfrage
  161. * dieser Anwendung zu authentifizieren
  162. *
  163. * Verwendet getCurrentUrl() um die nächste URL zu erhalten zu welcher der
  164. * Benutzer weitergeleitet wird nachdem er
  165. * sich erfolgreich beim Google Service authentifiziert hat.
  166. *
  167. * @return string AuthSub URL
  168. */
  169. function getAuthSubUrl()
  170. {
  171. $next = getCurrentUrl();
  172. $scope = 'http://picasaweb.google.com/data';
  173. $secure = false;
  174. $session = true;
  175. return Zend_Gdata_AuthSub::getAuthSubTokenUri($next, $scope, $secure,
  176. $session);
  177. }
  178. /**
  179. * Gibt ein HTTP Client Objekt mit den richtigen Headern für die Kommunikation
  180. * with Google zurück wobei
  181. * AuthSub Authentifizierung verwendet wird
  182. *
  183. * Verwendet $_SESSION['sessionToken'] um das AuthSub Session Token zu
  184. * speichern nachdem es erhalten wurde.
  185. * Das einmal verwendbare Token das in der URL bei der Umleitung angeboten wird
  186. * nachdem der Benutzer auf
  187. * Google erfolgreich authentifiziert wurde, wird von der $_GET['token']
  188. * Variable empfangen.
  189. *
  190. * @return Zend_Http_Client
  191. */
  192. function getAuthSubHttpClient()
  193. {
  194. global $_SESSION, $_GET;
  195. if (!isset($_SESSION['sessionToken']) && isset($_GET['token'])) {
  196. $_SESSION['sessionToken'] =
  197. Zend_Gdata_AuthSub::getAuthSubSessionToken($_GET['token']);
  198. }
  199. $client = Zend_Gdata_AuthSub::getHttpClient($_SESSION['sessionToken']);
  200. return $client;
  201. }
  202. /**
  203. * Erstellt eine neue Instant des Services und leitet den Benutzer zum AuthSub
  204. * Server um wenn das notwendig ist.
  205. */
  206. $service = new Zend_Gdata_Photos(getAuthSubHttpClient());
  207. ]]></programlisting>
  208. <para>
  209. Zuletzt kann ein nicht authentifizierter Server für die Verwendung mit öffentlichen
  210. Feeds erstellt werden:
  211. </para>
  212. <programlisting language="php"><![CDATA[
  213. // Erstellt eine Instanz des Services und verwendet einen nicht authentifizierten HTTP Client
  214. $service = new Zend_Gdata_Photos();
  215. ]]></programlisting>
  216. </sect3>
  217. </sect2>
  218. <sect2 id="zend.gdata.photos.queries">
  219. <title>Verstehen und Erstellen von Abfragen</title>
  220. <para>
  221. Die primäre Methode um Daten vom Service anzufragen ist die Erstellung einer Abfrage.
  222. Es gibt Abfrage Klassen für jede der folgenden Typen:
  223. </para>
  224. <itemizedlist>
  225. <listitem>
  226. <para>
  227. <firstterm>User</firstterm> wird verwendet um den Benutzer zu spezifizieren
  228. dessen Daten gesucht werden, und wird als EMail Adresse spezifiziert. Wenn kein
  229. Benutzer angegeben wurde, wird stattdessen "default" verwendet um den aktuellen
  230. authentifizierten Benutzer zu bezeichnen (wenn er authentifiziert wurde).
  231. </para>
  232. </listitem>
  233. <listitem>
  234. <para>
  235. <firstterm>Album</firstterm> wird verwendet um das Album zu spezifizieren das
  236. gesucht werden soll, und wird entweder als ID oder als Name des Albums
  237. spezifiziert.
  238. </para>
  239. </listitem>
  240. <listitem>
  241. <para>
  242. <firstterm>Photo</firstterm> wird verwendet um das Photo zu spezifizieren das
  243. gesucht werden soll, und wird als ID spezifiziert.
  244. </para>
  245. </listitem>
  246. </itemizedlist>
  247. <para>Eine neue <classname>UserQuery</classname> kann wie folgt erstellt werden:</para>
  248. <programlisting language="php"><![CDATA[
  249. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
  250. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
  251. $service = new Zend_Gdata_Photos($client);
  252. $query = new Zend_Gdata_Photos_UserQuery();
  253. $query->setUser("sample.user");
  254. ]]></programlisting>
  255. <para>
  256. Für jede Abfrage kann eine Anzahl an Parameter, welche die Suche limitieren, abgefragt,
  257. oder mit get(Parameter) und set(Parameter) spezifiziert werden. Diese sind wie folgt:
  258. </para>
  259. <itemizedlist>
  260. <listitem>
  261. <para>
  262. <firstterm>Projection</firstterm> setzt das Format der im Feed zurückgegebenen
  263. Daten entweder "api" oder "base". Normal wird "api" gewählt. "api" ist auch der
  264. Standardwert.
  265. </para>
  266. </listitem>
  267. <listitem>
  268. <para>
  269. <firstterm>Type</firstterm> setzt den Typ der Elemente die zurückgegeben werden,
  270. entweder "feed" oder "entry". Der Standardwert ist "feed".
  271. </para>
  272. </listitem>
  273. <listitem>
  274. <para>
  275. <firstterm>Access</firstterm> setzt die Sichtbarkeit von Teilen die
  276. zurückgegeben werden, mit "all", "public", oder "private". Der Standardwert ist
  277. "all". Nicht-öffentliche Elemente werden nur zurückgegeben wenn die Abfrage
  278. durch authentifizierte Benutzer gesucht wird.
  279. </para>
  280. </listitem>
  281. <listitem>
  282. <para>
  283. <firstterm>Tag</firstterm> setzt einen Tag Filter für zurückgegebenen Teile.
  284. Wenn ein Tag gesetzt ist werden nur Teile mit so einem Tag im Wert
  285. zurückgegeben.
  286. </para>
  287. </listitem>
  288. <listitem>
  289. <para>
  290. <firstterm>Kind</firstterm> setzt die Art von Elementen die zurückgegeben wird.
  291. Wenn eine Art spezifiziert wird, werden nur Einträge zurückgegeben die auf
  292. diesen Wert passen.
  293. </para>
  294. </listitem>
  295. <listitem>
  296. <para>
  297. <firstterm>ImgMax</firstterm> setzt das Maximum der Bildgröße für zurückgegebene
  298. Einträge. Nur Bildeinträge die kleiner als dieser Wert sind werden
  299. zurückgegeben.
  300. </para>
  301. </listitem>
  302. <listitem>
  303. <para>
  304. <firstterm>Thumbsize</firstterm> setzt die Vorschaugröße von Einträgen die
  305. zurückgegeben werden. Jeder empfangene Eintrag wird eine Vorschaugröße haben die
  306. diesem Wert entspricht.
  307. </para>
  308. </listitem>
  309. <listitem>
  310. <para>
  311. <firstterm>User</firstterm> setzt den Benutzer nach dessen Daten gesucht werden
  312. soll. Der Standardwert ist "default".
  313. </para>
  314. </listitem>
  315. <listitem>
  316. <para>
  317. <firstterm>AlbumId</firstterm> setzt die ID des Albums nachdem gesucht wird.
  318. Dieses Element ist nur für Album und Photo Abfragen gültig. Im Fall von Photo
  319. Abfragen spezifiziert dieser Wert das Album das die angefragten Photos enthält.
  320. Die Album ID schließt sich gegenseitig mit dem Album Namen aus. Das Setzen des
  321. einen Entfernt den anderen.
  322. </para>
  323. </listitem>
  324. <listitem>
  325. <para>
  326. <firstterm>AlbumName</firstterm> setzt den Namen des Albums nachdem gesucht
  327. wird. Dieses Element ist nur für Album und Photo Abfragen gültig. Im Fall von
  328. Photo Abfragen spezifiziert dieser Wert das Album das die angefragten Photos
  329. enthält. Der Album Name schließt sich gegenseitig mit der Album ID aus. Das
  330. Setzen des einen Entfernt den anderen.
  331. </para>
  332. </listitem>
  333. <listitem>
  334. <para>
  335. <firstterm>PhotoId</firstterm> setzt die ID des Photos nachdem gesucht wird.
  336. Dieses Element ist nur für Photo Abfragen gültig.
  337. </para>
  338. </listitem>
  339. </itemizedlist>
  340. </sect2>
  341. <sect2 id="zend.gdata.photos.retrieval">
  342. <title>Feeds und Einträge erhalten</title>
  343. <para>
  344. Das Service besitzt Funktionen um einen Feed oder individuelle Einträge für Benutzer,
  345. Alben, und individuelle Photos zu erhalten.
  346. </para>
  347. <sect3 id="zend.gdata.photos.user_retrieval">
  348. <title>Einen Benutzer erhalten</title>
  349. <para>
  350. Dieser Service unterstützt das Erhalten eines Benutzer Feeds und Listen von Benutzer
  351. Inhalten. Wenn der abgefragte Benutzer auch der authentifizierter Benutzer ist,
  352. werden auch Einträge die als "<emphasis>hidden</emphasis>" markiert sind,
  353. zurückgegeben.
  354. </para>
  355. <para>
  356. Auf den Benutzer Feed kann durch die Übergabe eines Benutzernamens an die
  357. <methodname>getUserFeed()</methodname> Methode zugegriffen werden:
  358. </para>
  359. <programlisting language="php"><![CDATA[
  360. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
  361. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
  362. $service = new Zend_Gdata_Photos($client);
  363. try {
  364. $userFeed = $service->getUserFeed("sample.user");
  365. } catch (Zend_Gdata_App_Exception $e) {
  366. echo "Fehler: " . $e->getMessage();
  367. }
  368. ]]></programlisting>
  369. <para>
  370. Oder, der auf den Feed kann zugegriffen werden indem zuerst eine Abfrage erstellt
  371. wird:
  372. </para>
  373. <programlisting language="php"><![CDATA[
  374. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
  375. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
  376. $service = new Zend_Gdata_Photos($client);
  377. $query = new Zend_Gdata_Photos_UserQuery();
  378. $query->setUser("sample.user");
  379. try {
  380. $userFeed = $service->getUserFeed(null, $query);
  381. } catch (Zend_Gdata_App_Exception $e) {
  382. echo "Fehler: " . $e->getMessage();
  383. }
  384. ]]></programlisting>
  385. <para>
  386. Die Erstellung einer Abfrage bietet auch die Möglichkeit ein Benutzer Eintrags
  387. Objekt abzufragen:
  388. </para>
  389. <programlisting language="php"><![CDATA[
  390. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
  391. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
  392. $service = new Zend_Gdata_Photos($client);
  393. $query = new Zend_Gdata_Photos_UserQuery();
  394. $query->setUser("sample.user");
  395. $query->setType("entry");
  396. try {
  397. $userEntry = $service->getUserEntry($query);
  398. } catch (Zend_Gdata_App_Exception $e) {
  399. echo "Fehler: " . $e->getMessage();
  400. }
  401. ]]></programlisting>
  402. </sect3>
  403. <sect3 id="zend.gdata.photos.album_retrieval">
  404. <title>Ein Album erhalten</title>
  405. <para>
  406. Der Service unterstützt auch das erhalten eines Album Feeds und von Listen des
  407. Inhalts von Alben.
  408. </para>
  409. <para>
  410. Auf einen Album Feed wird durch die Erstellung eines Abfrage Objekts zugegriffen und
  411. dessen Übergabe an <methodname>getAlbumFeed()</methodname>:
  412. </para>
  413. <programlisting language="php"><![CDATA[
  414. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
  415. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
  416. $service = new Zend_Gdata_Photos($client);
  417. $query = new Zend_Gdata_Photos_AlbumQuery();
  418. $query->setUser("sample.user");
  419. $query->setAlbumId("1");
  420. try {
  421. $albumFeed = $service->getAlbumFeed($query);
  422. } catch (Zend_Gdata_App_Exception $e) {
  423. echo "Fehler: " . $e->getMessage();
  424. }
  425. ]]></programlisting>
  426. <para>
  427. Alternativ kann dem Abfrage Objekt ein Album Name mit
  428. <methodname>setAlbumName()</methodname> angegeben werden. Das Setzen des Album
  429. Namens schließt sich gegenseitig mit der Album ID aus und das Setzen des einen
  430. entfernt den anderen Wert.
  431. </para>
  432. <para>
  433. Die Erstellung einer Abfragen bietet auch die Möglichkeit ein Album Eintrags Objekt
  434. abzufragen:
  435. </para>
  436. <programlisting language="php"><![CDATA[
  437. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
  438. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
  439. $service = new Zend_Gdata_Photos($client);
  440. $query = new Zend_Gdata_Photos_AlbumQuery();
  441. $query->setUser("sample.user");
  442. $query->setAlbumId("1");
  443. $query->setType("entry");
  444. try {
  445. $albumEntry = $service->getAlbumEntry($query);
  446. } catch (Zend_Gdata_App_Exception $e) {
  447. echo "Fehler: " . $e->getMessage();
  448. }
  449. ]]></programlisting>
  450. </sect3>
  451. <sect3 id="zend.gdata.photos.photo_retrieval">
  452. <title>Ein Photo erhalten</title>
  453. <para>
  454. Der Service unterstützt auch das erhalten eines Photo Feeds und von Listen von
  455. zugeordneten Kommentaren und Tags.
  456. </para>
  457. <para>
  458. Auf einen Photo Feed wird durch die Erstellung eines Abfrage Objekts zugegriffen und
  459. dessen Übergabe an <methodname>getPhotoFeed()</methodname>:
  460. </para>
  461. <programlisting language="php"><![CDATA[
  462. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
  463. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
  464. $service = new Zend_Gdata_Photos($client);
  465. $query = new Zend_Gdata_Photos_PhotoQuery();
  466. $query->setUser("sample.user");
  467. $query->setAlbumId("1");
  468. $query->setPhotoId("100");
  469. try {
  470. $photoFeed = $service->getPhotoFeed($query);
  471. } catch (Zend_Gdata_App_Exception $e) {
  472. echo "Fehler: " . $e->getMessage();
  473. }
  474. ]]></programlisting>
  475. <para>
  476. Die Erstellung einer Abfragen bietet auch die Möglichkeit ein Photo Eintrags Objekt
  477. abzufragen:
  478. </para>
  479. <programlisting language="php"><![CDATA[
  480. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
  481. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
  482. $service = new Zend_Gdata_Photos($client);
  483. $query = new Zend_Gdata_Photos_PhotoQuery();
  484. $query->setUser("sample.user");
  485. $query->setAlbumId("1");
  486. $query->setPhotoId("100");
  487. $query->setType("entry");
  488. try {
  489. $photoEntry = $service->getPhotoEntry($query);
  490. } catch (Zend_Gdata_App_Exception $e) {
  491. echo "Fehler: " . $e->getMessage();
  492. }
  493. ]]></programlisting>
  494. </sect3>
  495. <sect3 id="zend.gdata.photos.comment_retrieval">
  496. <title>Ein Kommentar erhalten</title>
  497. <para>
  498. Der Service unterstützt den Erhalt von Kommentaren von einem Feed eines anderen
  499. Typs. Durch das Setzen der Abfrage das eine Art von "Kommentar" zurückgegeben wird,
  500. kann eine Feed Anfrage mit einem speziellen Benutzer, Album oder Photo assoziierte
  501. Kommentare zurückgeben.
  502. </para>
  503. <para>
  504. Die Durchführung von Aktionen auf jedem der Kommentare eines gegebenen Photos kann
  505. die folgt vollendet werden:
  506. </para>
  507. <programlisting language="php"><![CDATA[
  508. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
  509. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
  510. $service = new Zend_Gdata_Photos($client);
  511. $query = new Zend_Gdata_Photos_PhotoQuery();
  512. $query->setUser("sample.user");
  513. $query->setAlbumId("1");
  514. $query->setPhotoId("100");
  515. $query->setKind("comment");
  516. try {
  517. $photoFeed = $service->getPhotoFeed($query);
  518. foreach ($photoFeed as $entry) {
  519. if ($entry instanceof Zend_Gdata_Photos_CommentEntry) {
  520. // Mach irgendwas mit dem Kommentar
  521. }
  522. }
  523. } catch (Zend_Gdata_App_Exception $e) {
  524. echo "Fehler: " . $e->getMessage();
  525. }
  526. ]]></programlisting>
  527. </sect3>
  528. <sect3 id="zend.gdata.photos.tag_retrieval">
  529. <title>Ein Tag erhalten</title>
  530. <para>
  531. Der Service unterstützt den Erhalt von Tags von einem Feed eines anderen Typs. Durch
  532. das Setzen der Abfrage das eine Art von "Tag" zurückgegeben wird, kann eine Feed
  533. Anfrage mit einem speziellen Photo assoziierte Tags zurückgeben.
  534. </para>
  535. <para>
  536. Das Ausführen einer Aktrion auf jedem Tag an gegebenen Photos kann wie folgt
  537. durchgeführt werden:
  538. </para>
  539. <programlisting language="php"><![CDATA[
  540. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
  541. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
  542. $service = new Zend_Gdata_Photos($client);
  543. $query = new Zend_Gdata_Photos_PhotoQuery();
  544. $query->setUser("sample.user");
  545. $query->setAlbumId("1");
  546. $query->setPhotoId("100");
  547. $query->setKind("tag");
  548. try {
  549. $photoFeed = $service->getPhotoFeed($query);
  550. foreach ($photoFeed as $entry) {
  551. if ($entry instanceof Zend_Gdata_Photos_TagEntry) {
  552. // Mach irgendwas mit dem Tag
  553. }
  554. }
  555. } catch (Zend_Gdata_App_Exception $e) {
  556. echo "Fehler: " . $e->getMessage();
  557. }
  558. ]]></programlisting>
  559. </sect3>
  560. </sect2>
  561. <sect2 id="zend.gdata.photos.creation">
  562. <title>Einträge erstellen</title>
  563. <para>
  564. Der Service hat Funktionen für die Erstellung von Alben, Photos, Kommentaren und Tags.
  565. </para>
  566. <sect3 id="zend.gdata.photos.album_creation">
  567. <title>Ein Album erstellen</title>
  568. <para>
  569. Der Service unterstützt die Erstellung eines neues Albums für authentifizierte
  570. Benutzer:
  571. </para>
  572. <programlisting language="php"><![CDATA[
  573. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
  574. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
  575. $service = new Zend_Gdata_Photos($client);
  576. $entry = new Zend_Gdata_Photos_AlbumEntry();
  577. $entry->setTitle($service->newTitle("test album"));
  578. $service->insertAlbumEntry($entry);
  579. ]]></programlisting>
  580. </sect3>
  581. <sect3 id="zend.gdata.photos.photo_creation">
  582. <title>Ein Photo erstellen</title>
  583. <para>
  584. Der Service unterstützt die Erstellung eines neuen Photos für authentifizierte
  585. Benutzer:
  586. </para>
  587. <programlisting language="php"><![CDATA[
  588. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
  589. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
  590. $service = new Zend_Gdata_Photos($client);
  591. // $photo ist der Name der Datei die durch ein HTML Formular hochgeladen wurde
  592. $fd = $service->newMediaFileSource($photo["tmp_name"]);
  593. $fd->setContentType($photo["type"]);
  594. $entry = new Zend_Gdata_Photos_PhotoEntry();
  595. $entry->setMediaSource($fd);
  596. $entry->setTitle($service->newTitle($photo["name"]));
  597. $albumQuery = new Zend_Gdata_Photos_AlbumQuery;
  598. $albumQuery->setUser("sample.user");
  599. $albumQuery->setAlbumId("1");
  600. $albumEntry = $service->getAlbumEntry($albumQuery);
  601. $service->insertPhotoEntry($entry, $albumEntry);
  602. ]]></programlisting>
  603. </sect3>
  604. <sect3 id="zend.gdata.photos.comment_creation">
  605. <title>Erstellen eines Kommentars</title>
  606. <para>Das Service unterstützt die Erstellung von neuen Kommentaren für ein Photo:</para>
  607. <programlisting language="php"><![CDATA[
  608. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
  609. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
  610. $service = new Zend_Gdata_Photos($client);
  611. $entry = new Zend_Gdata_Photos_CommentEntry();
  612. $entry->setTitle($service->newTitle("comment"));
  613. $entry->setContent($service->newContent("comment"));
  614. $photoQuery = new Zend_Gdata_Photos_PhotoQuery;
  615. $photoQuery->setUser("sample.user");
  616. $photoQuery->setAlbumId("1");
  617. $photoQuery->setPhotoId("100");
  618. $photoQuery->setType('entry');
  619. $photoEntry = $service->getPhotoEntry($photoQuery);
  620. $service->insertCommentEntry($entry, $photoEntry);
  621. ]]></programlisting>
  622. </sect3>
  623. <sect3 id="zend.gdata.photos.tag_creation">
  624. <title>Erstellen eines Tags</title>
  625. <para>Das Service unterstützt die Erstellung von neuen Tags für ein Photo:</para>
  626. <programlisting language="php"><![CDATA[
  627. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
  628. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
  629. $service = new Zend_Gdata_Photos($client);
  630. $entry = new Zend_Gdata_Photos_TagEntry();
  631. $entry->setTitle($service->newTitle("tag"));
  632. $photoQuery = new Zend_Gdata_Photos_PhotoQuery;
  633. $photoQuery->setUser("sample.user");
  634. $photoQuery->setAlbumId("1");
  635. $photoQuery->setPhotoId("100");
  636. $photoQuery->setType('entry');
  637. $photoEntry = $service->getPhotoEntry($photoQuery);
  638. $service->insertTagEntry($entry, $photoEntry);
  639. ]]></programlisting>
  640. </sect3>
  641. </sect2>
  642. <sect2 id="zend.gdata.photos.deletion">
  643. <title>Einträge löschen</title>
  644. <para>Der Service hat Funktionen um Alben, Photos, Kommentare und Tags zu löschen.</para>
  645. <sect3 id="zend.gdata.photos.album_deletion">
  646. <title>Ein Album löschen</title>
  647. <para>
  648. Der Service unterstützt das Löschen von Alben für authentifizierte Benutzer:
  649. </para>
  650. <programlisting language="php"><![CDATA[
  651. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
  652. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
  653. $service = new Zend_Gdata_Photos($client);
  654. $albumQuery = new Zend_Gdata_Photos_AlbumQuery;
  655. $albumQuery->setUser("sample.user");
  656. $albumQuery->setAlbumId("1");
  657. $albumQuery->setType('entry');
  658. $entry = $service->getAlbumEntry($albumQuery);
  659. $service->deleteAlbumEntry($entry, true);
  660. ]]></programlisting>
  661. </sect3>
  662. <sect3 id="zend.gdata.photos.photo_deletion">
  663. <title>Löschen eines Photos</title>
  664. <para>
  665. Der Service unterstützt das Löschen von Photos für authentifizierte Benutzer:
  666. </para>
  667. <programlisting language="php"><![CDATA[
  668. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
  669. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
  670. $service = new Zend_Gdata_Photos($client);
  671. $photoQuery = new Zend_Gdata_Photos_PhotoQuery;
  672. $photoQuery->setUser("sample.user");
  673. $photoQuery->setAlbumId("1");
  674. $photoQuery->setPhotoId("100");
  675. $photoQuery->setType('entry');
  676. $entry = $service->getPhotoEntry($photoQuery);
  677. $service->deletePhotoEntry($entry, true);
  678. ]]></programlisting>
  679. </sect3>
  680. <sect3 id="zend.gdata.photos.comment_deletion">
  681. <title>Ein Kommentar löschen</title>
  682. <para>
  683. Der Service unterstützt das Löschen von Kommentaren für authentifizierte Benutzer:
  684. </para>
  685. <programlisting language="php"><![CDATA[
  686. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
  687. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
  688. $service = new Zend_Gdata_Photos($client);
  689. $photoQuery = new Zend_Gdata_Photos_PhotoQuery;
  690. $photoQuery->setUser("sample.user");
  691. $photoQuery->setAlbumId("1");
  692. $photoQuery->setPhotoId("100");
  693. $photoQuery->setType('entry');
  694. $path = $photoQuery->getQueryUrl() . '/commentid/' . "1000";
  695. $entry = $service->getCommentEntry($path);
  696. $service->deleteCommentEntry($entry, true);
  697. ]]></programlisting>
  698. </sect3>
  699. <sect3 id="zend.gdata.photos.tag_deletion">
  700. <title>Ein Tag löschen</title>
  701. <para>
  702. Das Service unterstützt das Löschen eines Tags für authentifizierte Benutzer:
  703. </para>
  704. <programlisting language="php"><![CDATA[
  705. $service = Zend_Gdata_Photos::AUTH_SERVICE_NAME;
  706. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
  707. $service = new Zend_Gdata_Photos($client);
  708. $photoQuery = new Zend_Gdata_Photos_PhotoQuery;
  709. $photoQuery->setUser("sample.user");
  710. $photoQuery->setAlbumId("1");
  711. $photoQuery->setPhotoId("100");
  712. $photoQuery->setKind("tag");
  713. $query = $photoQuery->getQueryUrl();
  714. $photoFeed = $service->getPhotoFeed($query);
  715. foreach ($photoFeed as $entry) {
  716. if ($entry instanceof Zend_Gdata_Photos_TagEntry) {
  717. if ($entry->getContent() == $tagContent) {
  718. $tagEntry = $entry;
  719. }
  720. }
  721. }
  722. $service->deleteTagEntry($tagEntry, true);
  723. ]]></programlisting>
  724. </sect3>
  725. <sect3 id="zend.gdata.photos.optimistic_concurrenty">
  726. <title>Optimistische Gleichzeitigkeit (Notizen für das Löschen)</title>
  727. <para>
  728. GData Feeds, inklusive denen des Picasa Web Album Services, implementieren
  729. optimistische Gleichzeitigkeit, ein Versionsverwaltungs System das vermeidet das
  730. Benutzer irrtümlich Änderungen überschreiben. Wenn ein Eintrag durch die Service
  731. Klasse gelöscht wird, wenn der Eintrag geändert wurde seit er zuletzt geholt wurde,
  732. wird eine Ausnahme geworfen, solange das nicht explizit anders gesetzt wurde (in
  733. diesem Fall wird die Löschung auf dem aktualisierten Eintrag durchgeführt).
  734. </para>
  735. <para>
  736. Ein Beispiel davon wie die Versionierung während einer Löschung handzuhaben ist wird
  737. durch <methodname>deleteAlbumEntry()</methodname> gezeigt:
  738. </para>
  739. <programlisting language="php"><![CDATA[
  740. // $album ist ein albumEntry der gelöscht werden soll
  741. try {
  742. $this->delete($album);
  743. } catch (Zend_Gdata_App_HttpException $e) {
  744. if ($e->getMessage->getStatus() === 409) {
  745. $entry =
  746. new Zend_Gdata_Photos_AlbumEntry($e->getMessage()->getBody());
  747. $this->delete($entry->getLink('edit')->href);
  748. } else {
  749. throw $e;
  750. }
  751. }
  752. ]]></programlisting>
  753. </sect3>
  754. </sect2>
  755. </sect1>