Zend_Gdata_Calendar.xml 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 15156 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.gdata.calendar">
  5. <title>Google Kalender verwenden</title>
  6. <para>
  7. Die <classname>Zend_Gdata_Calendar</classname> Klasse kann verwendet werden um Events im Online Google Kalender
  8. Service zu sehen, erstellen, updaten und löschen.
  9. </para>
  10. <para>
  11. Siehe
  12. <ulink url="http://code.google.com/apis/calendar/overview.html">http://code.google.com/apis/calendar/overview.html</ulink>
  13. für weitere Informationen über die Google Kalender API.
  14. </para>
  15. <sect2 id="zend.gdata.calendar.connecting">
  16. <title>Zum Kalender Service verbinden</title>
  17. <para>
  18. Die Google Kalender API basiert, wie alle GData APIs, auf dem Atom Publishing Protocol (APP), einem
  19. XML basierenden Format für gemanagte Web-basierte Ressourcen. Verkehr zwischen einem Client und den
  20. Google Kalender Servern läuft über HTTP und erlaubt sowohl authentifizierte als auch unauthentifizierte
  21. Verbindungen.
  22. </para>
  23. <para>
  24. Bevor irgendeine Transaktion stattfinden kann, muß diese Verbindung erstellt werden. Die Erstellung
  25. einer Verbindung zu den Kalender Server beinhaltet zwei Schritte: Erstellung eines HTTP Clients und
  26. das binden einer <classname>Zend_Gdata_Calendar</classname> Instanz an diesen Client.
  27. </para>
  28. <sect3 id="zend.gdata.calendar.connecting.authentication">
  29. <title>Authentifizierung</title>
  30. <para>
  31. Die Google Kalender API erlaubt den Zugriff auf beide, öffentliche und private, Kalender Feeds.
  32. Öfentliche Foods benötigen keine Authentifizierung, aber sie können nur gelesen werden und bieten
  33. reduzierte Funktionalitäten. Private Feeds bieten die kompletteste Funktionalität benötigen aber
  34. eine authentifizierte Verbindung zu den Kalender Servern. Es gibt drei Authentifizierungs
  35. Schemas die von Google Kalender unterstützt werden:
  36. </para>
  37. <itemizedlist>
  38. <listitem>
  39. <para>
  40. <firstterm>ClientAuth</firstterm> bietet direkte Benutzername/Passwort Authentifizierung
  41. zu den Kalender Servern. Da dieses Schema erfordert das Benutzer die Anwendung mit Ihrem
  42. Passwort versorgen, ist diese Authentifizierung nur zu empfehlen wenn andere
  43. Authentifizierungs Schemas nicht anwendbar sind.
  44. </para>
  45. </listitem>
  46. <listitem>
  47. <para>
  48. <firstterm>AuthSub</firstterm> erlaubt die Authentifizierung zu den Kalender Servern über
  49. einen Google Proxy Server. Das bietet den gleichen Level von Bequemlichkeit wie
  50. ClientAuth aber ohne die Sicherheits Risiken, was es zu einer idealen Wahl für Web
  51. basierende Anwendungen macht.
  52. </para>
  53. </listitem>
  54. <listitem>
  55. <para>
  56. <firstterm>MagicCookie</firstterm> erlaubt die Authentifizierung basieren auf einer
  57. semi-zufälligen URL von immerhalb des Google Kalender Interfaces. Das ist das einfachste
  58. Authentifizierungs Schema das implmentiert werden kann, erzwingt aber das Benutzer
  59. ihre Sicherheits URL manuell empfangen, bevor sie sich authentifizieren können, und ist
  60. limitiert auf nur-lesenden Zugriff.
  61. </para>
  62. </listitem>
  63. </itemizedlist>
  64. <para>
  65. Die <classname>Zend_Gdata</classname> Bibliothek bietet Unterstützung für alle drei Authentifizierungs
  66. Schemas. Der Rest dieses Kapitels nimmt an das die vorhandenen Authentifizierungs Schemas
  67. geläufig sind und wie eine korrekte Authentifizierte Verbindung erstellt wird. Für weitere Details
  68. kann in die <link linkend="zend.gdata.introduction.authentication">Authentifizierungs Sektion</link>
  69. dieses Handbuches, oder in die
  70. <ulink url="http://code.google.com/apis/gdata/auth.html">Authentifizierungs Übersicht im Google Data API Entwickler Guide</ulink>.
  71. gesehen werden.
  72. </para>
  73. </sect3>
  74. <sect3 id="zend.gdata.calendar.connecting.service">
  75. <title>Eine Service Instanz erstellen</title>
  76. <para>
  77. Um mit dem Google Kalender zu interagieren, bietet diese Bibliothek die
  78. <classname>Zend_Gdata_Calendar</classname> Service Klasse. Diese Klasse bietet ein übliches Interface zu den
  79. Google Data und Atom Publishing Protocol Modellen und assistiert in der Behandlung der Anfragen
  80. zum und von den Kalender Servern.
  81. </para>
  82. <para>
  83. Sobald ein Authentifizierung Schema ausgewählt wurde, besteht der nächste Schritt darin eine
  84. Instanz von <classname>Zend_Gdata_Calendar</classname> zu erstellen. Der Klassen Konstruktor nimmt eine
  85. Instanz von <classname>Zend_Http_Client</classname> als einzelnes Argument. Das bietet ein Interface für
  86. AuthSub und ClientAuth Authentifizierungen, da beide von Ihnen die Erstellung eines speziellen
  87. authentifizierten HTTP Clients benötigen. Wenn keine Argumente angegeben werden, wird
  88. automatisch eine unauthentifizierte Instanz von <classname>Zend_Http_Client</classname> erstellt.
  89. </para>
  90. <para>
  91. Das folgende Beispiel zeigt wie man eine Kalender Service Klasse erstellt und dabei die
  92. ClientAuth Authentifizierung verwendet:
  93. </para>
  94. <programlisting role="php"><![CDATA[
  95. // Parameter für die ClientAuth Authentifizierung
  96. $service = Zend_Gdata_Calendar::AUTH_SERVICE_NAME;
  97. $user = "sample.user@gmail.com";
  98. $pass = "pa$$w0rd";
  99. // Erstellt einen authentifizierten HTTP Client
  100. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
  101. // Erstellt eine Instanz des Kalender Services
  102. $service = new Zend_Gdata_Calendar($client);
  103. ]]></programlisting>
  104. <para>
  105. Ein Kalender Service der AuthSub verwendet, kann ähnlich erstellt werden, durch eine etwas längere
  106. Schreibweise:
  107. </para>
  108. <programlisting role="php"><![CDATA[
  109. /*
  110. * Empfängt die aktuelle URL so das der AuthSub Server weiß wohin er den
  111. * Benutzer umleiten soll nachdem die Authentifizierung komplett ist.
  112. */
  113. function getCurrentUrl()
  114. {
  115. global $_SERVER;
  116. // Filtert php_self um Sicherheitsprobleme zu vermeiden.
  117. $php_request_uri =
  118. htmlentities(substr($_SERVER['REQUEST_URI'],
  119. 0,
  120. strcspn($_SERVER['REQUEST_URI'], "\n\r")),
  121. ENT_QUOTES);
  122. if (isset($_SERVER['HTTPS']) &&
  123. strtolower($_SERVER['HTTPS']) == 'on') {
  124. $protocol = 'https://';
  125. } else {
  126. $protocol = 'http://';
  127. }
  128. $host = $_SERVER['HTTP_HOST'];
  129. if ($_SERVER['HTTP_PORT'] != '' &&
  130. (($protocol == 'http://' && $_SERVER['HTTP_PORT'] != '80') ||
  131. ($protocol == 'https://' && $_SERVER['HTTP_PORT'] != '443'))) {
  132. $port = ':' . $_SERVER['HTTP_PORT'];
  133. } else {
  134. $port = '';
  135. }
  136. return $protocol . $host . $port . $php_request_uri;
  137. }
  138. /**
  139. * Einen AuthSub authentifizierten HTTP Client nehmen, der den Benutzer
  140. * zum AuthSub Server zum Login umleitet wenn es notwendig ist.
  141. */
  142. function getAuthSubHttpClient()
  143. {
  144. global $_SESSION, $_GET;
  145. // Wenn es keine AuthSub Session oder einmal-benutzbares Token gibt die auf
  146. // uns warten, den Benutzer zum AuthSub Server umleiten um Ihn zu erhalten
  147. if (!isset($_SESSION['sessionToken']) && !isset($_GET['token'])) {
  148. // Parameter für den AuthSub Server
  149. $next = getCurrentUrl();
  150. $scope = "http://www.google.com/calendar/feeds/";
  151. $secure = false;
  152. $session = true;
  153. // Den Benutzer zum AuthSub server umleiten zur Anmeldung
  154. $authSubUrl = Zend_Gdata_AuthSub::getAuthSubTokenUri($next,
  155. $scope,
  156. $secure,
  157. $session);
  158. header("HTTP/1.0 307 Temporary redirect");
  159. header("Location: " . $authSubUrl);
  160. exit();
  161. }
  162. // Konvertiert ein AuthSub einmal-benutzbares Token in ein Session
  163. // Token wenn das notwendig ist
  164. if (!isset($_SESSION['sessionToken']) && isset($_GET['token'])) {
  165. $_SESSION['sessionToken'] =
  166. Zend_Gdata_AuthSub::getAuthSubSessionToken($_GET['token']);
  167. }
  168. // An diesem Punkt sind wir authentifiziert über AuthSub und können
  169. // eine authentifizierte HTTP Client Instanz holen
  170. // Erstellt einen authentifizierte HTTP Client
  171. $client = Zend_Gdata_AuthSub::getHttpClient($_SESSION['sessionToken']);
  172. return $client;
  173. }
  174. // -> Skript Bearbeitung beginnt hier <-
  175. // Sicher stellen das der Benutzer eine gültige Session hat, sodas der
  176. // AuthSub Session Token gespeichert werden kann sobald er vorhanden ist
  177. session_start();
  178. // Erstellt eine Instanz des Kalender Services, und leitet den Benutzer
  179. // zum AuthSub Server um wenn das notwendig ist.
  180. $service = new Zend_Gdata_Calendar(getAuthSubHttpClient());
  181. ]]></programlisting>
  182. <para>
  183. Schlußendlich, kann ein nicht authentifizierter Server erstellt werden um Ihn entweder mit
  184. öffentlichen Feeds oder MagicCookie Authentifizierung zu verwenden:</para>
  185. <programlisting role="php"><![CDATA[
  186. // Erstellt eine Instanz des Kalender Services wobei ein nicht
  187. // authentifizierter HTTP Client verwendet wird
  188. $service = new Zend_Gdata_Calendar();
  189. ]]></programlisting>
  190. <para>
  191. Es ist zu beachten das die MagicCookie Authentifizierung nicht mit der HTTP Verbindung
  192. unterstützt wird, sonder stattdessen wärend der gewählten Sichtbarkeit spezifiziert wird,
  193. wärend Anfragen abgeschickt werden. Siehe die folgende Sektion über das empfangen von Events
  194. für ein Beispiel.
  195. </para>
  196. </sect3>
  197. </sect2>
  198. <sect2 id="zend.gdata.calendar_retrieval">
  199. <title>Eine Kalender Liste empfangen</title>
  200. <para>
  201. Der Kalender Service unterstützt den Empfang einer Liste von Kalendern für den authentifizierten
  202. Benutzer. Das ist die gleiche Liste von Kalendern welche im Google Kalender UI angezeigt werden,
  203. ausser das jene die als "<code>hidden</code>" markiert sind, auch vorhanden sind.
  204. </para>
  205. <para>
  206. Die Kalender Liste ist immer privat und es muß über eine authentifizierte Verbindung darauf
  207. zugegriffen werden. Es ist nicht möglich eine Kalender Liste eines anderen Benutzers zu erhalten und
  208. es kann nicht darauf zugegriffen werden wenn die MagicCookie Authentifizierung verwendet wird.
  209. Der Versuch auf eine Kalender Liste zuzugreifen ohne das die notwendigen Zugriffsrechte vorhanden
  210. sind, wird fehlschlagen und in einem 401 (Authentifizierung benötigt) Statuc Code resultieren.
  211. </para>
  212. <programlisting role="php"><![CDATA[
  213. $service = Zend_Gdata_Calendar::AUTH_SERVICE_NAME;
  214. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
  215. $service = new Zend_Gdata_Calendar($client);
  216. try {
  217. $listFeed= $service->getCalendarListFeed();
  218. } catch (Zend_Gdata_App_Exception $e) {
  219. echo "Fehler: " . $e->getMessage();
  220. }
  221. ]]></programlisting>
  222. <para>
  223. Der Aufruf von <code>getCalendarListFeed()</code> erstellt eine neue Instanz von
  224. <classname>Zend_Gdata_Calendar_ListFeed</classname> die jeden vorhandenen Kalender als Instanz von
  225. <classname>Zend_Gdata_Calendar_ListEntry</classname> enthält. Nachdem der Feed empfangen wurde, können der
  226. Iterator und der Accessor die innerhalb des Feeds enthalten sind, verwendet werden um die enthaltenen
  227. Kalender zu inspizieren.
  228. </para>
  229. <programlisting role="php"><![CDATA[
  230. echo "<h1>Kalender Feed Liste</h1>";
  231. echo "<ul>";
  232. foreach ($listFeed as $calendar) {
  233. echo "<li>" . $calendar->title .
  234. " (Event Feed: " . $calendar->id . ")</li>";
  235. }
  236. echo "</ul>";
  237. ]]></programlisting>
  238. </sect2>
  239. <sect2 id="zend.gdata.event_retrieval">
  240. <title>Events erhalten</title>
  241. <para>
  242. Wie die Liste der Kalender können auch die Events empfangen werden durch Verwendung der
  243. <classname>Zend_Gdata_Calendar</classname> Service Klasse. Die zurückgegebene Event Liste ist vom Typ
  244. <classname>Zend_Gdata_Calendar_EventFeed</classname> und enthält jedes Event als Instanz von
  245. <classname>Zend_Gdata_Calendar_EventEntry</classname>. Wie vorher, erlauben die in der Instanz des Event Feeds
  246. enthaltenen Accessoren und der Iterator das individuelle Events inspiziert werden können.
  247. </para>
  248. <sect3 id="zend.gdata.event_retrieval.queries">
  249. <title>Abfragen</title>
  250. <para>
  251. Wenn Events mit der Kalender API empfangen werden, werden speziell erstellte Abfrage URLs verwendet
  252. um zu beschreiben welche Events zurückgegeben werden sollten. Die
  253. <classname>Zend_Gdata_Calendar_EventQuery</classname> Klasse vereinfacht diese Aufgabe durch
  254. automatische Erstellung einer Abfrage URL basierend auf den gegebenen Parametern. Eine komplette
  255. Liste dieser Parameter ist in der
  256. <ulink url="http://code.google.com/apis/gdata/reference.html#Queries">Abfrage Sektion des
  257. Google Data API Protokoll Referenz</ulink> enthalten. Trotzdem gibt es drei Parameter die es
  258. Wert sind speziell genannt zu werden:
  259. </para>
  260. <itemizedlist>
  261. <listitem>
  262. <para>
  263. <firstterm>User</firstterm> wird verwendet um den Benutzer zu spezifizieren dessen
  264. Kalender gesucht wird, und wird als EMail Adresse spezifiziert. Wenn kein Benutzer
  265. angegeben wurde, wird stattdessen "default" verwendet um den aktuellen authentifizierten
  266. Benutzer anzuzeigen (wenn er authentifiziert wurde).
  267. </para>
  268. </listitem>
  269. <listitem>
  270. <para>
  271. <firstterm>Visibility</firstterm> spezifiziert ob der öffentliche oder private Kalender
  272. eines Benutzers gesucht werden soll. Wenn eine nicht authentifizierte Session verwendet
  273. wird und kein MagicCookie vorhanden ist, ist nur der öffentliche Feed vorhanden.
  274. </para>
  275. </listitem>
  276. <listitem>
  277. <para>
  278. <firstterm>Projection</firstterm> spezifiziert wieviele Daten vom Server zurückgegeben
  279. werden sollen, und in welchem Format. In den meisten Fällen wird man die komplette
  280. ("full") Projektion verwenden wollen. Auch die normale ("basic") Projektion ist vorhanden,
  281. welche die meisten Meta-Daten in jedem Inhaltsfeld der Events als menschlich lesbaren
  282. Text plaziert, und die kombinierte ("composite") Projketion welche den kompletten
  283. text für jedes Kommentar entlang jedes Events inkludiert. Die kombinierte ("composite")
  284. Ansicht ist oft viel größer als die komplette ("full") Ansicht.
  285. </para>
  286. </listitem>
  287. </itemizedlist>
  288. </sect3>
  289. <sect3 id="zend.gdata.event_retrieval.start_time">
  290. <title>Events in der Reihenfolge Ihres Startzeitpunktes erhalten</title>
  291. <para>
  292. Das folgende Beispiel zeigt die Verwendung der <classname>Zend_Gdata_Query</classname> Klasse und spezifiziert
  293. den privat sichtbaren Feed, welcher eine vorhandene authentifizierte Verbindung zu den Kalender
  294. Servern benötigt. Wenn ein MagicCookie für die Authentifizierung verwendet wird, sollte die
  295. Sichtbarkeit zuerst auf "<code>private-magicCookieValue</code>" gesetzt werden, sobei
  296. magicCookieValue der zufälliger String ist, der erhalten wird, wenn man die private XML Adresse
  297. im Google Kalender UI betrachtet. Events werden chronologisch anhand des Startzeitpunktes angefragt
  298. und nur Events die in der Zukunft stattfinden werden zurückgegeben.
  299. </para>
  300. <programlisting role="php"><![CDATA[
  301. $query = $service->newEventQuery();
  302. $query->setUser('default');
  303. // Setze $query->setVisibility('private-magicCookieValue') wenn
  304. // MagicCookie Authentifizierung verwendet wird
  305. $query->setVisibility('private');
  306. $query->setProjection('full');
  307. $query->setOrderby('starttime');
  308. $query->setFutureevents('true');
  309. // Empfängt die Event Liste vom Kalender Server
  310. try {
  311. $eventFeed = $service->getCalendarEventFeed($query);
  312. } catch (Zend_Gdata_App_Exception $e) {
  313. echo "Fehler: " . $e->getMessage();
  314. }
  315. // Iteriere durch die Liste der Events und gib Sie als HTML Liste aus
  316. echo "<ul>";
  317. foreach ($eventFeed as $event) {
  318. echo "<li>" . $event->title . " (Event ID: " . $event->id . ")</li>";
  319. }
  320. echo "</ul>";
  321. ]]></programlisting>
  322. <para>
  323. Zusätzliche Eigenschaften wie ID, Autor, Wann, Event Status, Sichtbarkeit, Web Inhalt, und Inhalt,
  324. sowie andere sind innerhalb von <classname>Zend_Gdata_Calendar_EventEntry</classname> vorhanden. Siehe die
  325. <ulink url="http://framework.zend.com/apidoc/core/">Zend Framework API Dokumentation</ulink> und
  326. die <ulink url="http://code.google.com/apis/gdata/reference.html">Lalender Protokol Referenz</ulink>
  327. für eine komplette Liste.
  328. </para>
  329. </sect3>
  330. <sect3 id="zend.gdata.event_retrieval.date_range">
  331. <title>Events in einem speziellen Datumsbereich empfangen</title>
  332. <para>
  333. Um alle Events in einem gewünschten Bereich auszugeben, zum Beispiel vom 1. Dezember 2006 bis zum
  334. 15. Dezember 2006, müssen die folgenden zwei Zeilen im vorhergehenden Beispiel hinzugefügt werden.
  335. Es ist zu beachten das "<code>$query->setFutureevents('true')</code>" entfernt werden muß, da
  336. <code>futureevents</code> die Werte von <code>startMin</code> und <code>startMax</code>
  337. überschreibt.
  338. </para>
  339. <programlisting role="php"><![CDATA[
  340. $query->setStartMin('2006-12-01');
  341. $query->setStartMax('2006-12-16');
  342. ]]></programlisting>
  343. <para>
  344. Es ist zu beachten das <code>startMin</code> inklusive ist, wobei <code>startMax</code> exklusive
  345. ist. Als Ergebnis, werden nur die Events bis 2006-12-15 23:59:59 zurückgegeben.
  346. </para>
  347. </sect3>
  348. <sect3 id="zend.gdata.event_retrieval.fulltext">
  349. <title>Events durch eine Volltext Abfrage erhalten</title>
  350. <para>
  351. Um alle Events auszugeben welche ein spezielles Wort, zum Beispiel "Hundefutter" enthalten,
  352. muß die <code>setQuery()</code> Methode verwendet werden wenn die Abfrage erstellt wird.
  353. </para>
  354. <programlisting role="php"><![CDATA[
  355. $query->setQuery("Hundefutter");
  356. ]]></programlisting>
  357. </sect3>
  358. <sect3 id="zend.gdata.event_retrieval.individual">
  359. <title>Individuelle Events erhalten</title>
  360. <para>
  361. Individuelle Events können empfangen werden indem deren Event ID als Teil der Abfrage spezifiziert
  362. wird. Statt <code>getCalendarEventFeed()</code> auszurufen, sollte
  363. <code>getCalendarEventEntry()</code> aufgerufen werden.
  364. </para>
  365. <programlisting role="php"><![CDATA[
  366. $query = $service->newEventQuery();
  367. $query->setUser('default');
  368. $query->setVisibility('private');
  369. $query->setProjection('full');
  370. $query->setEvent($eventId);
  371. try {
  372. $event = $service->getCalendarEventEntry($query);
  373. } catch (Zend_Gdata_App_Exception $e) {
  374. echo "Fehler: " . $e->getMessage();
  375. }
  376. ]]></programlisting>
  377. <para>
  378. In einer ähnlichen Weise kann Sie, wenn die Event URL bekannt ist, direkt an
  379. <code>getCalendarEntry()</code> übergeben werden um ein spezielles Event zu erhalten. In diesem
  380. Fall wird kein Abfrage Objekt benötigt da die Event URL alle notwendigen Informationen enthält um
  381. das Event zu erhalten.
  382. </para>
  383. <programlisting role="php"><![CDATA[
  384. $eventURL = "http://www.google.com/calendar/feeds/default/private"
  385. . "/full/g829on5sq4ag12se91d10uumko";
  386. try {
  387. $event = $service->getCalendarEventEntry($eventURL);
  388. } catch (Zend_Gdata_App_Exception $e) {
  389. echo "Fehler: " . $e->getMessage();
  390. }
  391. ]]></programlisting>
  392. </sect3>
  393. </sect2>
  394. <sect2 id="zend.gdata.calendar.creating_events">
  395. <title>Events erstellen</title>
  396. <sect3 id="zend.gdata.calendar.creating_events.single">
  397. <title>Ein einmal vorkommendes Event erstellen</title>
  398. <para>
  399. Events werden einem Kalender hinzugefügt indem eine Instanz von <classname>Zend_Gdata_EventEntry</classname>
  400. erstellt wird, und diese mit den richtigen Daten bekanntgegeben wird. Die Kalender Service Instanz
  401. (<classname>Zend_Gdata_Calendar</classname>) wird dann verwendet um das Event transparent in XML zu
  402. konvertieren und diese an den Kalender Server zu senden.
  403. </para>
  404. <para>Mindestens die folgenden Attribute sollten gesetzt werden:</para>
  405. <itemizedlist>
  406. <listitem>
  407. <para>
  408. <firstterm>Title</firstterm> enthält die Kopfzeile die über jedem Event innerhalb der
  409. Google Kalender UI angezeigt wird.
  410. </para>
  411. </listitem>
  412. <listitem>
  413. <para>
  414. <firstterm>When</firstterm> zeigt die Dauer des Events und, optional, jede Erinnerung die
  415. mit Ihm assoziiert ist. Siehe in die nächste Sektion für mehr Informationen über dieses
  416. Attribut.
  417. </para>
  418. </listitem>
  419. </itemizedlist>
  420. <para>Andere nützliche Attribute die optional gesetzt werden können sind unter anderem:</para>
  421. <itemizedlist>
  422. <listitem>
  423. <para>
  424. <firstterm>Author</firstterm> liefert Informationen über den Benutzer der das Event
  425. erstellt hat.
  426. </para>
  427. </listitem>
  428. <listitem>
  429. <para>
  430. <firstterm>Content</firstterm> liefert zusätzliche Information über das Event und wird
  431. angezeigt wenn die Event Details innerhalb des Google Kalenders angefragt werden.
  432. </para>
  433. </listitem>
  434. <listitem>
  435. <para>
  436. <firstterm>EventStatus</firstterm> zeigt an ob ein Event bestätigt, in Wartestellung
  437. oder abgebrochen wurde.
  438. </para>
  439. </listitem>
  440. <listitem>
  441. <para>
  442. <firstterm>Hidden</firstterm> entfernt das Event von der Google Kalender UI.
  443. </para>
  444. </listitem>
  445. <listitem>
  446. <para>
  447. <firstterm>Transparency</firstterm> zeigt ob das Event Zeit auf der Frei/Belegt Liste
  448. des Benutzers benötigt.
  449. </para>
  450. </listitem>
  451. <listitem>
  452. <para>
  453. <firstterm>WebContent</firstterm> erlaubt es externe Inhalte zu verlinken und innerhalb
  454. eines Events anzubieten.
  455. </para>
  456. </listitem>
  457. <listitem>
  458. <para>
  459. <firstterm>Where</firstterm> indiziert den Ort des Events.
  460. </para>
  461. </listitem>
  462. <listitem>
  463. <para>
  464. <firstterm>Visibility</firstterm> erlaubt es das Event vor der öffentlichen Event Liste
  465. zu verstecken.
  466. </para>
  467. </listitem>
  468. </itemizedlist>
  469. <para>
  470. Für eine komplette Liste an Event Attributen, kann in die
  471. <ulink url="http://framework.zend.com/apidoc/core/">Zend Framework API Documentation</ulink> und die
  472. <ulink url="http://code.google.com/apis/gdata/reference.html">Kalender Protokol Referenz</ulink>
  473. gesehen werden. Attribute die mehrfache Werte enthalten können, wo wie "where", sind als Arrays
  474. implementiert und müssen korrekt erstellt werden. Es ist zu beachten das alle diese Attribute
  475. Objekte als Parameter benötigen. Der Versuch diese stattdessen als Strings oder Primitivvariablen
  476. bekanntzugeben wird in einem Fehler wärend der Konvertierung in XML führen.
  477. </para>
  478. <para>
  479. Sobald das Event bekanntgegeben wurde, kann es zum Kalender Server hochgeladen werden durch
  480. seine Übergabe als Argument zur <code>insertEvent()</code> Funktion des Kalender Services.
  481. </para>
  482. <programlisting role="php"><![CDATA[
  483. // Erstellt einen neuen Eintrag und verwendet die magische Factory
  484. // Methode vom Kalender Service
  485. $event= $service->newEventEntry();
  486. // Gibt das Event bekannt mit den gewünschten Informationen
  487. // Beachte das jedes Attribu als Instanz der zugehörenden Klasse erstellt wird
  488. $event->title = $service->newTitle("Mein Event");
  489. $event->where = array($service->newWhere("Berg Ansicht, Kalifornien"));
  490. $event->content =
  491. $service->newContent(" Das ist mein super Event. RSVP benötigt.");
  492. // Setze das Datum und verwende das RFC 3339 Format.
  493. $startDate = "2008-01-20";
  494. $startTime = "14:00";
  495. $endDate = "2008-01-20";
  496. $endTime = "16:00";
  497. $tzOffset = "-08";
  498. $when = $service->newWhen();
  499. $when->startTime = "{$startDate}T{$startTime}:00.000{$tzOffset}:00";
  500. $when->endTime = "{$endDate}T{$endTime}:00.000{$tzOffset}:00";
  501. $event->when = array($when);
  502. // Das Event an den Kalender Server hochladen
  503. // Eine Kopie des Events wird zurückgegeben wenn es am Server gespeichert wird
  504. $newEvent = $service->insertEvent($event);
  505. ]]></programlisting>
  506. </sect3>
  507. <sect3 id="zend.gdata.calendar.creating_events.schedulers_reminders">
  508. <title>Event Planungen und Erinnerungen</title>
  509. <para>
  510. Die Startzeit und Dauer eines Events werden durch die Werte seiner <code>when</code> Eigenschaften,
  511. <code>startTime</code>, <code>endTime</code>, und <code>valueString</code> ermittelt.
  512. <code>startTime</code> und <code>endTime</code> kontrollieren die Dauer des Events, wärend die
  513. <code>valueString</code> Eigenschaft aktuell nicht verwendet wird.
  514. </para>
  515. <para>
  516. Jeden Tag wiederkehrende Events können geplant werden indem nur das Datum spezifiziert und
  517. die Zeit ausgelassen wird wenn <code>startTime</code> und <code>endTime</code> gesetzt werden.
  518. Genauso können Events die keine Dauer haben spezifiziert werden indem <code>endTime</code>
  519. unterdrückt wird. In allen Fällen sollten Datums und Zeitwerte im
  520. <ulink url="http://www.ietf.org/rfc/rfc3339.txt">RFC3339</ulink> Format angegeben werden.
  521. </para>
  522. <programlisting role="php"><![CDATA[
  523. // Plane ein Event das am 05. Dezember 2007 um 14h PST stattfindet
  524. // (UTC-8) mit der Dauer einer Stunde.
  525. $when = $service->newWhen();
  526. $when->startTime = "2007-12-05T14:00:00-08:00";
  527. $when->endTime="2007-12-05T15:00:00:00-08:00";
  528. // Die "when" Eigenschaft an das Event binden
  529. $event->when = array($when);
  530. ]]></programlisting>
  531. <para>
  532. Das <code>when</code> Attribut kontrolliert auch wann Erinnerungen an einen Benutzer gesendet
  533. werden. Erinnerungen werden in einem Array gespeichert und jedes Event kann abgefragt werden
  534. um die Erinnerungen herauszufinden die mit Ihm verbunden sind.
  535. </para>
  536. <para>
  537. Damit ein <code>reminder</code> gültig ist, muß er zwei Attribute gesetzt haben: <code>method</code>
  538. und eine Zeit. <code>Method</code> akzeptiert einen der folgenden Strings: "alert", "email" oder
  539. "sms". Die Zeit sollte als Integer eingegeben werden und kann mit den Eigenschaften
  540. <code>minutes</code>, <code>hours</code>, <code>days</code> oder <code>absoluteTime</code>
  541. gesetzt werden. Trotzdem darf eine gültige Anfrage nur eines dieser Attribute gesetzt haben.
  542. Wenn eine gemischte Zeit gewünscht wird, muß der Wert in die am besten passende und vorhandene
  543. Einheit konvertiert werden. Zum Beispiel, 1 Stunde und 30 Minuten sollten als 90 Minuten angegeben
  544. werden.
  545. </para>
  546. <programlisting role="php"><![CDATA[
  547. // Erstellt ein Erinnerungs Objekt. Es sollte eine Email an den Benutzer
  548. // senden, 10 Minuten vor dem Event.
  549. $reminder = $service->newReminder();
  550. $reminder->method = "email";
  551. $reminder->minutes = "10";
  552. // Die Erinnerung einem existierenden Event als "when" Eigenschaft hinzufügen
  553. $when = $event->when[0];
  554. $when->reminders = array($reminder);
  555. ]]></programlisting>
  556. </sect3>
  557. <sect3 id="zend.gdata.calendar.creating_events.recurring">
  558. <title>Wiederkehrende Events erstellen</title>
  559. <para>
  560. Wiederkehrende Events werden auf dem gleichen Weg erstellt wie einmal stattfindende Events,
  561. ausser das ein Wiederholungs "recurrence" Attribut statt dem "where" Attribut angegeben werden
  562. muß. Das Wiederholungs Attribut sollte einen String enthalten der das Wiederholungs Pattern des
  563. Events beschreibt und das mit Eigenschaften definiert werden kann die im iCalender Standard
  564. (<ulink url="http://www.ietf.org/rfc/rfc2445.txt">RFC 2445</ulink>) beschrieben sind.
  565. </para>
  566. <para>
  567. Ausnahmen im Wiederholungs Pattern werden normalerweise durch ein ausgeprägtes
  568. <code>recurrenceException</code> Attribut spezifiziert. Trotzdem bietet der iCalender Standard
  569. ein zweites Format für die Definition von Wiederholungen, und die Möglichkeit das jedes von Ihnen
  570. verwendet werden kann und für jedes davon muß das gehandhabt werden.
  571. </para>
  572. <para>
  573. Durch die Komplexität des analysierens des Wiederholungs Patterns, sind weitere Informationen
  574. hierüber ausserhalb des Umfangs dieses Dokuments. Trotzdem können weitere Informationen im
  575. <ulink url="http://code.google.com/apis/gdata/elements.html#gdRecurrence">Kapitel über normale
  576. Elemente des Google Data API Entwickler Leitfadens</ulink> gefunden werden, sowie in der
  577. RFC 2445.
  578. </para>
  579. <programlisting role="php"><![CDATA[
  580. // Erstelle einen neuen Eintrag und verwendet die magische
  581. // Factory Methode des Kalender Services
  582. $event= $service->newEventEntry();
  583. // Gibt das Event mit den gewünschten Informationen bekannt
  584. // Es ist zu beachten das jedes Attribut als Instanz
  585. // der betreffenden Klasse erstellt wird
  586. $event->title = $service->newTitle("Mein wiederkehrendes Event");
  587. $event->where = array($service->newWhere("Palo Alto, Kalifornien"));
  588. $event->content =
  589. $service->newContent('Das ist mein anderes super Event, ' .
  590. 'das jeden Dienstag von 01.05.2007 bis ' .
  591. '04.09.2007 stattfinden. Kein RSVP benötigt.");
  592. // Setzt Dauer und Frequenz durch Spezifizierung des Wiederholungs Patterns
  593. $recurrence = "DTSTART;VALUE=DATE:20070501\r\n" .
  594. "DTEND;VALUE=DATE:20070502\r\n" .
  595. "RRULE:FREQ=WEEKLY;BYDAY=Tu;UNTIL=20070904\r\n";
  596. $event->recurrence = $service->newRecurrence($recurrence);
  597. // Das Event zum Kalender Server hochladen
  598. // Eine Kopie des Events wird zurückgegeben,
  599. // wenn es auf dem Server gespeichert wird
  600. $newEvent = $service->insertEvent($event);
  601. ]]></programlisting>
  602. </sect3>
  603. <sect3 id="zend.gdata.calendar.creating_events.quickadd">
  604. <title>QuickAdd verwenden</title>
  605. <para>
  606. QuickAdd ist ein Feature das es erlaubt Events zu erstellen indem ein frei definierter Texteintrag
  607. verwendet wird. Zum Beispie lwürde der String "Abendessen bei Joe's Dinner am Dienstag" ein
  608. Event erstellen mit dem Titel "Abendessen", dem Ort "Joe's Dinner", und dem Datum "Dienstag".
  609. Um die Vorteile von QuickAdd zu verwenden, muß eine neue <code>QuickAdd</code> Eigenschaft erstellt,
  610. auf "true" gesetzt und der frei definierbare Text als <code>content</code> Eigenschaft
  611. gespeichert werden.
  612. </para>
  613. <programlisting role="php"><![CDATA[
  614. // Erstelle einen neuen Eintrag und verwendet die magische
  615. // Factory Methode des Kalender Services
  616. $event= $service->newEventEntry();
  617. // Gibt das Event mit den gewünschten Informationen bekannt
  618. $event->content= $service->newContent("Dinner at Joe's Diner on Thursday");
  619. $event->quickAdd = $service->newQuickAdd("true");
  620. // Das Event zum Kalender Server hochladen
  621. // Eine Kopie des Events wird zurückgegeben,
  622. // wenn es auf dem Server gespeichert wird
  623. $newEvent = $service->insertEvent($event);
  624. ]]></programlisting>
  625. </sect3>
  626. </sect2>
  627. <sect2 id="zend.gdata.calendar.modifying_events">
  628. <title>Events bearbeiten</title>
  629. <para>
  630. Sobald eine Instanz eines Events erstellt wurde, können die Attribute des Events lokal auf dem selben
  631. Weg wie bei der Erstellung des Events geänder werden. Sobald alle Änderungen komplett sind, schickt
  632. der Aufruf der <code>save()</code> Methode des Events die Änderungen an den Kalender Server und gibt
  633. eine Kopie des Events zurück wie es auf dem Server erstellt wurde.
  634. </para>
  635. <para>
  636. Im Fall das ein anderer Benutzer das Event modifiziert hat seitdem die lokale Kopie empfangen wurde,
  637. wird die <code>save()</code> Methode fehlschlagen und einen 409 (Konflikt) Status Code zurück geben.
  638. Um das zu beheben muß eine neue Kopie des Events vom Server empfangen werden bevor ein erneuter
  639. Versuch stattfindet die Änderungen wieder zu speichern.
  640. </para>
  641. <programlisting role="php"><![CDATA[
  642. // Das erste Event auf der Liste der Events eines Benutzers erhalten
  643. $event = $eventFeed[0];
  644. // Den Titel zu einem neuen Wert ändern
  645. $event->title = $service->newTitle("Wuff!");
  646. // Die Änderungen an den Server hochladen
  647. try {
  648. $event->save();
  649. } catch (Zend_Gdata_App_Exception $e) {
  650. echo "Fehler: " . $e->getMessage();
  651. }
  652. ]]></programlisting>
  653. </sect2>
  654. <sect2 id="zend.gdata.calendar.deleting_events">
  655. <title>Events löschen</title>
  656. <para>
  657. Kalender Events können entweder durch den Aufruf der <code>delete()</code> Methode des Kalender
  658. Services, und des Angebens der Bearbeitungs URL des Events durchgeführt werden, oder durch
  659. Aufruf der eigenen <code>delete()</code> Methode des Events.
  660. </para>
  661. <para>
  662. In jedem Fall, wird das gelöschte Event trotzdem noch am Privaten Event Feed des Benutzers
  663. aufscheinen wenn ein <code>updateMin</code> Abfrage Parameter angegeben wurde. Gelöschte Events
  664. können von normalen Events unterschieden werden weil Sie Ihre eigene <code>eventStatus</code>
  665. Eigenschaft auf "http://schemas.google.com/g/2005#event.canceled" gesetzt haben.
  666. </para>
  667. <programlisting role="php"><![CDATA[
  668. // Option 1: Events können direkt gelöscht werden
  669. $event->delete();
  670. ]]></programlisting>
  671. <programlisting role="php"><![CDATA[
  672. // Option 2: Events können gelöscht werden indem die Bearbeitungs URL
  673. // des Events zu diesem Kalender Service angegeben wird, wenn diese
  674. // bekannt ist
  675. $service->delete($event->getEditLink()->href);
  676. ]]></programlisting>
  677. </sect2>
  678. <sect2 id="zend.gdata.calendar.comments">
  679. <title>Auf Event Kommentare zugreifen</title>
  680. <para>
  681. Den die komplette Event Ansicht verwendet wird, werden Kommentare nicht direkt innerhalb eines Events
  682. gespeichert. Stattdessen enthält jedes Event eine URL zum dazugehörigen Kommentar Feed welcher
  683. manuell angefragt werden muß.
  684. </para>
  685. <para>
  686. Das Arbeiten mit Kommentaren ist fundamental ähnlich zum Arbeiten mit Events, mit dem einzigen
  687. signifikanten Unterschied das eine andere Feed und Event Klasse verwendet werden sollte, und das
  688. die zusätzlichen Meta-Daten für Events wie zum Beispiel "where" und "when" für Kommentare nicht
  689. existieren. Speziell wird der Author des Kommentars in der <code>author</code> Eigenschaft und der
  690. Kommentar Text in der <code>content</code> Eigenschaft gespeichert.
  691. </para>
  692. <programlisting role="php"><![CDATA[
  693. // Die normale URL vom ersten Event der Feed Liste des Benutzers extrahieren
  694. $event = $eventFeed[0];
  695. $commentUrl = $event->comments->feedLink->url;
  696. // Die Kommentarliste für das Event erhalten
  697. try {
  698. $commentFeed = $service->getFeed($commentUrl);
  699. } catch (Zend_Gdata_App_Exception $e) {
  700. echo "Fehler: " . $e->getMessage();
  701. }
  702. // Jedes Kommentar als HTML Liste ausgeben
  703. echo "<ul>";
  704. foreach ($commentFeed as $comment) {
  705. echo "<li><em>Kommentar von: " . $comment->author->name "</em><br/>" .
  706. $comment->content . "</li>";
  707. }
  708. echo "</ul>";
  709. ]]></programlisting>
  710. </sect2>
  711. </sect1>