Zend_Date-Additional.xml 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 16441 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.date.additional">
  5. <title>Funktionierende Beispiele</title>
  6. <para>
  7. In diesem Kapitel werden wir verschiedene zusätzliche Funkionen beschreiben welche auch
  8. durch <classname>Zend_Date</classname> verfügbar sind. Natürlich haben alle beschriebene
  9. Funktionen auch Beispiele um die Arbeitsweise, und die einfache API für die richtige
  10. Benutzung von Ihnen, zu zeigen.
  11. </para>
  12. <sect2 id="zend.date.additional.checking">
  13. <title>Prüfen von Daten</title>
  14. <para>
  15. Normalerweise werden die meisten Daten als Zeichenketten übergeben. Aber das Problem
  16. mit Zeichenketten ist das man nicht sicher sein kann ob eine Zeichenkette ein echtes
  17. Datum enthält. Hierfür gibt es in <classname>Zend_Date</classname> eine eigene
  18. statische Funktion um Datums-Zeichenketten zu prüfen.
  19. <classname>Zend_Locale</classname> hat eine eigene Funktion
  20. <methodname>getDate($date, $locale)</methodname> welche ein Datum analysiert und
  21. die gültigen normalisierten Datumsabschnitte zurück gibt. Ein Monatsname wird zum
  22. Beispiel erkannt und anschließend nur die Nummer des Monats zurück gegeben. Aber da
  23. <classname>Zend_Locale</classname> nichts über Daten weiß, da es eine Klasse zum
  24. Normalisieren und Lokalisieren ist, haben wir eine eigene Funktion
  25. <methodname>isDate($date)</methodname> integriert welche das für uns prüft.
  26. </para>
  27. <para>
  28. <methodname>isDate($date, $format, $locale)</methodname> nimmt bis zu drei Parameter
  29. entgegen und benötigt mindestens einen Parameter. Deshalb ist alles was wir für das
  30. Prüfen eines Datums benötigen natürlich das Datum selbst als Zeichenkette. Der zweite
  31. Parameter kann das Format sein, in welchem das Datum erwartet wird. Wenn kein Format
  32. angegeben wurde, wird das Standardformat des verwendeten Gebietsschemas benutzt. Für
  33. Details darüber wie Formate aussehen müssen kann im Kapitel über
  34. <link linkend="zend.date.constants.selfdefinedformats">selbst definierte Formate</link>
  35. nachgeschaut werden.
  36. </para>
  37. <para>
  38. Der dritte Parameter ist auch optional genauso wie der zweite Parameter und kann
  39. verwendet werden um ein Gebietsschema anzugeben. Das gebietsschema wird benötigt um
  40. Monats- und Wochentagsnamen zu normalisieren. Mit dem dritten Parameter sind wir also in
  41. der Lage Daten zu erkennen wie '01.Jänner.2000' oder '01.January.2000' abhängig von dem
  42. angegebenen Gebietsschema.
  43. </para>
  44. <para>
  45. <methodname>isDate()</methodname> prüft natürlich auch ob ein Datum existiert.
  46. <classname>Zend_Date</classname> selbst prüft die Daten nicht. Deshalb ist es möglich
  47. ein Datum wie zum Beispiel '31.Februar.2000' mit <classname>Zend_Date</classname> zu
  48. erstellen weil <classname>Zend_Date</classname> das Datum automatisch korrigiert und
  49. ein gültiges Datum zurück gibt. In unserem Fall den '03.März.2000'. Auf der anderen
  50. Seite führt <methodname>isDate()</methodname> diese Prüfung durch und gibt beim
  51. '31.Februar.2000' falsch zurück, weil sie weiß das dieses Datum unmöglich ist.
  52. </para>
  53. <example id="zend.date.additional.checking.example-1">
  54. <title>Prüfen von Daten</title>
  55. <programlisting language="php"><![CDATA[
  56. // Prüfen des Datums
  57. $date = '01.03.2000';
  58. if (Zend_Date::isDate($date)) {
  59. print "Zeichenkette $date ist ein Datum";
  60. } else {
  61. print "Zeichenkette $date ist KEIN Datum";
  62. }
  63. // Prüfen eines lokalisierten Datums
  64. $date = '01 February 2000';
  65. if (Zend_Date::isDate($date,'dd MMMM yyyy', 'en')) {
  66. print "Zeichenkette $date ist ein Datum";
  67. } else {
  68. print "Zeichenkette $date ist KEIN Datum";
  69. }
  70. // Prüfen eines unmöglichen Datums
  71. $date = '30 February 2000';
  72. if (Zend_Date::isDate($date,'dd MMMM yyyy', 'en')) {
  73. print "Zeichenkette $date ist ein Datum";
  74. } else {
  75. print "Zeichenkette $date ist KEIN Datum";
  76. }
  77. ]]></programlisting>
  78. </example>
  79. </sect2>
  80. <sect2 id="zend.date.additional.sunrise-sunset">
  81. <title>Sonnenaufgang und Sonnenuntergang</title>
  82. <para>
  83. <classname>Zend_Date</classname> beinhaltet auch Funktionen um Informationen von der
  84. Sonne zu erhalten. Oft ist es notwendig die Zeit für Sonnenaugang oder Sonnenuntergang
  85. für einen bestimmten Tag zu erhalten. Das ist mit <classname>Zend_Date</classname> sehr
  86. einfach weil nur der gewünschte Tag angegeben werden muß, und zusätzlich die Ortsangabe
  87. für den Sonnenaufgang oder Sonnenuntergang berechnet werden soll.
  88. </para>
  89. <para>
  90. Da die meisten Personen die genaue Ortsangabe Ihrer Stadt nicht kennen haben wir auch
  91. eine Helferklasse spendiert die für etwa 250 Haupt- und Großstädte der ganzen Welt die
  92. Daten der Ortsangaben bereithält. Die meisten Personen können Städte in Ihrer näheren
  93. Umgebung benutzen, da die Differenz für Ortsangaben welche nahe beineinander liegen nur
  94. in Sekunden gemessen werden kann.
  95. </para>
  96. <para>
  97. Für die Erstellung einer Auswahlbox und der Auswahl einer speziellen Stadt kann die
  98. Funktion <classname>Zend_Date_Cities::getCityList</classname> benutzt werden. Sie gibt
  99. die Namen aller verfügbaren vordefinierten Städte der Helferklasse zurück.
  100. </para>
  101. <example id="zend.date.additional.sunrise-sunset.example-1">
  102. <title>Alle verfügbaren Städte ausgeben</title>
  103. <programlisting language="php"><![CDATA[
  104. // Ausgabe der kompletten Liste aller verfügbaren Städte
  105. print_r (Zend_Date_Cities::getCityList());
  106. ]]></programlisting>
  107. </example>
  108. <para>
  109. Die Ortsangabe selbst erhält man mit der Funktion
  110. <methodname>Zend_Date_Cities::City()</methodname>. Sie akzeptiert den Namen einer Stadt
  111. wie durch die Funktion <methodname>Zend_Date_Cities::getCityList()</methodname>
  112. angegeben und optional als zweiten Parameter den zu setzenden Horizont.
  113. </para>
  114. <para>
  115. Es gibt 4 vordefinierte Horizonte welche mit einer Ortsangabe benutzt werden können um
  116. den genauen Zeitpunkt von Sonnenauf- und -untergang zu erhalten. Der
  117. '<code>horizon</code>' Parameter ist in allen Funktionen immer optional. Wenn er nicht
  118. gesetzt wird, wird der '<code>effective</code>' Horizont benutzt.
  119. </para>
  120. <table id="zend.date.additional.sunrise-sunset.table">
  121. <title>Arten von unterstützten Horizonten für Sonnenauf- und -untergang</title>
  122. <tgroup cols="3">
  123. <thead>
  124. <row>
  125. <entry>Horizont</entry>
  126. <entry>Beschreibung</entry>
  127. <entry>Verwendung</entry>
  128. </row>
  129. </thead>
  130. <tbody>
  131. <row>
  132. <entry>effective</entry>
  133. <entry>Standard Horizont</entry>
  134. <entry>
  135. Nimmt an das die Welt ein Ball ist. Dieser Horizont wird immer benutzt
  136. wenn keiner definiert wurde.
  137. </entry>
  138. </row>
  139. <row>
  140. <entry>civil</entry>
  141. <entry>Üblicher Horizont</entry>
  142. <entry>Oft in den üblichen Medien wie Fernsehen und Radio benutzt.</entry>
  143. </row>
  144. <row>
  145. <entry>nautic</entry>
  146. <entry>Nautischer Horizont</entry>
  147. <entry>Oft in der Navigation zu See benutzt.</entry>
  148. </row>
  149. <row>
  150. <entry>astronomic</entry>
  151. <entry>Astronomischer Horizont</entry>
  152. <entry>Oft bei der Berechnung mit Sternen benutzt</entry>
  153. </row>
  154. </tbody>
  155. </tgroup>
  156. </table>
  157. <para>
  158. Natürlich kann auch eine selbst-definierte Ortsangabe für die Berechnung benutzt werden.
  159. Hierzu ist eine '<code>latitude</code>' und eine '<code>longitude</code>' anzugeben und
  160. optional der '<code>horizon</code>'.
  161. </para>
  162. <example id="zend.date.additional.sunrise-sunset.example-2">
  163. <title>Die Ortsangabe für eine Stadt auslesen</title>
  164. <programlisting language="php"><![CDATA[
  165. // Die Ortsangabe für eine bestimmte Stadt auslesen
  166. // Benutzt den effektiven Horizont da kein Horizont angegeben wurde
  167. print_r (Zend_Date_Cities::City('Vienna'));
  168. // Benutzt den nautischen Horizont
  169. print_r (Zend_Date_Cities::City('Vienna', 'nautic'));
  170. // Selbstdefinition einer Ortsangabe
  171. $mylocation = array('latitude' => 41.5, 'longitude' => 13.2446);
  172. ]]></programlisting>
  173. </example>
  174. <para>
  175. Da nun alle benötigten Daten angegeben werde können ist der nächste Schritt die
  176. Erstellung eines <classname>Zend_Date</classname> Objekts mit dem Tag für welchen
  177. Sonnenauf- oder -untergang berechnet werden sollen. Für die Berechnung stehen 3
  178. Funktionen bereit. Die Berechnung des Sonnenaufganges ist mit
  179. '<methodname>getSunset()</methodname>', des Sonnenuntergangs mit
  180. '<methodname>getSunrise()</methodname>' und alle möglichen Informationen welche die
  181. Sonne betreffen mit '<methodname>getSunInfo()</methodname>' möglich. Nach der
  182. Berechnung wird das <classname>Zend_Date</classname> Objekt mit der berechneten Zeit
  183. zurückgegeben.
  184. </para>
  185. <example id="zend.date.additional.sunrise-sunset.example-3">
  186. <title>Berechnung von Sonneninformationen</title>
  187. <programlisting language="php"><![CDATA[
  188. // Die Ortsangabe einer bestimmten Stadt auslesen
  189. $city = Zend_Date_Cities::City('Vienna');
  190. // Ein Datumsobjekt erstellen für den Tag
  191. // für den die Sonne berechnet werden soll
  192. $date = new Zend_Date('10.03.2007', Zend_Date::ISO_8601, 'de');
  193. // Sonnenuntergang berechnen
  194. $sunset = $date->getSunset($city);
  195. print $sunset->get(Zend_Date::ISO_8601);
  196. // Alle Sonneninformationen berechnen
  197. $info = $date->getSunInfo($city);
  198. foreach ($info as $sun) {
  199. print "\n" . $sun->get(Zend_Date::ISO_8601);
  200. }
  201. ]]></programlisting>
  202. </example>
  203. </sect2>
  204. <sect2 id="zend.date.additional.timezones">
  205. <title>Zeitzonen</title>
  206. <para>
  207. Zeitzonen sind genauso wichtig wie die Datumsangaben selbst. Es gibt einige Zeitzonen
  208. abhängig davon wo auf der Welt der Benutzer lebt. Deshalb bedeutet das Arbeiten mit
  209. Daten auch immer das eine gültige Zeitzone gesetzt ist. Das klingt eventuell
  210. kompliziert, ist aber viel einfacher als erwartet. Wie schon im ersten Kapitel von
  211. <classname>Zend_Date</classname> erwähnt muß immer eine Standardzeitzone ersetzt werden.
  212. Entweder durch <filename>php.ini</filename> oder durch Definition in der Bootstrap
  213. Datei.
  214. </para>
  215. <para>
  216. Ein <classname>Zend_Date</classname> Objekt speichert natürlich die aktuelle Zeitzone.
  217. Selbst wenn die Zeitzone nach der Erstellung des Objektes geändert wird, merkt sich das
  218. Objekt die originale Zeitzone und arbeitet mit Ihr. Es ist also nicht notwendig die
  219. Zeitzone im Code mithilfe von PHP Funktionen zu ändern. <classname>Zend_Date</classname>
  220. hat zwei eingebaute Funktionen die es ermöglichen damit zu Arbeiten.
  221. </para>
  222. <para>
  223. <methodname>getTimezone()</methodname> gibt die aktuell gesetzte Zeitzone des
  224. <classname>Zend_Date</classname> Objektes zurück. Man sollte in Erinnerung behalten das
  225. <classname>Zend_Date</classname> nicht mit den PHP Internas gekoppelt ist. Deshalb ist
  226. die zurückgegebene Zeitzone nicht die des PHP Skripts sondern jene des Objektes.
  227. <methodname>setTimezone($zone)</methodname> ist die zweite Funktion und ermöglicht es
  228. eine neue Zeitzone für <classname>Zend_Date</classname> zu setzen. Eine angegebene
  229. Zeitzone wird immer geprüft. Wenn diese nicht existiert wird eine Ausnahme geworfen.
  230. Zusätzlich kann die Zeitzone des aktuellen Skripts oder des Systems für das
  231. Datumsobjekt gesetzt werden indem <methodname>setTimezone()</methodname> ohne den
  232. Parameter zone aufgerufen wird. Das wird auch automatisch gemacht wenn das Datumsobjekt
  233. erstellt wird.
  234. </para>
  235. <example id="zend.date.additional.timezones.example-1">
  236. <title>Arbeiten mit Zeitzonen</title>
  237. <programlisting language="php"><![CDATA[
  238. // Setzen einer Standardzeitzone... das muß in der Bootstrap Datei
  239. // oder php.ini gemacht werden. Wir setzen Sie hier nur der Vollständigkeit
  240. // halber um ein komplettes Beispiel zu erhalten.
  241. date_default_timezone_set('Europe/Vienna');
  242. // Erstellen des Datumsobjektes
  243. $date = new Zend_Date('10.03.2007', Zend_Date::DATES, 'de');
  244. // Ausgabe des Datumsobjektes
  245. print $date->getIso();
  246. // Welche Zeitzone ist gesetzt ?
  247. print $date->getTimezone();
  248. // Setzen einer anderen Zeitzone
  249. $date->setTimezone('America/Chicago');
  250. // Welche Zeitzone ist jetzt gesetzt ?
  251. print $date->getTimezone();
  252. // Ausgabe des geänderten Datumsobjektes
  253. print $date->getIso();
  254. ]]></programlisting>
  255. </example>
  256. <para>
  257. <classname>Zend_Date</classname> nimmt immer die aktuelle Zeitzone für das Erstellen
  258. eines Objektes wie in den ersten Zeilen des Beispiels gezeigt. Das Ändern der Zeitzone
  259. für ein erstelltes Objekt hat einen Effekt auf das Datum selbst. Daten sind immer
  260. relativ zu einer Zeitzone. Das Ändern der Zeitzone für ein
  261. <classname>Zend_Date</classname> Objekt ändert nicht die Zeit des
  262. <classname>Zend_Date</classname> Objektes selbst. Man muß sich in Erinnerung halten das
  263. Daten intern immer als Zeitpunkte und in der GMT gespeichert werden. Eine Zeitzone
  264. bedeutet also wieviele Stunden subtrahiert oder addiert werden müssen um die aktuelle
  265. globale Zeit für die eigene Zeitzone und Region er erhalten.
  266. </para>
  267. <para>
  268. Das koppeln der Zeitzone innerhalb von <classname>Zend_Date</classname> hat einen
  269. anderen positiven Nebeneffekt. Es ist möglich verschiedene Daten mit verschiedenen
  270. Zeitzonen zu haben.
  271. </para>
  272. <example id="zend.date.additional.timezones.example-2">
  273. <title>Mehrere Zeitzonen</title>
  274. <programlisting language="php"><![CDATA[
  275. // Setzen einer Standardzeitzone... das muß in der Bootstrap Datei oder
  276. // php.ini gemacht werden. Wir setzen Sie hier nur der Vollständigkeit
  277. // halber um ein komplettes Beispiel zu erhalten.
  278. date_default_timezone_set('Europe/Vienna');
  279. // Erstellen des Datumsobjektes
  280. $date = new Zend_Date('10.03.2007 00:00:00', Zend_Date::ISO_8601, 'de');
  281. // Ausgabe des Datumsobjektes
  282. print $date->getIso();
  283. // Das Datum bleibt unverändert selbst nach einer Änderung der Zeitzone
  284. date_default_timezone_set('America/Chicago');
  285. print $date->getIso();
  286. $otherdate = clone $date;
  287. $otherdate->setTimezone('Brazil/Acre');
  288. // Ausgabe des Datumsobjektes
  289. print $otherdate->getIso();
  290. // Setzen der aktuellen Zeitzone des Systems für das Objekt
  291. $lastdate = clone $date;
  292. $lastdate->setTimezone();
  293. // Ausgabe des Datumsobjektes
  294. print $lastdate->getIso();
  295. ]]></programlisting>
  296. </example>
  297. </sect2>
  298. </sect1>