2
0

Zend_Cache-Frontends.xml 41 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 15965 -->
  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><emphasis>caching</emphasis></entry>
  43. <entry><type>Boolean</type></entry>
  44. <entry><constant>TRUE</constant></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><emphasis>cache_id_prefix</emphasis></entry>
  52. <entry><type>String</type></entry>
  53. <entry><constant>NULL</constant></entry>
  54. <entry>
  55. Ein Präfix für alle Cache IDs. Wenn er auf
  56. <constant>NULL</constant> gesetzt wird, wird kein Cache ID Präfix
  57. verwendet. Der Cache ID Präfix erstellt grundsätzlich einen
  58. Namespace im Cache, der verschiedenen Anwendungen oder Websites
  59. die Verwendung eines gemeinsamen Caches erlaubt. Jede Anwendung
  60. oder Website kann einen anderen Cache ID Prüfix verwenden sodas
  61. spezielle Cache IDs mehr als einmal verwendet werden können.
  62. </entry>
  63. </row>
  64. <row>
  65. <entry><emphasis>lifetime</emphasis></entry>
  66. <entry><type>Integer</type></entry>
  67. <entry>3600</entry>
  68. <entry>
  69. Cache Lebensdauer (in Sekunden), wenn auf <constant>NULL</constant>
  70. gesetzt, ist der Cache für immer gültig.
  71. </entry>
  72. </row>
  73. <row>
  74. <entry><emphasis>logging</emphasis></entry>
  75. <entry><type>Boolean</type></entry>
  76. <entry><constant>FALSE</constant></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><emphasis>write_control</emphasis></entry>
  85. <entry><type>Boolean</type></entry>
  86. <entry><constant>TRUE</constant></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><emphasis>automatic_serialization</emphasis></entry>
  98. <entry><type>Boolean</type></entry>
  99. <entry><constant>FALSE</constant></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><emphasis>automatic_cleaning_factor</emphasis></entry>
  108. <entry><type>Integer</type></entry>
  109. <entry>10</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><emphasis>ignore_user_abort</emphasis></entry>
  119. <entry><type>Boolean</type></entry>
  120. <entry><constant>FALSE</constant></entry>
  121. <entry>
  122. Auf true gesetzt, wird der Kern das <acronym>PHP</acronym> Flag
  123. ignore_user_abort innerhalb der <methodname>save()</methodname>
  124. Methode setzen um Cache Korruption in einigen Fällen zu verhindern
  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 <acronym>PHP</acronym>, um alles
  221. zwischen der <methodname>start()</methodname> und der
  222. <methodname>end()</methodname> Methode zu fangen.
  223. </para>
  224. </sect3>
  225. <sect3 id="zend.cache.frontends.output.options">
  226. <title>Mögliche Optionen</title>
  227. <para>
  228. Dieses Frontend hat keine bestimmten Optionen zusätzlich zu denen von
  229. <classname>Zend_Cache_Core</classname>.
  230. </para>
  231. </sect3>
  232. <sect3 id="zend.cache.frontends.output.examples">
  233. <title>Beispiele</title>
  234. <para>
  235. Ein Beispiel wird ganz am Anfang des Handbuches gegeben. Hier ist es mit kleinen
  236. Änderungen:
  237. </para>
  238. <programlisting language="php"><![CDATA[
  239. // Wenn es ein Cache Miss ist, wird das puffern der Ausgabe ausgelöst
  240. if( ! ($cache->start('mypage'))) {
  241. // Alle wie gewohnt ausgeben
  242. echo 'Hallo Welt! ';
  243. echo 'Das wird gecached ('.time().') ';
  244. $cache->end(); // Ausgabepufferung beenden
  245. }
  246. echo 'Hier wird nie gecached ('.time().').';
  247. ]]></programlisting>
  248. <para>
  249. Die Verwendung dieser Form ist ziemlich einfach, um Ausgabe caching in einem bereits
  250. bestehenden Projekt, mit nur wenig oder gar keinen Codeänderungen, zu erhalten.
  251. </para>
  252. </sect3>
  253. </sect2>
  254. <sect2 id="zend.cache.frontends.function">
  255. <title>Zend_Cache_Frontend_Function</title>
  256. <sect3 id="zend.cache.frontends.function.introduction">
  257. <title>Einführung</title>
  258. <para>
  259. <classname>Zend_Cache_Frontend_Function</classname> cached das Ergebnis von
  260. Funktionsaufrufen. Es hat eine einzelne Hauptmethode genannt
  261. <methodname>call()</methodname>, welche den Funktionsnamen und Parameter für den
  262. Aufruf in einem Array entgegennimmt.
  263. </para>
  264. </sect3>
  265. <sect3 id="zend.cache.frontends.function.options">
  266. <title>Mögliche Optionen</title>
  267. <table id="zend.cache.frontends.function.options.table">
  268. <title>Cache Frontend Optionen</title>
  269. <tgroup cols="4">
  270. <thead>
  271. <row>
  272. <entry>Option</entry>
  273. <entry>Daten Typ</entry>
  274. <entry>Standardwert</entry>
  275. <entry>Beschreibung</entry>
  276. </row>
  277. </thead>
  278. <tbody>
  279. <row>
  280. <entry><emphasis>cache_by_default</emphasis></entry>
  281. <entry><type>Boolean</type></entry>
  282. <entry><constant>TRUE</constant></entry>
  283. <entry>
  284. Wenn true, wird der Funktionsaufruf standardmäßig gecached
  285. </entry>
  286. </row>
  287. <row>
  288. <entry><emphasis>cached_functions</emphasis></entry>
  289. <entry><type>Array</type></entry>
  290. <entry></entry>
  291. <entry>
  292. Funktionsnamen, die immer gecached werden sollen
  293. </entry>
  294. </row>
  295. <row>
  296. <entry><emphasis>non_cached_functions</emphasis></entry>
  297. <entry><type>Array</type></entry>
  298. <entry></entry>
  299. <entry>
  300. Funktionsnamen, die nie gecached werden sollen
  301. </entry>
  302. </row>
  303. </tbody>
  304. </tgroup>
  305. </table>
  306. </sect3>
  307. <sect3 id="zend.cache.frontends.function.examples">
  308. <title>Beispiele</title>
  309. <para>
  310. Die Verwendung der <methodname>call()</methodname> Funktion ist die gleiche, wie
  311. die von <methodname>call_user_func_array()</methodname> in <acronym>PHP</acronym>:
  312. </para>
  313. <programlisting language="php"><![CDATA[
  314. $cache->call('veryExpensiveFunc', $params);
  315. // $params ist ein Array
  316. // Für das Aufrufen von veryExpensiveFunc(1, 'foo', 'bar') mit Caching kann,
  317. // z.B. $cache->call('veryExpensiveFunc', array(1, 'foo', 'bar')) benutzt
  318. // werden
  319. ]]></programlisting>
  320. <para>
  321. <classname>Zend_Cache_Frontend_Function</classname> ist elegant genug, um beides zu
  322. cachen, den Rückgabewert der Funktion und deren interne Ausgabe.
  323. </para>
  324. <note><para>
  325. Man kann jede eingebaute oder benutzerdefinierte Funktion übergeben, mit Ausnahme
  326. von <methodname>array()</methodname>, <methodname>echo()</methodname>,
  327. <methodname>empty()</methodname>, <methodname>eval()</methodname>,
  328. <methodname>exit()</methodname>, <methodname>isset()</methodname>,
  329. <methodname>list()</methodname>, <methodname>print()</methodname> und
  330. <methodname>unset()</methodname>.
  331. </para></note>
  332. </sect3>
  333. </sect2>
  334. <sect2 id="zend.cache.frontends.class">
  335. <title>Zend_Cache_Frontend_Class</title>
  336. <sect3 id="zend.cache.frontends.class.introduction">
  337. <title>Einführung</title>
  338. <para>
  339. <classname>Zend_Cache_Frontend_Class</classname> ist unterschiedlich zu
  340. <classname>Zend_Cache_Frontend_Function</classname>, weil es das Cachen von Objekten
  341. und statischen Methodenaufrufen erlaubt.
  342. </para>
  343. </sect3>
  344. <sect3 id="zend.cache.frontends.class.options">
  345. <title>Mögliche Optionen</title>
  346. <table id="zend.cache.frontends.class.options.table">
  347. <title>Class Frontend Optionen</title>
  348. <tgroup cols="4">
  349. <thead>
  350. <row>
  351. <entry>Option</entry>
  352. <entry>Datentyp</entry>
  353. <entry>Standardwert</entry>
  354. <entry>Beschreibung</entry>
  355. </row>
  356. </thead>
  357. <tbody>
  358. <row>
  359. <entry><emphasis>cached_entity</emphasis> (Notwendig)</entry>
  360. <entry><type>Mixed</type></entry>
  361. <entry></entry>
  362. <entry>
  363. Wenn auf einen Klassennamen gesetzt, wird eine abstrakte Klasse
  364. gecached und es werden statische Aufrufe verwendet; wenn auf ein
  365. Objekt gesetzt, wird deren Objektmethoden gecached
  366. </entry>
  367. </row>
  368. <row>
  369. <entry><emphasis>cache_by_default</emphasis></entry>
  370. <entry><type>Boolean</type></entry>
  371. <entry><constant>TRUE</constant></entry>
  372. <entry>
  373. Wenn true, wird der Aufruf standardmäßig gecached
  374. </entry>
  375. </row>
  376. <row>
  377. <entry><emphasis>cached_methods</emphasis></entry>
  378. <entry><type>Array</type></entry>
  379. <entry></entry>
  380. <entry>
  381. Methodennamen, die immer gecached werden sollen
  382. </entry>
  383. </row>
  384. <row>
  385. <entry><emphasis>non_cached_methods</emphasis></entry>
  386. <entry><type>Array</type></entry>
  387. <entry></entry>
  388. <entry>
  389. Methodennamen, die nie gecached werden sollen
  390. </entry>
  391. </row>
  392. </tbody>
  393. </tgroup>
  394. </table>
  395. </sect3>
  396. <sect3 id="zend.cache.frontends.class.examples">
  397. <title>Beispiele</title>
  398. <para>
  399. zum Beispiel, um einen statischen Aufruf zu cachen:
  400. </para>
  401. <programlisting language="php"><![CDATA[
  402. class Test {
  403. // Statische Methode
  404. public static function foobar($param1, $param2) {
  405. echo "foobar_output($param1, $param2)";
  406. return "foobar_return($param1, $param2)";
  407. }
  408. }
  409. // [...]
  410. $frontendOptions = array(
  411. 'cached_entity' => 'Test' // Der Name der Klasse
  412. );
  413. // [...]
  414. // Der gecachte Aufruf
  415. $result = $cache->foobar('1', '2');
  416. ]]></programlisting>
  417. <para>
  418. Um klassische Methodenaufrufe zu cachen :
  419. </para>
  420. <programlisting language="php"><![CDATA[
  421. class Test {
  422. private $_string = 'Hallo !';
  423. public function foobar2($param1, $param2) {
  424. echo($this->_string);
  425. echo "foobar2_output($param1, $param2)";
  426. return "foobar2_return($param1, $param2)";
  427. }
  428. }
  429. // [...]
  430. $frontendOptions = array(
  431. 'cached_entity' => new Test() // Eine Instanz der Klasse
  432. );
  433. // [...]
  434. // Der gecachte Aufruf
  435. $res = $cache->foobar2('1', '2');
  436. ]]></programlisting>
  437. </sect3>
  438. </sect2>
  439. <sect2 id="zend.cache.frontends.file">
  440. <title>Zend_Cache_Frontend_File</title>
  441. <sect3 id="zend.cache.frontends.file.introduction">
  442. <title>Einführung</title>
  443. <para>
  444. <classname>Zend_Cache_Frontend_File</classname> ist ein Frontend angetrieben durch
  445. den Änderungszeitpunkt einer "Masterdatei". Es ist wirklich interessant für
  446. Beispiele in Konfigurations- oder Templateanwendungen. Es ist auch möglich mehrere
  447. Masterdateien zu verwenden.
  448. </para>
  449. <para>
  450. Zum Beispiel eine <acronym>XML</acronym> Konfigurationsdatei, welche von einer
  451. Funktion geparsed wird und die ein "Config Objekt" zurückgibt (wie durch
  452. <classname>Zend_Config</classname>). Mit
  453. <classname>Zend_Cache_Frontend_File</classname> kann das "Config Objekt" im Cache
  454. gespeichert werden (um zu Verhindern, das die <acronym>XML</acronym> Konfiguration
  455. jedes mal geparsed wird), aber mit einer strengen Abhängigkeit zur "Masterdatei".
  456. Wenn also die <acronym>XML</acronym> Konfigurationsdatei geändert wird, wird der
  457. Cache sofort ungültig.
  458. </para>
  459. </sect3>
  460. <sect3 id="zend.cache.frontends.file.options">
  461. <title>Mögliche Optionen</title>
  462. <table id="zend.cache.frontends.file.options.table">
  463. <title>File Frontend Optionen</title>
  464. <tgroup cols="4">
  465. <thead>
  466. <row>
  467. <entry>Option</entry>
  468. <entry>Daten Typ</entry>
  469. <entry>Standardwert</entry>
  470. <entry>Beschreibung</entry>
  471. </row>
  472. </thead>
  473. <tbody>
  474. <row>
  475. <entry><emphasis>master_File (depreciated)</emphasis></entry>
  476. <entry><type>String</type></entry>
  477. <entry>''</entry>
  478. <entry>
  479. Der komplette Pfad und Name der Master Datei
  480. </entry>
  481. </row>
  482. <row>
  483. <entry><emphasis>master_files</emphasis></entry>
  484. <entry><type>Array</type></entry>
  485. <entry><methodname>array()</methodname></entry>
  486. <entry>
  487. Ein Array der kompletten Pfade der Masterdateien
  488. </entry>
  489. </row>
  490. <row>
  491. <entry><emphasis>master_files_mode</emphasis></entry>
  492. <entry><type>String</type></entry>
  493. <entry>
  494. <constant>Zend_Cache_Frontend_File::MODE_OR</constant>
  495. </entry>
  496. <entry>
  497. <constant>Zend_Cache_Frontend_File::MODE_AND</constant> oder
  498. <constant>Zend_Cache_Frontend_File::MODE_OR</constant> ;
  499. bei <constant>MODE_AND</constant> müssen alle Masterdateien
  500. angegriffen werden um einen Cache ungültig zu machen, bei
  501. <constant>MODE_OR</constant> ist eine eizelne angegriffene Datei
  502. genug um den Cache ungültig zu machen
  503. </entry>
  504. </row>
  505. <row>
  506. <entry><emphasis>ignore_missing_master_files</emphasis></entry>
  507. <entry><type>Boolean</type></entry>
  508. <entry><constant>FALSE</constant></entry>
  509. <entry>
  510. bei true werden fehlende Masterdateien leise ignoriert
  511. (andernfalls wird eine Exception geworfen)
  512. </entry>
  513. </row>
  514. </tbody>
  515. </tgroup>
  516. </table>
  517. </sect3>
  518. <sect3 id="zend.cache.frontends.file.examples">
  519. <title>Beispiele</title>
  520. <para>
  521. Die Verwendung dieses Frontends ist die gleiche wie die von
  522. <classname>Zend_Cache_Core</classname>. Es gibt kein eigenes Beispiel - was als
  523. einziges gemacht werden muß, ist das <emphasis>master_File</emphasis> zu
  524. definieren, wenn die Factory verwendet wird.
  525. </para>
  526. </sect3>
  527. </sect2>
  528. <sect2 id="zend.cache.frontends.page">
  529. <title>Zend_Cache_Frontend_Page</title>
  530. <sect3 id="zend.cache.frontends.page.introduction">
  531. <title>Einführung</title>
  532. <para>
  533. <classname>Zend_Cache_Frontend_Page</classname> ist wie
  534. <classname>Zend_Cache_Frontend_Output</classname> aber entwickelt für eine komplette
  535. Seite. Es ist unmöglich <classname>Zend_Cache_Frontend_Page</classname> nur für das
  536. Cachen eines einzelnen Blockes zu verwenden.
  537. </para>
  538. <para>
  539. Andererseits wird die "Cache ID" automatisch berechnet mit
  540. <varname>$_SERVER['REQUEST_URI']</varname> und (abhängig von den Optionen) mit
  541. <varname>$_GET</varname>, <varname>$_POST</varname>, <varname>$_SESSION</varname>,
  542. <varname>$_COOKIE</varname>, <varname>$_FILES</varname>. Trotzdem muß nur eine
  543. Methode aufgerufen werden (<methodname>start()</methodname>), weil der Aufruf von
  544. <methodname>end()</methodname> immer vollautomatisch ist, wenn die Seite endet.
  545. </para>
  546. <para>
  547. Zur Zeit ist es nicht eingebaut, aber es ist ein <acronym>HTTP</acronym> abhängiges
  548. System geplant, um Bandbreiten zu sparen (das System wird ein
  549. "<acronym>HTTP</acronym> 304 nicht geändert" schicken, wenn der Cache gefunden
  550. wurde und wenn der Browser bereits eine gültige Version hat).
  551. </para>
  552. </sect3>
  553. <sect3 id="zend.cache.frontends.page.options">
  554. <title>Mögliche Optionen</title>
  555. <table id="zend.cache.frontends.page.options.table">
  556. <title>Page Frontend Optionen</title>
  557. <tgroup cols="4">
  558. <thead>
  559. <row>
  560. <entry>Option</entry>
  561. <entry>Daten Typ</entry>
  562. <entry>Standardwert</entry>
  563. <entry>Beschreibung</entry>
  564. </row>
  565. </thead>
  566. <tbody>
  567. <row>
  568. <entry><emphasis>http_conditional</emphasis></entry>
  569. <entry><type>Boolean</type></entry>
  570. <entry><constant>FALSE</constant></entry>
  571. <entry>
  572. Verwendung des http_conditional Systems (zur Zeit nicht
  573. implementiert)
  574. </entry>
  575. </row>
  576. <row>
  577. <entry><emphasis>debug_header</emphasis></entry>
  578. <entry><type>Boolean</type></entry>
  579. <entry><constant>FALSE</constant></entry>
  580. <entry>
  581. Wenn true, wird eine Debugging Text for jeder gecacheten Seite
  582. hinzugefügt
  583. </entry>
  584. </row>
  585. <row>
  586. <entry><emphasis>default_options</emphasis></entry>
  587. <entry><type>Array</type></entry>
  588. <entry><methodname>array(...siehe unten...)</methodname></entry>
  589. <entry>
  590. Ein assoziatives Array mit Default Optionen:
  591. <itemizedlist>
  592. <listitem>
  593. <para>
  594. <emphasis>(boolean, true per Default)
  595. cache</emphasis> : Cache ist aktiviert wenn true
  596. </para>
  597. </listitem>
  598. <listitem>
  599. <para>
  600. <emphasis>(boolean, false per Default)
  601. cache_with_get_variables</emphasis> : wenn true,
  602. ist der Cache weiterhin aktiviert, selbst wenn es
  603. einige Variablen im <varname>$_GET</varname> Array
  604. gibt
  605. </para>
  606. </listitem>
  607. <listitem>
  608. <para>
  609. <emphasis>(boolean, false per Default)
  610. cache_with_post_variables</emphasis> : wenn true,
  611. ist der Cache weiterhin aktiviert, selbst wenn es
  612. einige Variablen im <varname>$_POST</varname> Array
  613. gibt
  614. </para>
  615. </listitem>
  616. <listitem>
  617. <para>
  618. <emphasis>(boolean, false per Default)
  619. cache_with_session_variables</emphasis> : wenn
  620. true, ist der Cache weiterhin aktiviert, selbst wenn
  621. es einige Variablen im <varname>$_SESSION</varname>
  622. Array gibt
  623. </para>
  624. </listitem>
  625. <listitem>
  626. <para>
  627. <emphasis>(boolean, false per Default)
  628. cache_with_files_variables</emphasis> : wenn
  629. true, ist der Cache weiterhin aktiviert, selbst wenn
  630. es einige Variablen im <varname>$_FILES</varname>
  631. Array gibt
  632. </para>
  633. </listitem>
  634. <listitem>
  635. <para>
  636. <emphasis>(boolean, false per Default)
  637. cache_with_cookie_variables</emphasis> : wenn
  638. true, ist der Cache weiterhin aktiviert, selbst wenn
  639. es einige Variablen im <varname>$_COOKIE</varname>
  640. Array gibt
  641. </para>
  642. </listitem>
  643. <listitem>
  644. <para>
  645. <emphasis>(boolean, true per Default)
  646. make_id_with_get_variables</emphasis> : wenn
  647. true, wird die Cache ID vom Inhalt des
  648. <varname>$_GET</varname> Arrays abhängig sein
  649. </para>
  650. </listitem>
  651. <listitem>
  652. <para>
  653. <emphasis>(boolean, true per Default)
  654. make_id_with_post_variables</emphasis> : wenn
  655. true, wird die Cache ID vom Inhalt des
  656. <varname>$_POST</varname> Arrays abhängig sein
  657. </para>
  658. </listitem>
  659. <listitem>
  660. <para>
  661. <emphasis>(boolean, true per Default)
  662. make_id_with_session_variables</emphasis> : wenn
  663. true, wird die Cache ID vom Inhalt des
  664. <varname>$_SESSION</varname> Arrays abhängig sein
  665. </para>
  666. </listitem>
  667. <listitem>
  668. <para>
  669. <emphasis>(boolean, true per Default)
  670. make_id_with_files_variables</emphasis> : wenn
  671. true, wird die Cache ID vom Inhalt des
  672. <varname>$_FILES</varname> Arrays abhängig sein
  673. </para>
  674. </listitem>
  675. <listitem>
  676. <para>
  677. <emphasis>(boolean, true per Default)
  678. make_id_with_cookie_variables</emphasis> : wenn
  679. true, wird die Cache ID vom Inhalt des
  680. <varname>$_COOKIE</varname> Arrays abhängig sein
  681. </para>
  682. </listitem>
  683. <listitem>
  684. <para>
  685. <emphasis>(int, false by default)
  686. specific_lifetime</emphasis> : wenn nicht false,
  687. wird die angegebene Lifetime für das ausgewählte
  688. Regex verwendet
  689. </para>
  690. </listitem>
  691. <listitem>
  692. <para>
  693. <emphasis>(array, array() by default) tags</emphasis>
  694. : Tags für den Cache Eintrag
  695. </para>
  696. </listitem>
  697. <listitem>
  698. <para>
  699. <emphasis>(int, null by default) priority</emphasis>
  700. : Priorität (wenn das Backend das unterstützt)
  701. </para>
  702. </listitem>
  703. </itemizedlist>
  704. </entry>
  705. </row>
  706. <row>
  707. <entry><emphasis>regexps</emphasis></entry>
  708. <entry><type>Array</type></entry>
  709. <entry><methodname>array()</methodname></entry>
  710. <entry>
  711. Ein assoziatives Array, um Optionen nur für einige
  712. <acronym>REQUEST_URI</acronym> zu setzen. Die Schlüssel sind
  713. reguläre Ausdrücke (<acronym>PCRE</acronym>), die Werte sind
  714. ein assoziatives Array mit spezifischen Optionen, die gesetzt
  715. werden sollen, wenn der reguläre Ausdruck auf
  716. <varname>$_SERVER['REQUEST_URI']</varname> passt (siehe die
  717. default_options für eine Liste der verfügbaren Optionen); wenn
  718. verschiedene reguläre Ausdrücke auf
  719. <varname>$_SERVER['REQUEST_URI']</varname> passen, wird nur der
  720. letzte verwendet.
  721. </entry>
  722. </row>
  723. <row>
  724. <entry><emphasis>memorize_headers</emphasis></entry>
  725. <entry><type>Array</type></entry>
  726. <entry><methodname>array()</methodname></entry>
  727. <entry>
  728. Ein Array von Strings die zu einem <acronym>HTTP</acronym>
  729. Headernamen korrespondieren. Aufgelistete Header werden mit den
  730. Cache Daten gespeichert und wieder "abgespielt" wenn der Cache
  731. getroffen wird.
  732. </entry>
  733. </row>
  734. </tbody>
  735. </tgroup>
  736. </table>
  737. </sect3>
  738. <sect3 id="zend.cache.frontends.page.examples">
  739. <title>Beispiele</title>
  740. <para>
  741. Die Verwendung von <classname>Zend_Cache_Frontend_Page</classname> ist wirklich
  742. trivial :
  743. </para>
  744. <programlisting language="php"><![CDATA[
  745. // [...] // Benötigt, Konfiguration und Factory
  746. $cache->start();
  747. // Wenn der Cache gefunden wurde, wird das Ergebnis zum Browser geschickt,
  748. // und das Skript stoppt hier
  749. // Rest der Seite ...
  750. ]]></programlisting>
  751. <para>
  752. Ein etwas komplexeres Beispiel, welches einen Weg zeigt, um ein zentralisiertes
  753. Cache Management in einer Bootstrap Datei zu erhalten (um es z.B. mit
  754. <classname>Zend_Controller</classname> zu verwenden)
  755. </para>
  756. <programlisting language="php"><![CDATA[
  757. /*
  758. * Es sollte vermieden werden, zu viele Zeilen vor dem Cache Bereich zu setzen
  759. * zum Beispiel sollten für optimale Performanz "require_once" oder
  760. * "Zend_Loader::loadClass" nach dem Cache Bereich stehen
  761. */
  762. $frontendOptions = array(
  763. 'lifetime' => 7200,
  764. 'debug_header' => true, // für das Debuggen
  765. 'regexps' => array(
  766. // cache den gesamten IndexController
  767. '^/$' => array('cache' => true),
  768. // cache den gesamten IndexController
  769. '^/index/' => array('cache' => true),
  770. // wir cachen nicht den ArticleController...
  771. '^/article/' => array('cache' => false),
  772. // ...aber wir cachen die "View" Aktion von diesem ArticleController
  773. '^/article/view/' => array(
  774. 'cache' => true,
  775. // und wir cachen sogar wenn es einige Variablen in $_POST gibt
  776. 'cache_with_post_variables' => true,
  777. // aber die Cache Id wird vom $_POST Array abhängig sein
  778. 'make_id_with_post_variables' => true,
  779. )
  780. )
  781. );
  782. $backendOptions = array(
  783. 'cache_dir' => '/tmp/'
  784. );
  785. // erhalte ein Zend_Cache_Frontend_Page Objekt
  786. $cache = Zend_Cache::factory('Page',
  787. 'File',
  788. $frontendOptions,
  789. $backendOptions);
  790. $cache->start();
  791. // Wenn der Cache gefunden wurde, wird das Ergebnis zum Browser geschickt,
  792. // und das Skript stoppt hier
  793. // [...] das Ende der Bootstrap Datei
  794. // diese Zeilen werden nicht ausgeführt, wenn der Cache ausgegeben wurde
  795. ]]></programlisting>
  796. </sect3>
  797. <sect3 id="zend.cache.frontends.page.cancel">
  798. <title>Die spezielle cancel Methode</title>
  799. <para>
  800. Aus Designgründen, kann es in einigen Fällen (zum Beispiel bei Verwendung von nicht
  801. <acronym>HTTP</acronym> 200 Return Codes), notwendig sein den aktuellen
  802. Cacheprozess zu unterbrechen. Deshalb zeigen wir für dieses spezielle Frontend die
  803. cancel() Methode.
  804. </para>
  805. <programlisting language="php"><![CDATA[
  806. // [...] // Benötigt, Konfiguration und Factory
  807. $cache->start();
  808. // [...]
  809. if ($someTest) {
  810. $cache->cancel();
  811. // [...]
  812. }
  813. // [...]
  814. ]]></programlisting>
  815. </sect3>
  816. </sect2>
  817. </sect1>