Zend_Cache-Frontends.xml 39 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 15617 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.cache.frontends">
  5. <title>Zend_Cache Frontends</title>
  6. <sect2 id="zend.cache.frontends.core">
  7. <title>Zend_Cache_Core</title>
  8. <sect3 id="zend.cache.frontends.core.introduction">
  9. <title>Einführung</title>
  10. <para>
  11. <classname>Zend_Cache_Core</classname> ist ein spezielles Frontend, da es der Kern
  12. dieses Moduls ist. Es ist ein generelles Cache Frontend und wurde von anderen
  13. Klassen erweitert.
  14. </para>
  15. <note>
  16. <para>
  17. Alle Frontends sind von <classname>Zend_Cache_Core</classname> abgeleitet, so
  18. dass deren Methoden und Optionen (wie folgt beschrieben) auch in anderen
  19. Frontends vorhanden sind. Deswegen werden sie dort nicht dokumentiert.
  20. </para>
  21. </note>
  22. </sect3>
  23. <sect3 id="zend.cache.frontends.core.options">
  24. <title>Mögliche Optionen</title>
  25. <para>
  26. Diese Optionen werden der Factory Methode übergeben wie im nachfolgenden Beispiel
  27. demonstriert.
  28. </para>
  29. <table id="zend.cache.frontends.core.options.table">
  30. <title>Core Frontend Optionen</title>
  31. <tgroup cols="4">
  32. <thead>
  33. <row>
  34. <entry>Option</entry>
  35. <entry>Daten Typ</entry>
  36. <entry>Standardwert</entry>
  37. <entry>Beschreibung</entry>
  38. </row>
  39. </thead>
  40. <tbody>
  41. <row>
  42. <entry><code>caching</code></entry>
  43. <entry><code>boolean</code></entry>
  44. <entry><code>true</code></entry>
  45. <entry>
  46. Ein- / Ausschalten vom Caching (kann sehr nützlich für das
  47. Debuggen von gecachten Skripten sein)
  48. </entry>
  49. </row>
  50. <row>
  51. <entry><code>cache_id_prefix</code></entry>
  52. <entry><code>string</code></entry>
  53. <entry><code>null</code></entry>
  54. <entry>
  55. Ein Präfix für alle Cache IDs. Wenn er auf <code>null</code>
  56. gesetzt wird, wird kein Cache ID Präfix verwendet. Der Cache ID
  57. Präfix erstellt grundsätzlich einen Namespace im Cache, der
  58. verschiedenen Anwendungen oder Websites die Verwendung eines
  59. gemeinsamen Caches erlaubt. Jede Anwendung oder Website kann
  60. einen anderen Cache ID Prüfix verwenden sodas spezielle Cache IDs
  61. mehr als einmal verwendet werden können.
  62. </entry>
  63. </row>
  64. <row>
  65. <entry><code>lifetime</code></entry>
  66. <entry><code>int</code></entry>
  67. <entry><code>3600</code></entry>
  68. <entry>
  69. Cache Lebensdauer (in Sekunden), wenn auf <code>null</code> gesetzt,
  70. ist der Cache für immer gültig.
  71. </entry>
  72. </row>
  73. <row>
  74. <entry><code>logging</code></entry>
  75. <entry><code>boolean</code></entry>
  76. <entry><code>false</code></entry>
  77. <entry>
  78. Wenn auf true gesetzt, wird das Logging durch
  79. <classname>Zend_Log</classname> aktiviert (aber das System wird
  80. langsamer)
  81. </entry>
  82. </row>
  83. <row>
  84. <entry><code>write_control</code></entry>
  85. <entry><code>boolean</code></entry>
  86. <entry><code>true</code></entry>
  87. <entry>
  88. Ein- / Ausschalten der Schreibkontrolle (der Cache wird gleich
  89. gelesen, nachdem er geschrieben wurde, um fehlerhafte Einträge zu
  90. finden); das Einschalten der Schreibkontrolle wird das Schreiben des
  91. Caches etwas verlangsamen, aber nicht das Lesen des Caches (es
  92. können defekte Cache Dateien entdeckt werden, aber es ist keine
  93. perfekte Kontrolle)
  94. </entry>
  95. </row>
  96. <row>
  97. <entry><code>automatic_serialization</code></entry>
  98. <entry><code>boolean</code></entry>
  99. <entry><code>false</code></entry>
  100. <entry>
  101. Ein- / Ausschalten der automatischen Serialisierung, kann dafür
  102. benutzt werden, um Daten direkt zu speichern, welche keine Strings
  103. sind (aber es ist langsamer)
  104. </entry>
  105. </row>
  106. <row>
  107. <entry><code>automatic_cleaning_factor</code></entry>
  108. <entry><code>int</code></entry>
  109. <entry><code>10</code></entry>
  110. <entry>
  111. Ausschalten / Abgleichen des automatischen Löschprozesses (Garbage
  112. Collector): 0 heißt keine automatische Löschung des Caches, 1 heißt
  113. Systematische Cache Löschung und x &gt; 1 heißt automatisches
  114. zufälliges Löschen 1 mal nach x Schreiboperationen.
  115. </entry>
  116. </row>
  117. <row>
  118. <entry><code>ignore_user_abort</code></entry>
  119. <entry><code>boolean</code></entry>
  120. <entry><code>false</code></entry>
  121. <entry>
  122. Auf true gesetzt, wird der Kern das PHP Flag ignore_user_abort
  123. innerhalb der save() Methode setzen um Cache Korruption in einigen
  124. Fällen zuverhindern
  125. </entry>
  126. </row>
  127. </tbody>
  128. </tgroup>
  129. </table>
  130. </sect3>
  131. <sect3 id="zend.cache.core.examples">
  132. <title>Beispiele</title>
  133. <para>
  134. Ein Beispiel wird ganz am Anfang des Handbuches gegeben.
  135. </para>
  136. <para>
  137. Wenn nur Strings in den Cache gespeichert werden (denn mit der
  138. "automatic_serialization" Option wäre es möglich Booleans zu speichern), kann ein
  139. kompakterer Weg wie folgt gewählt werden:
  140. </para>
  141. <programlisting language="php"><![CDATA[
  142. // Es wird angenommen das $cache existiert
  143. $id = 'myBigLoop'; // Die Cache ID von dem "das gecached werden soll"
  144. if (!($data = $cache->load($id))) {
  145. // Cache miss
  146. $data = '';
  147. for ($i = 0; $i < 10000; $i++) {
  148. $data = $data . $i;
  149. }
  150. $cache->save($data);
  151. }
  152. // [...] Irgendwas mit $data machen (ausgeben, verarbeiten, usw.)
  153. ]]></programlisting>
  154. <para>
  155. Wenn mehrere Blöcke von Daten oder Daten Instanzen gecached werden sollen, ist die
  156. Idee dahinter die gleiche:
  157. </para>
  158. <programlisting language="php"><![CDATA[
  159. // Sicherstellen, dass eindeutige Identifizierer verwendet werden:
  160. $id1 = 'foo';
  161. $id2 = 'bar';
  162. // Block 1
  163. if (!($data = $cache->load($id1))) {
  164. // Cache miss
  165. $data = '';
  166. for ($i=0;$i<10000;$i++) {
  167. $data = $data . $i;
  168. }
  169. $cache->save($data);
  170. }
  171. echo($data);
  172. // Hier wird NIE gecached
  173. echo('NIE GECACHED! ');
  174. // Block 2
  175. if (!($data = $cache->load($id2))) {
  176. // Cache miss
  177. $data = '';
  178. for ($i=0;$i<10000;$i++) {
  179. $data = $data . '!';
  180. }
  181. $cache->save($data);
  182. }
  183. echo($data);
  184. ]]></programlisting>
  185. <para>
  186. Wenn spezielle Werte gecached werden sollen (boolean mit der
  187. "automatic_serialization" Option) oder leere Strings kann die kompakte Erstellung
  188. wie oben gezeigt nicht verwendet werden. Der Cache Eintrag muß formell getestet
  189. werden.
  190. </para>
  191. <programlisting language="php"><![CDATA[
  192. // Die kompakte Erstellung
  193. // (nicht gut wenn leere Strings und/oder boolsche Werte gecached werden)
  194. if (!($data = $cache->load($id))) {
  195. // Cache fehlgeschlagen
  196. // [...] wir erstellen $data
  197. $cache->save($data);
  198. }
  199. // wir machen etwas mit $data
  200. // [...]
  201. // die komplette Erstellung (funktioniert in jedem Fall)
  202. if (!($cache->test($id))) {
  203. // Cache fehlgeschlagen
  204. // [...] wir erstellen $data
  205. $cache->save($data);
  206. } else {
  207. // Cache getroffen
  208. $data = $cache->load($id);
  209. }
  210. // Wir machen irgendetwas mit $data
  211. ]]></programlisting>
  212. </sect3>
  213. </sect2>
  214. <sect2 id="zend.cache.frontends.output">
  215. <title>Zend_Cache_Frontend_Output</title>
  216. <sect3 id="zend.cache.frontends.output.introduction">
  217. <title>Einführung</title>
  218. <para>
  219. <classname>Zend_Cache_Frontend_Output</classname> ist ein Ausgabe-Empfangendes
  220. Frontend. Es verwendet den Ausgabe Puffer in PHP, um alles zwischen der
  221. <code>start()</code> und der <code>end()</code> Methode zu fangen.
  222. </para>
  223. </sect3>
  224. <sect3 id="zend.cache.frontends.output.options">
  225. <title>Mögliche Optionen</title>
  226. <para>
  227. Dieses Frontend hat keine bestimmten Optionen zusätzlich zu denen von
  228. <classname>Zend_Cache_Core</classname>.
  229. </para>
  230. </sect3>
  231. <sect3 id="zend.cache.frontends.output.examples">
  232. <title>Beispiele</title>
  233. <para>
  234. Ein Beispiel wird ganz am Anfang des Handbuches gegeben. Hier ist es mit kleinen
  235. Änderungen:
  236. </para>
  237. <programlisting language="php"><![CDATA[
  238. // Wenn es ein Cache Miss ist, wird das puffern der Ausgabe ausgelöst
  239. if( ! ($cache->start('mypage'))) {
  240. // Alle wie gewohnt ausgeben
  241. echo 'Hallo Welt! ';
  242. echo 'Das wird gecached ('.time().') ';
  243. $cache->end(); // Ausgabepufferung beenden
  244. }
  245. echo 'Hier wird nie gecached ('.time().').';
  246. ]]></programlisting>
  247. <para>
  248. Die Verwendung dieser Form ist ziemlich einfach, um Ausgabe caching in einem bereits
  249. bestehenden Projekt, mit nur wenig oder gar keinen Codeänderungen, zu erhalten.
  250. </para>
  251. </sect3>
  252. </sect2>
  253. <sect2 id="zend.cache.frontends.function">
  254. <title>Zend_Cache_Frontend_Function</title>
  255. <sect3 id="zend.cache.frontends.function.introduction">
  256. <title>Einführung</title>
  257. <para>
  258. <classname>Zend_Cache_Frontend_Function</classname> cached das Ergebnis von
  259. Funktionsaufrufen. Es hat eine einzelne Hauptmethode genannt <code>call()</code>,
  260. welche den Funktionsnamen und Parameter für den Aufruf in einem Array entgegennimmt.
  261. </para>
  262. </sect3>
  263. <sect3 id="zend.cache.frontends.function.options">
  264. <title>Mögliche Optionen</title>
  265. <table id="zend.cache.frontends.function.options.table">
  266. <title>Cache Frontend Optionen</title>
  267. <tgroup cols="4">
  268. <thead>
  269. <row>
  270. <entry>Option</entry>
  271. <entry>Daten Typ</entry>
  272. <entry>Standardwert</entry>
  273. <entry>Beschreibung</entry>
  274. </row>
  275. </thead>
  276. <tbody>
  277. <row>
  278. <entry><code>cache_by_default</code></entry>
  279. <entry><code>boolean</code></entry>
  280. <entry><code>true</code></entry>
  281. <entry>
  282. Wenn true, wird der Funktionsaufruf standardmäßig gecached
  283. </entry>
  284. </row>
  285. <row>
  286. <entry><code>cached_functions</code></entry>
  287. <entry><code>array</code></entry>
  288. <entry></entry>
  289. <entry>
  290. Funktionsnamen, die immer gecached werden sollen
  291. </entry>
  292. </row>
  293. <row>
  294. <entry><code>non_cached_functions</code></entry>
  295. <entry><code>array</code></entry>
  296. <entry></entry>
  297. <entry>
  298. Funktionsnamen, die nie gecached werden sollen
  299. </entry>
  300. </row>
  301. </tbody>
  302. </tgroup>
  303. </table>
  304. </sect3>
  305. <sect3 id="zend.cache.frontends.function.examples">
  306. <title>Beispiele</title>
  307. <para>
  308. Die Verwendung der <code>call()</code> Funktion ist die gleiche, wie die von
  309. <code>call_user_func_array()</code> in PHP:
  310. </para>
  311. <programlisting language="php"><![CDATA[
  312. $cache->call('veryExpensiveFunc', $params);
  313. // $params ist ein Array
  314. // Für das Aufrufen von veryExpensiveFunc(1, 'foo', 'bar') mit Caching kann,
  315. // z.B. $cache->call('veryExpensiveFunc', array(1, 'foo', 'bar')) benutzt
  316. // werden
  317. ]]></programlisting>
  318. <para>
  319. <classname>Zend_Cache_Frontend_Function</classname> ist elegant genug, um beides zu
  320. cachen, den Rückgabewert der Funktion und deren interne Ausgabe.
  321. </para>
  322. <note><para>
  323. Man kann jede eingebaute oder benutzerdefinierte Funktion übergeben, mit ausnahme
  324. von <code>array()</code>, <code>echo()</code>, <code>empty()</code>,
  325. <code>eval()</code>, <code>exit()</code>, <code>isset()</code>, <code>list()</code>,
  326. <code>print()</code> und <code>unset()</code>.
  327. </para></note>
  328. </sect3>
  329. </sect2>
  330. <sect2 id="zend.cache.frontends.class">
  331. <title>Zend_Cache_Frontend_Class</title>
  332. <sect3 id="zend.cache.frontends.class.introduction">
  333. <title>Einführung</title>
  334. <para>
  335. <classname>Zend_Cache_Frontend_Class</classname> ist unterschiedlich zu
  336. <classname>Zend_Cache_Frontend_Function</classname>, weil es das Cachen von Objekten
  337. und statischen Methodenaufrufen erlaubt.
  338. </para>
  339. </sect3>
  340. <sect3 id="zend.cache.frontends.class.options">
  341. <title>Mögliche Optionen</title>
  342. <table id="zend.cache.frontends.class.options.table">
  343. <title>Class Frontend Optionen</title>
  344. <tgroup cols="4">
  345. <thead>
  346. <row>
  347. <entry>Option</entry>
  348. <entry>Datentyp</entry>
  349. <entry>Standardwert</entry>
  350. <entry>Beschreibung</entry>
  351. </row>
  352. </thead>
  353. <tbody>
  354. <row>
  355. <entry><code>cached_entity</code> (Notwendig)</entry>
  356. <entry><code>mixed</code></entry>
  357. <entry></entry>
  358. <entry>
  359. Wenn auf einen Klassennamen gesetzt, wird eine abstrakte Klasse
  360. gecached und es werden statische Aufrufe verwendet; wenn auf ein
  361. Objekt gesetzt, wird deren Objektmethoden gecached
  362. </entry>
  363. </row>
  364. <row>
  365. <entry><code>cache_by_default</code></entry>
  366. <entry><code>boolean</code></entry>
  367. <entry><code>true</code></entry>
  368. <entry>
  369. Wenn true, wird der Aufruf standardmäßig gecached
  370. </entry>
  371. </row>
  372. <row>
  373. <entry><code>cached_methods</code></entry>
  374. <entry><code>array</code></entry>
  375. <entry></entry>
  376. <entry>
  377. Methodennamen, die immer gecached werden sollen
  378. </entry>
  379. </row>
  380. <row>
  381. <entry><code>non_cached_methods</code></entry>
  382. <entry><code>array</code></entry>
  383. <entry></entry>
  384. <entry>
  385. Methodennamen, die nie gecached werden sollen
  386. </entry>
  387. </row>
  388. </tbody>
  389. </tgroup>
  390. </table>
  391. </sect3>
  392. <sect3 id="zend.cache.frontends.class.examples">
  393. <title>Beispiele</title>
  394. <para>
  395. zum Beispiel, um einen statischen Aufruf zu cachen:
  396. </para>
  397. <programlisting language="php"><![CDATA[
  398. class Test {
  399. // Statische Methode
  400. public static function foobar($param1, $param2) {
  401. echo "foobar_output($param1, $param2)";
  402. return "foobar_return($param1, $param2)";
  403. }
  404. }
  405. // [...]
  406. $frontendOptions = array(
  407. 'cached_entity' => 'Test' // Der Name der Klasse
  408. );
  409. // [...]
  410. // Der gecachte Aufruf
  411. $result = $cache->foobar('1', '2');
  412. ]]></programlisting>
  413. <para>
  414. Um klassische Methodenaufrufe zu cachen :
  415. </para>
  416. <programlisting language="php"><![CDATA[
  417. class Test {
  418. private $_string = 'Hallo !';
  419. public function foobar2($param1, $param2) {
  420. echo($this->_string);
  421. echo "foobar2_output($param1, $param2)";
  422. return "foobar2_return($param1, $param2)";
  423. }
  424. }
  425. // [...]
  426. $frontendOptions = array(
  427. 'cached_entity' => new Test() // Eine Instanz der Klasse
  428. );
  429. // [...]
  430. // Der gecachte Aufruf
  431. $res = $cache->foobar2('1', '2');
  432. ]]></programlisting>
  433. </sect3>
  434. </sect2>
  435. <sect2 id="zend.cache.frontends.file">
  436. <title>Zend_Cache_Frontend_File</title>
  437. <sect3 id="zend.cache.frontends.file.introduction">
  438. <title>Einführung</title>
  439. <para>
  440. <classname>Zend_Cache_Frontend_File</classname> ist ein Frontend angetrieben durch
  441. den Änderungszeitpunkt einer "Masterdatei". Es ist wirklich interessant für
  442. Beispiele in Konfigurations- oder Templateanwendungen. Es ist auch möglich mehrere
  443. Masterdateien zu verwenden.
  444. </para>
  445. <para>
  446. Zum Beispiel eine XML Konfigurationsdatei, welche von einer Funktion geparsed wird
  447. und die ein "Config Objekt" zurückgibt (wie durch
  448. <classname>Zend_Config</classname>). Mit
  449. <classname>Zend_Cache_Frontend_File</classname> kann das "Config Objekt" im Cache
  450. gespeichert werden (um zu Verhindern, das die XML Konfiguration jedes mal geparsed
  451. wird), aber mit einer strengen Abhängigkeit zur "Masterdatei". Wenn also die XML
  452. Konfigurationsdatei geändert wird, wird der Cache sofort ungültig.
  453. </para>
  454. </sect3>
  455. <sect3 id="zend.cache.frontends.file.options">
  456. <title>Mögliche Optionen</title>
  457. <table id="zend.cache.frontends.file.options.table">
  458. <title>File Frontend Optionen</title>
  459. <tgroup cols="4">
  460. <thead>
  461. <row>
  462. <entry>Option</entry>
  463. <entry>Daten Typ</entry>
  464. <entry>Standardwert</entry>
  465. <entry>Beschreibung</entry>
  466. </row>
  467. </thead>
  468. <tbody>
  469. <row>
  470. <entry><code>master_File (depreciated)</code></entry>
  471. <entry><code>string</code></entry>
  472. <entry><code></code></entry>
  473. <entry>
  474. Der komplette Pfad und Name der Master Datei
  475. </entry>
  476. </row>
  477. <row>
  478. <entry><code>master_files</code></entry>
  479. <entry><code>array</code></entry>
  480. <entry><code></code></entry>
  481. <entry>
  482. Ein Array der kompletten Pfade der Masterdateien
  483. </entry>
  484. </row>
  485. <row>
  486. <entry><code>master_files_mode</code></entry>
  487. <entry><code>string</code></entry>
  488. <entry>
  489. <classname>Zend_Cache_Frontend_File::MODE_OR</classname>
  490. </entry>
  491. <entry>
  492. <classname>Zend_Cache_Frontend_File::MODE_AND</classname> oder
  493. <classname>Zend_Cache_Frontend_File::MODE_OR</classname> ;
  494. bei <code>MODE_AND</code> müssen alle Masterdateien angegriffen
  495. werden um einen Cache ungültig zu machen, bei <code>MODE_OR</code>
  496. ist eine eizelne angegriffene Datei genug um den Cache ungültig zu
  497. machen
  498. </entry>
  499. </row>
  500. <row>
  501. <entry><code>ignore_missing_master_files</code></entry>
  502. <entry><code>boolean</code></entry>
  503. <entry><code>false</code></entry>
  504. <entry>
  505. bei true werden fehlende Masterdateien leise ignoriert
  506. (andernfalls wird eine Exception geworfen)
  507. </entry>
  508. </row>
  509. </tbody>
  510. </tgroup>
  511. </table>
  512. </sect3>
  513. <sect3 id="zend.cache.frontends.file.examples">
  514. <title>Beispiele</title>
  515. <para>
  516. Die Verwendung dieses Frontends ist die gleiche wie die von
  517. <classname>Zend_Cache_Core</classname>. Es gibt kein eigenes Beispiel - was als
  518. einziges gemacht werden muß, ist das <code>master_File</code> zu definieren, wenn
  519. die Factory verwendet wird.
  520. </para>
  521. </sect3>
  522. </sect2>
  523. <sect2 id="zend.cache.frontends.page">
  524. <title>Zend_Cache_Frontend_Page</title>
  525. <sect3 id="zend.cache.frontends.page.introduction">
  526. <title>Einführung</title>
  527. <para>
  528. <classname>Zend_Cache_Frontend_Page</classname> ist wie
  529. <classname>Zend_Cache_Frontend_Output</classname> aber entwickelt für eine komplette
  530. Seite. Es ist unmöglich <classname>Zend_Cache_Frontend_Page</classname> nur für das
  531. Cachen eines einzelnen Blockes zu verwenden.
  532. </para>
  533. <para>
  534. Andererseits wird die "Cache ID" automatisch berechnet mit
  535. <code>$_SERVER['REQUEST_URI']</code> und (abhängig von den Optionen) mit
  536. <code>$_GET</code>, <code>$_POST</code>, <code>$_SESSION</code>,
  537. <code>$_COOKIE</code>, <code>$_FILES</code>. Trotzdem muß nur eine Methode
  538. aufgerufen werden (<code>start()</code>), weil der Aufruf von <code>end()</code>
  539. immer vollautomatisch ist, wenn die Seite endet.
  540. </para>
  541. <para>
  542. Zur Zeit ist es nicht eingebaut, aber es ist ein HTTP abhängiges System geplant, um
  543. Bandbreiten zu sparen (das System wird ein "HTTP 304 nicht geändert" schicken, wenn
  544. der Cache gefunden wurde und wenn der Browser bereits eine gültige Version hat).
  545. </para>
  546. </sect3>
  547. <sect3 id="zend.cache.frontends.page.options">
  548. <title>Mögliche Optionen</title>
  549. <table id="zend.cache.frontends.page.options.table">
  550. <title>Page Frontend Optionen</title>
  551. <tgroup cols="4">
  552. <thead>
  553. <row>
  554. <entry>Option</entry>
  555. <entry>Daten Typ</entry>
  556. <entry>Standardwert</entry>
  557. <entry>Beschreibung</entry>
  558. </row>
  559. </thead>
  560. <tbody>
  561. <row>
  562. <entry><code>http_conditional</code></entry>
  563. <entry><code>boolean</code></entry>
  564. <entry><code>false</code></entry>
  565. <entry>
  566. Verwendung des http_conditional Systems (zur Zeit nicht
  567. implementiert)
  568. </entry>
  569. </row>
  570. <row>
  571. <entry><code>debug_header</code></entry>
  572. <entry><code>boolean</code></entry>
  573. <entry><code>false</code></entry>
  574. <entry>
  575. Wenn true, wird eine Debugging Text for jeder gecacheten Seite
  576. hinzugefügt
  577. </entry>
  578. </row>
  579. <row>
  580. <entry><code>default_options</code></entry>
  581. <entry><code>array</code></entry>
  582. <entry><code>array(...siehe unten...)</code></entry>
  583. <entry>
  584. Ein assoziatives Array mit Default Optionen:
  585. <itemizedlist>
  586. <listitem>
  587. <para>
  588. <code>(boolean, true per Default) cache</code> :
  589. Cache ist aktiviert wenn true
  590. </para>
  591. </listitem>
  592. <listitem>
  593. <para>
  594. <code>(boolean, false per Default)
  595. cache_with_get_variables</code> : wenn true, ist der
  596. Cache weiterhin aktiviert, selbst wenn es einige
  597. Variablen im <code>$_GET</code> Array gibt
  598. </para>
  599. </listitem>
  600. <listitem>
  601. <para>
  602. <code>(boolean, false per Default)
  603. cache_with_post_variables</code> : wenn true, ist der
  604. Cache weiterhin aktiviert, selbst wenn es einige
  605. Variablen im <code>$_POST</code> Array gibt
  606. </para>
  607. </listitem>
  608. <listitem>
  609. <para>
  610. <code>(boolean, false per Default)
  611. cache_with_session_variables</code> : wenn true, ist
  612. der Cache weiterhin aktiviert, selbst wenn es einige
  613. Variablen im <code>$_SESSION</code> Array gibt
  614. </para>
  615. </listitem>
  616. <listitem>
  617. <para>
  618. <code>(boolean, false per Default)
  619. cache_with_files_variables</code> : wenn true, ist der
  620. Cache weiterhin aktiviert, selbst wenn es einige
  621. Variablen im <code>$_FILES</code> Array gibt
  622. </para>
  623. </listitem>
  624. <listitem>
  625. <para>
  626. <code>(boolean, false per Default)
  627. cache_with_cookie_variables</code> : wenn true, ist
  628. der Cache weiterhin aktiviert, selbst wenn es einige
  629. Variablen im <code>$_COOKIE</code> Array gibt
  630. </para>
  631. </listitem>
  632. <listitem>
  633. <para>
  634. <code>(boolean, true per Default)
  635. make_id_with_get_variables</code> : wenn true, wird
  636. die Cache ID vom Inhalt des <code>$_GET</code> Arrays
  637. abhängig sein
  638. </para>
  639. </listitem>
  640. <listitem>
  641. <para>
  642. <code>(boolean, true per Default)
  643. make_id_with_post_variables</code> : wenn true, wird
  644. die Cache ID vom Inhalt des <code>$_POST</code> Arrays
  645. abhängig sein
  646. </para>
  647. </listitem>
  648. <listitem>
  649. <para>
  650. <code>(boolean, true per Default)
  651. make_id_with_session_variables</code> : wenn true,
  652. wird die Cache ID vom Inhalt des
  653. <code>$_SESSION</code> Arrays abhängig sein
  654. </para>
  655. </listitem>
  656. <listitem>
  657. <para>
  658. <code>(boolean, true per Default)
  659. make_id_with_files_variables</code> : wenn true, wird
  660. die Cache ID vom Inhalt des <code>$_FILES</code>
  661. Arrays abhängig sein
  662. </para>
  663. </listitem>
  664. <listitem>
  665. <para>
  666. <code>(boolean, true per Default)
  667. make_id_with_cookie_variables</code> : wenn true, wird
  668. die Cache ID vom Inhalt des <code>$_COOKIE</code>
  669. Arrays abhängig sein
  670. </para>
  671. </listitem>
  672. <listitem>
  673. <para>
  674. <code>(int, false by default) specific_lifetime</code>
  675. : wenn nicht false, wird die angegebene Lifetime für
  676. das ausgewählte Regex verwendet
  677. </para>
  678. </listitem>
  679. <listitem>
  680. <para>
  681. <code>(array, array() by default) tags</code> : Tags
  682. für den Cache Eintrag
  683. </para>
  684. </listitem>
  685. <listitem>
  686. <para>
  687. <code>(int, null by default) priority</code> :
  688. Priorität (wenn das Backend das unterstützt)
  689. </para>
  690. </listitem>
  691. </itemizedlist>
  692. </entry>
  693. </row>
  694. <row>
  695. <entry><code>regexps</code></entry>
  696. <entry><code>array</code></entry>
  697. <entry><code>array()</code></entry>
  698. <entry>
  699. Ein assoziatives Array, um Optionen nur für einige REQUEST_URI
  700. zu setzen. Die Schlüssel sind reguläre Ausdrücke (PCRE), die
  701. Werte sind ein assoziatives Array mit spezifischen Optionen, die
  702. gesetzt werden sollen, wenn der reguläre Ausdruck auf
  703. $_SERVER['REQUEST_URI'] passt (siehe die default_options für
  704. eine Liste der verfügbaren Optionen); wenn verschiedene reguläre
  705. Ausdrücke auf $_SERVER['REQUEST_URI'] passen, wird nur der
  706. letzte verwendet.
  707. </entry>
  708. </row>
  709. <row>
  710. <entry><code>memorize_headers</code></entry>
  711. <entry><code>array</code></entry>
  712. <entry><code>array()</code></entry>
  713. <entry>
  714. Ein Array von Strings die zu einem HTTP Headernamen
  715. korrespondieren. Aufgelistete Header werden mit den Cache Daten
  716. gespeichert und wieder "abgespielt" wenn der Cache getroffen
  717. wird.
  718. </entry>
  719. </row>
  720. </tbody>
  721. </tgroup>
  722. </table>
  723. </sect3>
  724. <sect3 id="zend.cache.frontends.page.examples">
  725. <title>Beispiele</title>
  726. <para>
  727. Die Verwendung von <classname>Zend_Cache_Frontend_Page</classname> ist wirklich
  728. trivial :
  729. </para>
  730. <programlisting language="php"><![CDATA[
  731. // [...] // Benötigt, Konfiguration und Factory
  732. $cache->start();
  733. // Wenn der Cache gefunden wurde, wird das Ergebnis zum Browser geschickt,
  734. // und das Skript stoppt hier
  735. // Rest der Seite ...
  736. ]]></programlisting>
  737. <para>
  738. Ein etwas komplexeres Beispiel, welches einen Weg zeigt, um ein zentralisiertes
  739. Cache Management in einer Bootstrap Datei zu erhalten (um es z.B. mit
  740. <classname>Zend_Controller</classname> zu verwenden)
  741. </para>
  742. <programlisting language="php"><![CDATA[
  743. /*
  744. * Es sollte vermieden werden, zu viele Zeilen vor dem Cache Bereich zu setzen
  745. * zum Beispiel sollten für optimale Performanz "require_once" oder
  746. * "Zend_Loader::loadClass" nach dem Cache Bereich stehen
  747. */
  748. $frontendOptions = array(
  749. 'lifetime' => 7200,
  750. 'debug_header' => true, // für das Debuggen
  751. 'regexps' => array(
  752. // cache den gesamten IndexController
  753. '^/$' => array('cache' => true),
  754. // cache den gesamten IndexController
  755. '^/index/' => array('cache' => true),
  756. // wir cachen nicht den ArticleController...
  757. '^/article/' => array('cache' => false),
  758. // ...aber wir cachen die "View" Aktion von diesem ArticleController
  759. '^/article/view/' => array(
  760. 'cache' => true,
  761. // und wir cachen sogar wenn es einige Variablen in $_POST gibt
  762. 'cache_with_post_variables' => true,
  763. // aber die Cache Id wird vom $_POST Array abhängig sein
  764. 'make_id_with_post_variables' => true,
  765. )
  766. )
  767. );
  768. $backendOptions = array(
  769. 'cache_dir' => '/tmp/'
  770. );
  771. // erhalte ein Zend_Cache_Frontend_Page Objekt
  772. $cache = Zend_Cache::factory('Page',
  773. 'File',
  774. $frontendOptions,
  775. $backendOptions);
  776. $cache->start();
  777. // Wenn der Cache gefunden wurde, wird das Ergebnis zum Browser geschickt,
  778. // und das Skript stoppt hier
  779. // [...] das Ende der Bootstrap Datei
  780. // diese Zeilen werden nicht ausgeführt, wenn der Cache ausgegeben wurde
  781. ]]></programlisting>
  782. </sect3>
  783. <sect3 id="zend.cache.frontends.page.cancel">
  784. <title>Die spezielle cancel Methode</title>
  785. <para>
  786. Aus Designgründen, kann es in einigen Fällen (zum Beispiel bei Verwendung von nicht
  787. HTTP/200 Return Codes), notwendig sein den aktuellen Cacheprozess zu unterbrechen.
  788. Deshalb zeigen wir für dieses spezielle Frontend die cancel() Methode.
  789. </para>
  790. <programlisting language="php"><![CDATA[
  791. // [...] // Benötigt, Konfiguration und Factory
  792. $cache->start();
  793. // [...]
  794. if ($someTest) {
  795. $cache->cancel();
  796. // [...]
  797. }
  798. // [...]
  799. ]]></programlisting>
  800. </sect3>
  801. </sect2>
  802. </sect1>