2
0

Zend_Gdata_Photos.xml 33 KB

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