Zend_Cache-Frontends.xml 38 KB

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