Zend_Gdata_Photos.xml 33 KB

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