Zend_Cache-Frontends.xml 42 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <!-- EN-Revision: 20765 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.cache.frontends">
  5. <title>Les frontends Zend_Cache</title>
  6. <sect2 id="zend.cache.frontends.core">
  7. <title>Zend_Cache_Core</title>
  8. <sect3 id="zend.cache.frontends.core.introduction">
  9. <title>Introduction</title>
  10. <para>
  11. <classname>Zend_Cache_Core</classname> est un frontend spécial parce qu'il est le
  12. coeur du module. C'est le frontend de cache générique qui est étendu par les autres
  13. classes.
  14. </para>
  15. <note>
  16. <para>
  17. Tous les frontends héritent de <classname>Zend_Cache_Core</classname> ainsi ses
  18. méthodes et options (décrites ci-dessous) seront aussi disponibles dans les
  19. autres frontends, cependant ils ne sont pas documentés ici.
  20. </para>
  21. </note>
  22. </sect3>
  23. <sect3 id="zend.cache.frontends.core.options">
  24. <title>Options disponibles</title>
  25. <para>
  26. Ces options sont passées à la méthode de fabrique comme montrées dans les
  27. exemples précédents.
  28. </para>
  29. <table id="zend.cache.frontends.core.options.table">
  30. <title>Options du frontend Core</title>
  31. <tgroup cols="4">
  32. <thead>
  33. <row>
  34. <entry>Option</entry>
  35. <entry>Type de données</entry>
  36. <entry>Valeur par défaut</entry>
  37. <entry>Description</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. Active / désactive le cache (peut-être très utile pour le
  47. débogage de scripts en cache)
  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. Un préfixe pour tous les ID de cache, si réglé à
  56. <constant>NULL</constant>, aucun préfixe d'ID de cache ne sera
  57. utilisé. Le préfixe d'ID de cache sert essentiellement à créer des
  58. espaces de noms dans le cache, permettant à plusieurs applications
  59. ou sites Web d'utiliser un cache partagé. Chaque application ou
  60. site web peut utilisé un préfixe d'ID de cache différent et un
  61. préfixe peut aussi être utilisé plusieurs fois.
  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. Temps de vie (en secondes) du cache, si défini à
  70. <constant>NULL</constant>, le cache est valide indéfiniment
  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. Si défini à <constant>TRUE</constant>, le logging par
  79. <classname>Zend_Log</classname> est activé (mais le système sera
  80. plus lent)
  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. Active / désactive le contrôle d'écriture (le cache est lu
  89. juste après l'écriture pour détecter des entrées corrompues),
  90. activer "writeControl" va ralentir un petit peu
  91. l'écriture du cache, mais pas la lecture (il peut détecter des
  92. fichiers de cache corrompus, mais ceci n'est pas un contrôle
  93. parfait).
  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. Active / désactive la sérialisation automatique, il peut
  102. être utilisé pour enregistrer directement des données qui ne sont
  103. pas des chaînes de caractères (mais c'est plus lent).
  104. </entry>
  105. </row>
  106. <row>
  107. <entry><emphasis>automatic_cleaning_factor</emphasis></entry>
  108. <entry><type>Integer</type></entry>
  109. <entry>0</entry>
  110. <entry>
  111. Active / désactive le nettoyage automatique ("garbage
  112. collector"): 0 signifie aucun nettoyage automatique de cache, 1
  113. signifie un nettoyage systématique du cache et x &gt; 1 signifie le
  114. nettoyage aléatoire 1 fois toute les x écritures.
  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. Si réglé à <constant>TRUE</constant>, le cache active le drapeau
  123. <acronym>PHP</acronym> "ignore_user_abort" dans la méthode
  124. <methodname>save()</methodname> pour prévenir de la corruption du
  125. cache dans certains cas.
  126. </entry>
  127. </row>
  128. </tbody>
  129. </tgroup>
  130. </table>
  131. </sect3>
  132. <sect3 id="zend.cache.core.examples">
  133. <title>Exemples</title>
  134. <para>Un exemple est donné dans le manuel, tout au début.</para>
  135. <para>
  136. Si vous stocker uniquement des chaînes de caractères dans le cache (parce
  137. qu'avec l'option "automatic_serialization", il est possible de stocker
  138. des booléens), vous pouvez utiliser une construction plus compact comme&#160;:
  139. </para>
  140. <programlisting language="php"><![CDATA[
  141. // nous avons déjà $cache
  142. $id = 'myBigLoop'; // id de cache de "ce que l'on veut cacher"
  143. if (!($data = $cache->load($id))) {
  144. // cache absent
  145. $data = '';
  146. for ($i = 0; $i < 10000; $i++) {
  147. $data = $data . $i;
  148. }
  149. $cache->save($data);
  150. }
  151. // [...] fait quelque chose avec $data
  152. // (affichage, passage ailleurs, etc, etc)
  153. ]]></programlisting>
  154. <para>
  155. Si vous voulez cacher des blocs multiples ou des instances de données, l'idée
  156. reste la même&#160;:
  157. </para>
  158. <programlisting language="php"><![CDATA[
  159. // on s'assure que l'on utilise des identifiant uniques
  160. $id1 = 'foo';
  161. $id2 = 'bar';
  162. // block 1
  163. if (!($data = $cache->load($id1))) {
  164. // cache absent
  165. $data = '';
  166. for ($i=0;$i<10000;$i++) {
  167. $data = $data . $i;
  168. }
  169. $cache->save($data);
  170. }
  171. echo($data);
  172. // ceci n'est pas affecté par la mise en cache
  173. echo('NEVER CACHED! ');
  174. // block 2
  175. if (!($data = $cache->load($id2))) {
  176. // cache missed
  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. Si vous voulez cacher des valeurs "spéciales" (des booléens avec l'option
  187. "automatic_serialization") ou des chaînes vides, vous ne pouvez pas
  188. utiliser la construction compacte montrée ci-dessus. Vous devez tester de manière
  189. formelle l'état du cache.
  190. </para>
  191. <programlisting language="php"><![CDATA[
  192. // La construction compacte (ne pas utiliser si vous cachez
  193. // des chaînes et/ou des booléens)
  194. if (!($data = $cache->load($id))) {
  195. // cache absent
  196. // [...] on crée $data
  197. $cache->save($data);
  198. }
  199. // on fait qqch avec $data
  200. // [...]
  201. // La construction complète (fonctionne dans tous les cas)
  202. if (!($cache->test($id))) {
  203. // cache absent
  204. // [...] on crée $data
  205. $cache->save($data);
  206. } else {
  207. // lecture du cache
  208. $data = $cache->load($id);
  209. }
  210. // on fait qqch avec $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>Introduction</title>
  218. <para>
  219. <classname>Zend_Cache_Frontend_Output</classname> est un frontend capturant la
  220. sortie. Il utilise la bufferisation de sortie de <acronym>PHP</acronym> pour
  221. capturer tout ce qui passe entre les méthodes <methodname>start()</methodname> et
  222. <methodname>end()</methodname>.
  223. </para>
  224. </sect3>
  225. <sect3 id="zend.cache.frontends.output.options">
  226. <title>Options disponibles</title>
  227. <para>
  228. Ce frontend n'a pas d'options spécifiques autres que celles de
  229. <classname>Zend_Cache_Core</classname>.
  230. </para>
  231. </sect3>
  232. <sect3 id="zend.cache.frontends.output.examples">
  233. <title>Exemples</title>
  234. <para>
  235. Un exemple est donnée dans le manuel, tout au début. Le voici avec des
  236. changements mineurs&#160;:
  237. </para>
  238. <programlisting language="php"><![CDATA[
  239. // s'il y a un cache manquant, la bufferisation de sortie est lancée
  240. if (!$cache->start('mypage')) {
  241. // affiche tout comme d'habitude
  242. echo 'Hello world! ';
  243. echo 'This is cached ('.time().') ';
  244. $cache->end(); // affiche ce qu'il y a dans le buffer
  245. }
  246. echo 'This is never cached ('.time().').';
  247. ]]></programlisting>
  248. <para>
  249. Utiliser cette forme est assez simple pour définir une mise de cache de
  250. sortie dans vos projets déjà en production, avec peu de refactorisation de
  251. code.
  252. </para>
  253. </sect3>
  254. </sect2>
  255. <sect2 id="zend.cache.frontends.function">
  256. <title>Zend_Cache_Frontend_Function</title>
  257. <sect3 id="zend.cache.frontends.function.introduction">
  258. <title>Introduction</title>
  259. <para>
  260. <classname>Zend_Cache_Frontend_Function</classname> met en cache les résultats des
  261. appels de fonction. Elle a une seule méthode principale appelée
  262. <methodname>call()</methodname> qui prend un nom de fonction et des paramètres pour
  263. l'appel dans un tableau.
  264. </para>
  265. </sect3>
  266. <sect3 id="zend.cache.frontends.function.options">
  267. <title>Options disponibles</title>
  268. <table id="zend.cache.frontends.function.options.table">
  269. <title>Options du frontend Function</title>
  270. <tgroup cols="4">
  271. <thead>
  272. <row>
  273. <entry>Option</entry>
  274. <entry>Type de données</entry>
  275. <entry>Valeur par défaut</entry>
  276. <entry>Description</entry>
  277. </row>
  278. </thead>
  279. <tbody>
  280. <row>
  281. <entry><emphasis>cache_by_default</emphasis></entry>
  282. <entry><type>Boolean</type></entry>
  283. <entry><constant>TRUE</constant></entry>
  284. <entry>
  285. si <constant>TRUE</constant>, les appels de fonction seront mis en
  286. cache par défaut
  287. </entry>
  288. </row>
  289. <row>
  290. <entry><emphasis>cached_functions</emphasis></entry>
  291. <entry><type>Array</type></entry>
  292. <entry>''</entry>
  293. <entry>les noms de fonctions seront toujours mis en cache</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. les noms de fonctions ne doivent jamais être mis en
  301. cache
  302. </entry>
  303. </row>
  304. </tbody>
  305. </tgroup>
  306. </table>
  307. </sect3>
  308. <sect3 id="zend.cache.frontends.function.examples">
  309. <title>Exemples</title>
  310. <para>
  311. Utiliser la fonction <methodname>call()</methodname> est la même chose qu'utiliser
  312. <methodname>call_user_func_array()</methodname> en <acronym>PHP</acronym>&#160;:
  313. </para>
  314. <programlisting language="php"><![CDATA[
  315. $cache->call('veryExpensiveFunc', $params);
  316. // $params est dans un tableau par exemple, pour appeler
  317. // (avec mise en cache) : veryExpensiveFunc(1, 'foo', 'bar')
  318. // vous devriez utiliser
  319. $cache->call('veryExpensiveFunc', array(1, 'foo', 'bar'));
  320. ]]></programlisting>
  321. <para>
  322. <classname>Zend_Cache_Frontend_Function</classname> est assez intelligente pour
  323. mettre en cache la valeur de retour de la fonction, ainsi que sa sortie interne.
  324. </para>
  325. <note>
  326. <para>
  327. Vous pouvez passer n'importe quelle fonction utilisateur à l'exception de
  328. <methodname>array()</methodname>, <methodname>echo()</methodname>,
  329. <methodname>empty()</methodname>, <methodname>eval()</methodname>,
  330. <methodname>exit()</methodname>, <methodname>isset()</methodname>,
  331. <methodname>list()</methodname>, <methodname>print()</methodname>
  332. et <methodname>unset()</methodname>.
  333. </para>
  334. </note>
  335. </sect3>
  336. </sect2>
  337. <sect2 id="zend.cache.frontends.class">
  338. <title>Zend_Cache_Frontend_Class</title>
  339. <sect3 id="zend.cache.frontends.class.introduction">
  340. <title>Introduction</title>
  341. <para>
  342. <classname>Zend_Cache_Frontend_Class</classname> est différent de
  343. <classname>Zend_Cache_Frontend_Function</classname> parce qu'elle permet de mettre
  344. en cache les objets et les méthodes statiques.
  345. </para>
  346. </sect3>
  347. <sect3 id="zend.cache.frontends.class.options">
  348. <title>Options disponibles</title>
  349. <table id="zend.cache.frontends.class.options.table">
  350. <title>Options du frontend Class</title>
  351. <tgroup cols="4">
  352. <thead>
  353. <row>
  354. <entry>Option</entry>
  355. <entry>Type de données</entry>
  356. <entry>Valeur par défaut</entry>
  357. <entry>Description</entry>
  358. </row>
  359. </thead>
  360. <tbody>
  361. <row>
  362. <entry><emphasis>cached_entity</emphasis> (requis)</entry>
  363. <entry><type>Mixed</type></entry>
  364. <entry></entry>
  365. <entry>
  366. si défini avec un nom de classe, nous allons mettre en cache
  367. une classe abstraite et utiliser uniquement les appels
  368. statiques&#160;; si défini avec un objet, nous allons mettre en
  369. cache les méthodes de cet objet.
  370. </entry>
  371. </row>
  372. <row>
  373. <entry><emphasis>cache_by_default</emphasis></entry>
  374. <entry><type>Boolean</type></entry>
  375. <entry><constant>TRUE</constant></entry>
  376. <entry>
  377. si <constant>TRUE</constant>, les appels vont être cachés par
  378. défaut
  379. </entry>
  380. </row>
  381. <row>
  382. <entry><emphasis>cached_methods</emphasis></entry>
  383. <entry><type>Array</type></entry>
  384. <entry></entry>
  385. <entry>
  386. les noms des méthodes qui seront toujours mis en
  387. cache
  388. </entry>
  389. </row>
  390. <row>
  391. <entry><emphasis>non_cached_methods</emphasis></entry>
  392. <entry><type>Array</type></entry>
  393. <entry></entry>
  394. <entry>
  395. les noms des méthodes qui ne doivent jamais être mises en
  396. cache
  397. </entry>
  398. </row>
  399. </tbody>
  400. </tgroup>
  401. </table>
  402. </sect3>
  403. <sect3 id="zend.cache.frontends.class.examples">
  404. <title>Exemples</title>
  405. <para>Par exemple, pour mettre en cache des appels statiques&#160;:</para>
  406. <programlisting language="php"><![CDATA[
  407. class test {
  408. // Méthode statique
  409. public static function foobar($param1, $param2) {
  410. echo "foobar_output($param1, $param2)";
  411. return "foobar_return($param1, $param2)";
  412. }
  413. }
  414. // [...]
  415. $frontendOptions = array(
  416. 'cached_entity' => 'test' // Le nom de la classe
  417. );
  418. // [...]
  419. // l'appel caché
  420. $res = $cache->foobar('1', '2');
  421. ]]></programlisting>
  422. <para>Pour mettre en cache des appels classiques aux méthodes&#160;:</para>
  423. <programlisting language="php"><![CDATA[
  424. class test {
  425. private $_string = 'hello !';
  426. public function foobar2($param1, $param2) {
  427. echo($this->_string);
  428. echo "foobar2_output($param1, $param2)";
  429. return "foobar2_return($param1, $param2)";
  430. }
  431. }
  432. // [...]
  433. $frontendOptions = array(
  434. 'cached_entity' => new test() // Une instance de la classe
  435. );
  436. // [...]
  437. // L'appel mis en cache
  438. $res = $cache->foobar2('1', '2');
  439. ]]></programlisting>
  440. </sect3>
  441. </sect2>
  442. <sect2 id="zend.cache.frontends.file">
  443. <title>Zend_Cache_Frontend_File</title>
  444. <sect3 id="zend.cache.frontends.file.introduction">
  445. <title>Introduction</title>
  446. <para>
  447. <classname>Zend_Cache_Frontend_File</classname> est un frontend piloté par la
  448. modification d'un "fichier maître". C'est vraiment intéressant, par exemple, dans
  449. les problématiques de configuration ou de templates. Il est également possible
  450. d'utiliser plusieurs fichiers maîtres.
  451. </para>
  452. <para>
  453. Par exemple, vous avez un fichier de configuration <acronym>XML</acronym> qui est
  454. analysé par une fonction, celle-ci retourne un "objet de configuration" (comme avec
  455. <classname>Zend_Config</classname>). Avec
  456. <classname>Zend_Cache_Frontend_File</classname>, vous pouvez stocker l'objet de
  457. configuration dans le cache (pour éviter d'analyser le fichier de configuration
  458. <acronym>XML</acronym> chaque fois) mais avec une sorte de forte dépendance au
  459. fichier maître. Ainsi si le fichier <acronym>XML</acronym> de configuration est
  460. modifié, le cache est immédiatement invalide.
  461. </para>
  462. </sect3>
  463. <sect3 id="zend.cache.frontends.file.options">
  464. <title>Options disponibles</title>
  465. <table id="zend.cache.frontends.file.options.table">
  466. <title>Options du frontend File</title>
  467. <tgroup cols="4">
  468. <thead>
  469. <row>
  470. <entry>Option</entry>
  471. <entry>Type de données</entry>
  472. <entry>Valeur par défaut</entry>
  473. <entry>Description</entry>
  474. </row>
  475. </thead>
  476. <tbody>
  477. <row>
  478. <entry><emphasis>master_file</emphasis> (déprécié)</entry>
  479. <entry><type>String</type></entry>
  480. <entry>''</entry>
  481. <entry>le chemin complet et le nom du fichier maître</entry>
  482. </row>
  483. <row>
  484. <entry><emphasis>master_files</emphasis></entry>
  485. <entry><type>Array</type></entry>
  486. <entry><methodname>array()</methodname></entry>
  487. <entry>un tableau de chemin complet de fichiers maîtres</entry>
  488. </row>
  489. <row>
  490. <entry><emphasis>master_files_mode</emphasis></entry>
  491. <entry><type>String</type></entry>
  492. <entry><constant>Zend_Cache_Frontend_File::MODE_OR</constant></entry>
  493. <entry>
  494. <constant>Zend_Cache_Frontend_File::MODE_AND</constant> oU
  495. <constant>Zend_Cache_Frontend_File::MODE_OR</constant> ; si
  496. <constant>MODE_AND</constant>, alors tous les fichiers maîtres
  497. doivent être modifiés pour rendre invalide le cache, si
  498. <constant>MODE_OR</constant>, alors un seul fichier maître modifié
  499. est nécessaire pour invalider le cache
  500. </entry>
  501. </row>
  502. <row>
  503. <entry><emphasis>ignore_missing_master_files</emphasis></entry>
  504. <entry><type>Boolean</type></entry>
  505. <entry><constant>FALSE</constant></entry>
  506. <entry>
  507. si <constant>TRUE</constant>, l'absence de fichiers maîtres est
  508. ignoré silencieusement (sinon une exception est levée)
  509. </entry>
  510. </row>
  511. </tbody>
  512. </tgroup>
  513. </table>
  514. </sect3>
  515. <sect3 id="zend.cache.frontends.file.examples">
  516. <title>Exemples</title>
  517. <para>
  518. L'utilisation de ce frontend est la même que celle de
  519. <classname>Zend_Cache_Core</classname>. Il n'y a pas besoin d'exemple spécifique -
  520. la seule chose à faire est de définir le <emphasis>master_file</emphasis> lors de
  521. l'utilisation de la fabrique.
  522. </para>
  523. </sect3>
  524. </sect2>
  525. <sect2 id="zend.cache.frontends.page">
  526. <title>Zend_Cache_Frontend_Page</title>
  527. <sect3 id="zend.cache.frontends.page.introduction">
  528. <title>Introduction</title>
  529. <para>
  530. <classname>Zend_Cache_Frontend_Page</classname> est comme
  531. <classname>Zend_Cache_Frontend_Output</classname> mais créé pour une page complète.
  532. Il est impossible d'utiliser <classname>Zend_Cache_Frontend_Page</classname> pour
  533. mettre en cache un bloc unique.
  534. </para>
  535. <para>
  536. D'un autre côté, le "cache ID", est calculé automatiquement avec
  537. <varname>$_SERVER['REQUEST_URI']</varname> et (en fonction des options)
  538. <varname>$_GET</varname>, <varname>$_POST</varname>, <varname>$_SESSION</varname>,
  539. <varname>$_COOKIE</varname>, <varname>$_FILES</varname>. De plus, vous avez
  540. seulement une méthode pour appeler (<methodname>start()</methodname>) parce que
  541. l'appel à <methodname>end()</methodname> est totalement automatique lorsque la page
  542. est terminé.
  543. </para>
  544. <para>
  545. Pour le moment, ceci n'est pas implémenté mais nous prévoyons d'ajouter un
  546. système de condition <acronym>HTTP</acronym> pour économiser de la bande passante
  547. (le système émettra un en-tête "<acronym>HTTP</acronym> 304 Not Modified" si le
  548. cache est trouvé, et si le navigateur a déjà la bonne version).
  549. </para>
  550. <note>
  551. <para>
  552. This frontend operates by registering a callback function to be called
  553. when the output buffering it uses is cleaned. In order for this to operate
  554. correctly, it must be the final output buffer in the request. To guarantee
  555. this, the output buffering used by the Dispatcher needs to be disabled by
  556. calling <classname>Zend_Controller_Front</classname>'s <methodname>setParam()
  557. </methodname> method, for example, $front->setParam('disableOutputBuffering',
  558. true) or adding
  559. "resources.frontcontroller.params.disableOutputBuffering = true"
  560. to your bootstrap configuration file (assumed INI) if using
  561. <classname>Zend_Application</classname>.
  562. </para>
  563. </note>
  564. </sect3>
  565. <sect3 id="zend.cache.frontends.page.options">
  566. <title>Options disponibles</title>
  567. <table id="zend.cache.frontends.page.options.table">
  568. <title>Options du frontend Page</title>
  569. <tgroup cols="4">
  570. <thead>
  571. <row>
  572. <entry>Option</entry>
  573. <entry>Type de données</entry>
  574. <entry>Valeur par défaut</entry>
  575. <entry>Description</entry>
  576. </row>
  577. </thead>
  578. <tbody>
  579. <row>
  580. <entry><emphasis>http_conditional</emphasis></entry>
  581. <entry><type>Boolean</type></entry>
  582. <entry><constant>FALSE</constant></entry>
  583. <entry>
  584. utilisez le système "httpConditionnal" ou pas
  585. (pas encore implémenté)
  586. </entry>
  587. </row>
  588. <row>
  589. <entry><emphasis>debug_header</emphasis></entry>
  590. <entry><type>Boolean</type></entry>
  591. <entry><constant>FALSE</constant></entry>
  592. <entry>
  593. si <constant>TRUE</constant>, un texte de débogage est ajouté avant
  594. chaque page de cache
  595. </entry>
  596. </row>
  597. <row>
  598. <entry><emphasis>default_options</emphasis></entry>
  599. <entry><type>Array</type></entry>
  600. <entry><methodname>array(...see below...)</methodname></entry>
  601. <entry>
  602. un tableau associatif d'options par défaut&#160;:
  603. <itemizedlist>
  604. <listitem>
  605. <para>
  606. <emphasis>(boolean, <constant>TRUE</constant> par
  607. défaut) cache</emphasis>&#160;:
  608. le cache est activé si <constant>TRUE</constant>
  609. </para>
  610. </listitem>
  611. <listitem>
  612. <para>
  613. <emphasis>(boolean, <constant>FALSE</constant> par
  614. défaut) cache_with_get_variables</emphasis>&#160;: si
  615. <constant>TRUE</constant>, le cache est toujours activé
  616. même s'il y a des variables dans le tableau
  617. <varname>$_GET</varname>
  618. </para>
  619. </listitem>
  620. <listitem>
  621. <para>
  622. <emphasis>(boolean, <constant>FALSE</constant> par
  623. défaut) cache_with_post_variables</emphasis>&#160;: si
  624. <constant>TRUE</constant>, le cache est toujours activé
  625. même s'il y a des variables dans le tableau
  626. <varname>$_POST</varname>
  627. </para>
  628. </listitem>
  629. <listitem>
  630. <para>
  631. <emphasis>(boolean, <constant>FALSE</constant> par
  632. défaut) cache_with_session_variables</emphasis>&#160;:
  633. si <constant>TRUE</constant>, le cache est toujours
  634. activé s'il y a des variables dans le tableau
  635. <varname>$_SESSION</varname>
  636. </para>
  637. </listitem>
  638. <listitem>
  639. <para>
  640. <emphasis>(boolean, <constant>FALSE</constant> par
  641. défaut) cache_with_files_variables</emphasis>&#160;: si
  642. <constant>TRUE</constant>, le cache est toujours activé
  643. s'il y a des variables dans le tableau
  644. <varname>$_FILES</varname>
  645. </para>
  646. </listitem>
  647. <listitem>
  648. <para>
  649. <emphasis>(boolean, <constant>FALSE</constant> par
  650. défaut) cache_with_cookie_variables</emphasis>&#160;: si
  651. <constant>TRUE</constant>, le cache est toujours activé
  652. s'il y a des variables dans le tableau
  653. <varname>$_COOKIE</varname>
  654. </para>
  655. </listitem>
  656. <listitem>
  657. <para>
  658. <emphasis>(boolean, <constant>TRUE</constant> par
  659. défaut) make_id_with_get_variables</emphasis>&#160;: si
  660. <constant>TRUE</constant>, l'identifiant du cache sera
  661. dépendant du contenu du tableau <varname>$_GET</varname>
  662. </para>
  663. </listitem>
  664. <listitem>
  665. <para>
  666. <emphasis>(boolean, <constant>TRUE</constant> par
  667. défaut) make_id_with_post_variables</emphasis>&#160;:
  668. si <constant>TRUE</constant>, l'identifiant du cache
  669. sera dépendant du contenu du tableau
  670. <varname>$_POST</varname>
  671. </para>
  672. </listitem>
  673. <listitem>
  674. <para>
  675. <emphasis>(boolean, <constant>TRUE</constant> par
  676. défaut) make_id_with_session_variables</emphasis>&#160;:
  677. si <constant>TRUE</constant>, l'identifiant du cache
  678. sera dépendant du contenu du tableau
  679. <varname>$_SESSION</varname>
  680. </para>
  681. </listitem>
  682. <listitem>
  683. <para>
  684. <emphasis>(boolean, <constant>TRUE</constant> par
  685. défaut) make_id_with_files_variables</emphasis>&#160;:
  686. si <constant>TRUE</constant>, l'identifiant du cache
  687. sera dépendant du contenu du tableau
  688. <varname>$_FILES</varname>
  689. </para>
  690. </listitem>
  691. <listitem>
  692. <para>
  693. <emphasis>(boolean, <constant>TRUE</constant> par
  694. défaut) make_id_with_cookie_variables</emphasis>&#160;:
  695. si <constant>TRUE</constant>, l'identifiant du cache
  696. sera dépendant du contenu du tableau
  697. <varname>$_COOKIE</varname>
  698. </para>
  699. </listitem>
  700. <listitem>
  701. <para>
  702. <emphasis>(int, <constant>FALSE</constant> par défaut)
  703. specific_lifetime</emphasis>&#160;: si
  704. <constant>TRUE</constant>, la durée de vie fournie sera
  705. utilisée pour l'expression régulière choisie
  706. </para>
  707. </listitem>
  708. <listitem>
  709. <para>
  710. <emphasis>(array, <methodname>array()</methodname> par
  711. défaut) tags</emphasis>&#160;:
  712. balises pour l'enregistrement en cache
  713. </para>
  714. </listitem>
  715. <listitem>
  716. <para>
  717. <emphasis>(int, <constant>NULL</constant> par défaut)
  718. priority</emphasis>&#160;:
  719. priorité (si le backend le supporte)
  720. </para>
  721. </listitem>
  722. </itemizedlist></entry>
  723. </row>
  724. <row>
  725. <entry><emphasis>regexps</emphasis></entry>
  726. <entry><type>Array</type></entry>
  727. <entry><methodname>array()</methodname></entry>
  728. <entry>
  729. un tableau associatif pour définir les options, uniquement
  730. pour certaines <constant>REQUEST_URI</constant>, les clés sont des
  731. expressions régulières <acronym>PCRE</acronym>, les valeurs sont
  732. des tableaux associatifs avec des options spécifiques pour définir
  733. si les expressions régulières correspondent dans
  734. <varname>$_SERVER['REQUEST_URI']</varname> (voir les options par
  735. défaut pour la liste des options disponibles) ; si plusieurs
  736. expressions régulières correspondent à un
  737. <varname>$_SERVER['REQUEST_URI']</varname>, seule la dernière
  738. sera utilisée.
  739. </entry>
  740. </row>
  741. <row>
  742. <entry><emphasis>memorize_headers</emphasis></entry>
  743. <entry><type>Array</type></entry>
  744. <entry><methodname>array()</methodname></entry>
  745. <entry>
  746. un tableau de chaînes correspondant aux noms d'en-têtes
  747. <acronym>HTTP</acronym>. Les en-têtes listés seront stockées avec
  748. les données de cache et renvoyées lorsque le cache sera rappelé.
  749. </entry>
  750. </row>
  751. </tbody>
  752. </tgroup>
  753. </table>
  754. </sect3>
  755. <sect3 id="zend.cache.frontends.page.examples">
  756. <title>Exemples</title>
  757. <para>
  758. L'utilisation de <classname>Zend_Cache_Frontend_Page</classname> est vraiment
  759. trivial&#160;:
  760. </para>
  761. <programlisting language="php"><![CDATA[
  762. // [...] // require, configuration et factory
  763. $cache->start();
  764. // si le cache est trouvé, le résultat est envoyé au navigateur
  765. // et le script s'arrête là
  766. // reste de la page ...
  767. ]]></programlisting>
  768. <para>
  769. Un exemple plus complexe qui montre un moyen pour obtenir une gestion
  770. centralisée du cache dans un fichier d'amorçage (pour utiliser avec
  771. <classname>Zend_Controller</classname> par exemple)
  772. </para>
  773. <programlisting language="php"><![CDATA[
  774. // vous devriez éviter de mettre trop de lignes avant la section
  775. // de cache par exemple, pour des performances optimales,
  776. // "require_once" ou "Zend_Loader::loadClass" devrait être
  777. // après la section de cache
  778. $frontendOptions = array(
  779. 'lifetime' => 7200,
  780. 'debug_header' => true, // pour le déboguage
  781. 'regexps' => array(
  782. // met en cache la totalité d'IndexController
  783. '^/$' => array('cache' => true),
  784. // met en cache la totalité d'IndexController
  785. '^/index/' => array('cache' => true),
  786. // nous ne mettons pas en cache l'ArticleController...
  787. '^/article/' => array('cache' => false),
  788. // ...mais nous mettons en cache l'action "view"
  789. '^/article/view/' => array(
  790. // de cet ArticleController
  791. 'cache' => true,
  792. // et nous mettons en cache même lorsqu'il y a
  793. // des variables dans $_POST
  794. 'cache_with_post_variables' => true,
  795. // (mais le cache sera dépendent du tableau $_POST)
  796. 'make_id_with_post_variables' => true,
  797. )
  798. )
  799. );
  800. $backendOptions = array(
  801. 'cache_dir' => '/tmp/'
  802. );
  803. // obtenir un objet Zend_Cache_Frontend_Page
  804. $cache = Zend_Cache::factory('Page',
  805. 'File',
  806. $frontendOptions,
  807. $backendOptions);
  808. $cache->start();
  809. // si nous trouvons un cache, le résultat est envoyé au navigateur,
  810. // et le script s'arrête là
  811. // [...] la fin du fichier de démarrage
  812. // (ces lignes ne seront pas exécutées si on trouve un cache)
  813. ]]></programlisting>
  814. </sect3>
  815. <sect3 id="zend.cache.frontends.page.cancel">
  816. <title>La méthode spécifique cancel()</title>
  817. <para>
  818. A cause de problèmes de design, dans certains cas (par exemple quand on
  819. utilise des codes de retour <acronym>HTTP</acronym> autres que 200), vous
  820. pouvez avoir besoin de stopper le processus de mise en cache courant. Il a donc été
  821. introduit pour ce frontend en particulier, la méthode
  822. <methodname>cancel()</methodname>.
  823. </para>
  824. <programlisting language="php"><![CDATA[
  825. // [...] require, configuration et fabrique
  826. $cache->start();
  827. // [...]
  828. if ($unTest) {
  829. $cache->cancel();
  830. // [...]
  831. }
  832. // [...]
  833. ]]></programlisting>
  834. </sect3>
  835. </sect2>
  836. </sect1>