2
0

Zend_Cache-Frontends.xml 39 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <!-- EN-Revision: 15617 -->
  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><code>caching</code></entry>
  43. <entry><code>boolean</code></entry>
  44. <entry><code>true</code></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><code>cache_id_prefix</code></entry>
  52. <entry><code>string</code></entry>
  53. <entry><code>null</code></entry>
  54. <entry>
  55. Un préfixe pour tous les ID de cache, si réglé à
  56. <code>null</code>, aucun préfixe d'ID de cache ne sera utilisé. Le
  57. préfixe d'ID de cache sert essentiellement à créer des espaces de
  58. noms dans le cache, permettant à plusieurs applications ou sites
  59. Web d'utiliser un cache partagé. Chaque application ou site web
  60. peut utilisé un préfixe d'ID de cache différent et un préfixe peut
  61. aussi être utilisé plusieurs fois.
  62. </entry>
  63. </row>
  64. <row>
  65. <entry><code>lifetime</code></entry>
  66. <entry><code>integer</code></entry>
  67. <entry><code>3600</code></entry>
  68. <entry>
  69. Temps de vie (en secondes) du cache, si défini à
  70. <code>null</code>, le cache est valide indéfiniment
  71. </entry>
  72. </row>
  73. <row>
  74. <entry><code>logging</code></entry>
  75. <entry><code>boolean</code></entry>
  76. <entry><code>false</code></entry>
  77. <entry>
  78. Si défini à <code>true</code>, 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><code>write_control</code></entry>
  85. <entry><code>boolean</code></entry>
  86. <entry><code>true</code></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 "<code>writeControl</code>" 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><code>automatic_serialization</code></entry>
  98. <entry><code>boolean</code></entry>
  99. <entry><code>false</code></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><code>automatic_cleaning_factor</code></entry>
  108. <entry><code>int</code></entry>
  109. <entry><code>0</code></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><code>ignore_user_abort</code></entry>
  119. <entry><code>boolean</code></entry>
  120. <entry><code>false</code></entry>
  121. <entry>
  122. Si réglé à <code>true</code>, le cache active un drapeau
  123. "<code>ignore_user_abort</code>" dans la méthode
  124. <code>save()</code> pour prévenir de la corruption du cache dans
  125. 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 "<code>automatic_serialization</code>", 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. "<code>automatic_serialization</code>") 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 PHP pour capturer tout ce qui
  221. passe entre les méthodes <code>start()</code> et <code>end()</code>.
  222. </para>
  223. </sect3>
  224. <sect3 id="zend.cache.frontends.output.options">
  225. <title>Options disponibles</title>
  226. <para>
  227. Ce frontend n'a pas d'options spécifiques autres que celles de
  228. <classname>Zend_Cache_Core</classname>.
  229. </para>
  230. </sect3>
  231. <sect3 id="zend.cache.frontends.output.examples">
  232. <title>Exemples</title>
  233. <para>
  234. Un exemple est donnée dans le manuel, tout au début. Le voici avec des
  235. changements mineurs&#160;:
  236. </para>
  237. <programlisting language="php"><![CDATA[
  238. // s'il y a un cache manquant, la bufferisation de sortie est lancée
  239. if (!$cache->start('mypage')) {
  240. // affiche tout comme d'habitude
  241. echo 'Hello world! ';
  242. echo 'This is cached ('.time().') ';
  243. $cache->end(); // affiche ce qu'il y a dans le buffer
  244. }
  245. echo 'This is never cached ('.time().').';
  246. ]]></programlisting>
  247. <para>
  248. Utiliser cette forme est assez simple pour définir une mise de cache de
  249. sortie dans vos projets déjà en production, avec peu de refactorisation de
  250. code.
  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>Introduction</title>
  258. <para>
  259. <classname>Zend_Cache_Frontend_Function</classname> met en cache les résultats des
  260. appels de fonction. Elle a une seule méthode principale appelée <code>call()</code>
  261. qui prend un nom de fonction et des paramètres pour l'appel dans un tableau.
  262. </para>
  263. </sect3>
  264. <sect3 id="zend.cache.frontends.function.options">
  265. <title>Options disponibles</title>
  266. <table id="zend.cache.frontends.function.options.table">
  267. <title>Options du frontend Function</title>
  268. <tgroup cols="4">
  269. <thead>
  270. <row>
  271. <entry>Option</entry>
  272. <entry>Type de données</entry>
  273. <entry>Valeur par défaut</entry>
  274. <entry>Description</entry>
  275. </row>
  276. </thead>
  277. <tbody>
  278. <row>
  279. <entry><code>cache_by_default</code></entry>
  280. <entry><code>boolean</code></entry>
  281. <entry><code>true</code></entry>
  282. <entry>
  283. si <code>true</code>, les appels de fonction seront mis en
  284. cache par défaut
  285. </entry>
  286. </row>
  287. <row>
  288. <entry><code>cached_functions</code></entry>
  289. <entry><code>array</code></entry>
  290. <entry></entry>
  291. <entry>les noms de fonctions seront toujours mis en cache</entry>
  292. </row>
  293. <row>
  294. <entry><code>non_cached_functions</code></entry>
  295. <entry><code>array</code></entry>
  296. <entry></entry>
  297. <entry>
  298. les noms de fonctions ne doivent jamais être mis en
  299. cache
  300. </entry>
  301. </row>
  302. </tbody>
  303. </tgroup>
  304. </table>
  305. </sect3>
  306. <sect3 id="zend.cache.frontends.function.examples">
  307. <title>Exemples</title>
  308. <para>
  309. Utiliser la fonction <code>call()</code> est la même chose qu'utiliser
  310. <code>call_user_func_array()</code> en PHP&#160;:
  311. </para>
  312. <programlisting language="php"><![CDATA[
  313. $cache->call('veryExpensiveFunc', $params);
  314. // $params est dans un tableau par exemple, pour appeler
  315. // (avec mise en cache) : veryExpensiveFunc(1, 'foo', 'bar')
  316. // vous devriez utiliser
  317. $cache->call('veryExpensiveFunc', array(1, 'foo', 'bar'));
  318. ]]></programlisting>
  319. <para>
  320. <classname>Zend_Cache_Frontend_Function</classname> est assez intelligente pour
  321. mettre en cache la valeur de retour de la fonction, ainsi que sa sortie interne.
  322. </para>
  323. <note>
  324. <para>
  325. Vous pouvez passer n'importe quelle fonction utilisateur à l'exception de
  326. <code>array()</code>, <code>echo()</code>, <code>empty()</code>,
  327. <code>eval()</code>, <code>exit()</code>, <code>isset()</code>,
  328. <code>list()</code>, <code>print()</code> et <code>unset()</code>.
  329. </para>
  330. </note>
  331. </sect3>
  332. </sect2>
  333. <sect2 id="zend.cache.frontends.class">
  334. <title>Zend_Cache_Frontend_Class</title>
  335. <sect3 id="zend.cache.frontends.class.introduction">
  336. <title>Introduction</title>
  337. <para>
  338. <classname>Zend_Cache_Frontend_Class</classname> est différent de
  339. <classname>Zend_Cache_Frontend_Function</classname> parce qu'elle permet de mettre
  340. en cache les objets et les méthodes statiques.
  341. </para>
  342. </sect3>
  343. <sect3 id="zend.cache.frontends.class.options">
  344. <title>Options disponibles</title>
  345. <table id="zend.cache.frontends.class.options.table">
  346. <title>Options du frontend Class</title>
  347. <tgroup cols="4">
  348. <thead>
  349. <row>
  350. <entry>Option</entry>
  351. <entry>Type de données</entry>
  352. <entry>Valeur par défaut</entry>
  353. <entry>Description</entry>
  354. </row>
  355. </thead>
  356. <tbody>
  357. <row>
  358. <entry><code>cached_entity</code> (requis)</entry>
  359. <entry><code>mixed</code></entry>
  360. <entry></entry>
  361. <entry>
  362. si défini avec un nom de classe, nous allons mettre en cache
  363. une classe abstraite et utiliser uniquement les appels
  364. statiques&#160;; si défini avec un objet, nous allons mettre en
  365. cache les méthodes de cet objet.
  366. </entry>
  367. </row>
  368. <row>
  369. <entry><code>cache_by_default</code></entry>
  370. <entry><code>boolean</code></entry>
  371. <entry><code>true</code></entry>
  372. <entry>
  373. si <code>true</code>, les appels vont être cachés par
  374. défaut
  375. </entry>
  376. </row>
  377. <row>
  378. <entry><code>cached_methods</code></entry>
  379. <entry><code>array</code></entry>
  380. <entry></entry>
  381. <entry>
  382. les noms des méthodes qui seront toujours mis en
  383. cache
  384. </entry>
  385. </row>
  386. <row>
  387. <entry><code>non_cached_methods</code></entry>
  388. <entry><code>array</code></entry>
  389. <entry></entry>
  390. <entry>
  391. les noms des méthodes qui ne doivent jamais être mises en
  392. cache
  393. </entry>
  394. </row>
  395. </tbody>
  396. </tgroup>
  397. </table>
  398. </sect3>
  399. <sect3 id="zend.cache.frontends.class.examples">
  400. <title>Exemples</title>
  401. <para>Par exemple, pour mettre en cache des appels statiques&#160;:</para>
  402. <programlisting language="php"><![CDATA[
  403. class test {
  404. // Méthode statique
  405. public static function foobar($param1, $param2) {
  406. echo "foobar_output($param1, $param2)";
  407. return "foobar_return($param1, $param2)";
  408. }
  409. }
  410. // [...]
  411. $frontendOptions = array(
  412. 'cached_entity' => 'test' // Le nom de la classe
  413. );
  414. // [...]
  415. // l'appel caché
  416. $res = $cache->foobar('1', '2');
  417. ]]></programlisting>
  418. <para>Pour mettre en cache des appels classiques aux méthodes&#160;:</para>
  419. <programlisting language="php"><![CDATA[
  420. class test {
  421. private $_string = 'hello !';
  422. public function foobar2($param1, $param2) {
  423. echo($this->_string);
  424. echo "foobar2_output($param1, $param2)";
  425. return "foobar2_return($param1, $param2)";
  426. }
  427. }
  428. // [...]
  429. $frontendOptions = array(
  430. 'cached_entity' => new test() // Une instance de la classe
  431. );
  432. // [...]
  433. // L'appel mis en cache
  434. $res = $cache->foobar2('1', '2');
  435. ]]></programlisting>
  436. </sect3>
  437. </sect2>
  438. <sect2 id="zend.cache.frontends.file">
  439. <title>Zend_Cache_Frontend_File</title>
  440. <sect3 id="zend.cache.frontends.file.introduction">
  441. <title>Introduction</title>
  442. <para>
  443. <classname>Zend_Cache_Frontend_File</classname> est un frontend piloté par la
  444. modification d'un "fichier maître". C'est vraiment intéressant, par exemple, dans
  445. les problématiques de configuration ou de templates. Il est également possible
  446. d'utiliser plusieurs fichiers maîtres.
  447. </para>
  448. <para>
  449. Par exemple, vous avez un fichier de configuration XML qui est analysé par
  450. une fonction, celle-ci retourne un "objet de configuration" (comme avec
  451. <classname>Zend_Config</classname>). Avec
  452. <classname>Zend_Cache_Frontend_File</classname>, vous pouvez stocker l'objet de
  453. configuration dans le cache (pour éviter d'analyser le fichier de configuration XML
  454. chaque fois) mais avec une sorte de forte dépendance au fichier maître. Ainsi si le
  455. fichier XML de configuration est modifié, le cache est immédiatement invalide.
  456. </para>
  457. </sect3>
  458. <sect3 id="zend.cache.frontends.file.options">
  459. <title>Options disponibles</title>
  460. <table id="zend.cache.frontends.file.options.table">
  461. <title>Options du frontend File</title>
  462. <tgroup cols="4">
  463. <thead>
  464. <row>
  465. <entry>Option</entry>
  466. <entry>Type de données</entry>
  467. <entry>Valeur par défaut</entry>
  468. <entry>Description</entry>
  469. </row>
  470. </thead>
  471. <tbody>
  472. <row>
  473. <entry><code>master_file (déprécié)</code></entry>
  474. <entry><code>string</code></entry>
  475. <entry><code></code></entry>
  476. <entry>le chemin complet et le nom du fichier maître</entry>
  477. </row>
  478. <row>
  479. <entry><code>master_files</code></entry>
  480. <entry><code>array</code></entry>
  481. <entry><code></code></entry>
  482. <entry>un tableau de chemin complet de fichiers maîtres</entry>
  483. </row>
  484. <row>
  485. <entry><code>master_files_mode</code></entry>
  486. <entry><code>string</code></entry>
  487. <entry><classname>Zend_Cache_Frontend_File::MODE_OR</classname></entry>
  488. <entry>
  489. <classname>Zend_Cache_Frontend_File::MODE_AND</classname> oU
  490. <classname>Zend_Cache_Frontend_File::MODE_OR</classname> ; si
  491. <code>MODE_AND</code>, alors tous les fichiers maîtres doivent être
  492. modifiés pour rendre invalide le cache, si <code>MODE_OR</code>,
  493. alors un seul fichier maître modifié est nécessaire pour invalider
  494. le cache
  495. </entry>
  496. </row>
  497. <row>
  498. <entry><code>ignore_missing_master_files</code></entry>
  499. <entry><code>boolean</code></entry>
  500. <entry><code>false</code></entry>
  501. <entry>
  502. si <code>true</code>, l'absence de fichiers maîtres est
  503. ignoré silencieusement (sinon une exception est levée)
  504. </entry>
  505. </row>
  506. </tbody>
  507. </tgroup>
  508. </table>
  509. </sect3>
  510. <sect3 id="zend.cache.frontends.file.examples">
  511. <title>Exemples</title>
  512. <para>
  513. L'utilisation de ce frontend est la même que celle de
  514. <classname>Zend_Cache_Core</classname>. Il n'y a pas besoin d'exemple spécifique -
  515. la seule chose à faire est de définir le <code>master_file</code> lors de
  516. l'utilisation de la fabrique.
  517. </para>
  518. </sect3>
  519. </sect2>
  520. <sect2 id="zend.cache.frontends.page">
  521. <title>Zend_Cache_Frontend_Page</title>
  522. <sect3 id="zend.cache.frontends.page.introduction">
  523. <title>Introduction</title>
  524. <para>
  525. <classname>Zend_Cache_Frontend_Page</classname> est comme
  526. <classname>Zend_Cache_Frontend_Output</classname> mais créé pour une page complète.
  527. Il est impossible d'utiliser <classname>Zend_Cache_Frontend_Page</classname> pour
  528. mettre en cache un bloc unique.
  529. </para>
  530. <para>
  531. D'un autre côté, le "cache ID", est calculé automatiquement avec
  532. <code>$_SERVER['REQUEST_URI']</code> et (en fonction des options)
  533. <code>$_GET</code>, <code>$_POST</code>, <code>$_SESSION</code>,
  534. <code>$_COOKIE</code>, <code>$_FILES</code>. De plus, vous avez seulement une
  535. méthode pour appeler (<code>start()</code>) parce que l'appel à <code>end()</code>
  536. est totalement automatique lorsque la page est terminé.
  537. </para>
  538. <para>
  539. Pour le moment, ceci n'est pas implémenté mais nous prévoyons d'ajouter un
  540. système de condition HTTP pour économiser de la bande passante (le système émettra
  541. un en-tête "HTTP 304 Not Modified" si le cache est trouvé, et si le navigateur a
  542. déjà la bonne version).
  543. </para>
  544. </sect3>
  545. <sect3 id="zend.cache.frontends.page.options">
  546. <title>Options disponibles</title>
  547. <table id="zend.cache.frontends.page.options.table">
  548. <title>Options du frontend Page</title>
  549. <tgroup cols="4">
  550. <thead>
  551. <row>
  552. <entry>Option</entry>
  553. <entry>Type de données</entry>
  554. <entry>Valeur par défaut</entry>
  555. <entry>Description</entry>
  556. </row>
  557. </thead>
  558. <tbody>
  559. <row>
  560. <entry><code>http_conditional</code></entry>
  561. <entry><code>boolean</code></entry>
  562. <entry><code>false</code></entry>
  563. <entry>
  564. utilisez le système <code>httpConditionnal</code> ou pas
  565. (pas encore implémenté)
  566. </entry>
  567. </row>
  568. <row>
  569. <entry><code>debug_header</code></entry>
  570. <entry><code>boolean</code></entry>
  571. <entry><code>false</code></entry>
  572. <entry>
  573. si <code>true</code>, un texte de débogage est ajouté avant
  574. chaque page de cache
  575. </entry>
  576. </row>
  577. <row>
  578. <entry><code>default_options</code></entry>
  579. <entry><code>array</code></entry>
  580. <entry><code>array(...see below...)</code></entry>
  581. <entry>
  582. un tableau associatif d'options par défaut&#160;:
  583. <itemizedlist>
  584. <listitem>
  585. <para><code>(boolean, true par défaut) cache</code>&#160;:
  586. le cache est activé si <code>true</code>
  587. </para>
  588. </listitem>
  589. <listitem>
  590. <para>
  591. <code>(boolean, false par défaut)
  592. cache_with_get_variables</code>&#160;: si
  593. <code>true</code>, le cache est toujours activé même s'il
  594. y a des variables dans le tableau <code>$_GET</code>
  595. </para>
  596. </listitem>
  597. <listitem>
  598. <para>
  599. <code>(boolean, false par défaut)
  600. cache_with_post_variables</code>&#160;: si
  601. <code>true</code>, le cache est toujours activé même s'il
  602. y a des variables dans le tableau <code>$_POST</code>
  603. </para>
  604. </listitem>
  605. <listitem>
  606. <para>
  607. <code>(boolean, false par défaut)
  608. cache_with_session_variables</code>&#160;: si
  609. <code>true</code>, le cache est toujours activé s'il y a
  610. des variables dans le tableau <code>$_SESSION</code>
  611. </para>
  612. </listitem>
  613. <listitem>
  614. <para>
  615. <code>(boolean, false par défaut)
  616. cache_with_files_variables</code>&#160;: si
  617. <code>true</code>, le cache est toujours activé s'il y a
  618. des variables dans le tableau <code>$_FILES</code>
  619. </para>
  620. </listitem>
  621. <listitem>
  622. <para>
  623. <code>(boolean, false par défaut)
  624. cache_with_cookie_variables</code>&#160;: si
  625. <code>true</code>, le cache est toujours activé s'il y a
  626. des variables dans le tableau <code>$_COOKIE</code>
  627. </para>
  628. </listitem>
  629. <listitem>
  630. <para>
  631. <code>(boolean, true par défaut)
  632. make_id_with_get_variables</code>&#160;: si
  633. <code>true</code>, l'identifiant du cache sera dépendant
  634. du contenu du tableau <code>$_GET</code>
  635. </para>
  636. </listitem>
  637. <listitem>
  638. <para>
  639. <code>(boolean, true par défaut)
  640. make_id_with_post_variables</code>&#160;: si
  641. <code>true</code>, l'identifiant du cache sera dépendant
  642. du contenu du tableau <code>$_POST</code>
  643. </para>
  644. </listitem>
  645. <listitem>
  646. <para>
  647. <code>(boolean, true par défaut)
  648. make_id_with_session_variables</code>&#160;: si
  649. <code>true</code>, l'identifiant du cache sera dépendant
  650. du contenu du tableau <code>$_SESSION</code>
  651. </para>
  652. </listitem>
  653. <listitem>
  654. <para>
  655. <code>(boolean, true par défaut)
  656. make_id_with_files_variables</code>&#160;: si
  657. <code>true</code>, l'identifiant du cache sera dépendant
  658. du contenu du tableau <code>$_FILES</code>
  659. </para>
  660. </listitem>
  661. <listitem>
  662. <para>
  663. <code>(boolean, true par défaut)
  664. make_id_with_cookie_variables</code>&#160;: si
  665. <code>true</code>, l'identifiant du cache sera dépendant
  666. du contenu du tableau <code>$_COOKIE</code>
  667. </para>
  668. </listitem>
  669. <listitem>
  670. <para>
  671. <code>(int, false par défaut)
  672. specific_lifetime</code>&#160;: si <code>true</code>, la
  673. durée de vie fournie sera utilisée pour l'expression
  674. régulière choisie
  675. </para>
  676. </listitem>
  677. <listitem>
  678. <para>
  679. <code>(array, array() par défaut) tags</code>&#160;:
  680. balises pour l'enregistrement en cache
  681. </para>
  682. </listitem>
  683. <listitem>
  684. <para>
  685. <code>(int, null par défaut) priority</code>&#160;:
  686. priorité (si le backend le supporte)
  687. </para>
  688. </listitem>
  689. </itemizedlist></entry>
  690. </row>
  691. <row>
  692. <entry><code>regexps</code></entry>
  693. <entry><code>array</code></entry>
  694. <entry><code>array()</code></entry>
  695. <entry>
  696. un tableau associatif pour définir les options, uniquement
  697. pour certaines <code>REQUEST_URI</code>, les clés sont des
  698. expressions régulières PCRE, les valeurs sont des tableaux
  699. associatifs avec des options spécifiques pour définir si les
  700. expressions régulières correspondent dans
  701. <code>$_SERVER['REQUEST_URI']</code> (voir les options par défaut
  702. pour la liste des options disponibles) ; si plusieurs expressions
  703. régulières correspondent à un <code>$_SERVER['REQUEST_URI']</code>,
  704. seule la dernière sera utilisée.
  705. </entry>
  706. </row>
  707. <row>
  708. <entry><code>memorize_headers</code></entry>
  709. <entry><code>array</code></entry>
  710. <entry><code>array()</code></entry>
  711. <entry>
  712. un tableau de chaînes correspondant aux noms d'en-têtes
  713. HTTP. Les en-têtes listés seront stockées avec les données de cache
  714. et renvoyées lorsque le cache sera rappelé.
  715. </entry>
  716. </row>
  717. </tbody>
  718. </tgroup>
  719. </table>
  720. </sect3>
  721. <sect3 id="zend.cache.frontends.page.examples">
  722. <title>Exemples</title>
  723. <para>
  724. L'utilisation de <classname>Zend_Cache_Frontend_Page</classname> est vraiment
  725. trivial&#160;:
  726. </para>
  727. <programlisting language="php"><![CDATA[
  728. // [...] // require, configuration et factory
  729. $cache->start();
  730. // si le cache est trouvé, le résultat est envoyé au navigateur
  731. // et le script s'arrête là
  732. // reste de la page ...
  733. ]]></programlisting>
  734. <para>
  735. Un exemple plus complexe qui montre un moyen pour obtenir une gestion
  736. centralisée du cache dans un fichier d'amorçage (pour utiliser avec
  737. <classname>Zend_Controller</classname> par exemple)
  738. </para>
  739. <programlisting language="php"><![CDATA[
  740. // vous devriez éviter de mettre trop de lignes avant la section
  741. // de cache par exemple, pour des performances optimales,
  742. // "require_once" ou "Zend_Loader::loadClass" devrait être
  743. // après la section de cache
  744. $frontendOptions = array(
  745. 'lifetime' => 7200,
  746. 'debug_header' => true, // pour le déboguage
  747. 'regexps' => array(
  748. // met en cache la totalité d'IndexController
  749. '^/$' => array('cache' => true),
  750. // met en cache la totalité d'IndexController
  751. '^/index/' => array('cache' => true),
  752. // nous ne mettons pas en cache l'ArticleController...
  753. '^/article/' => array('cache' => false),
  754. // ...mais nous mettons en cache l'action "view"
  755. '^/article/view/' => array(
  756. // de cet ArticleController
  757. 'cache' => true,
  758. // et nous mettons en cache même lorsqu'il y a
  759. // des variables dans $_POST
  760. 'cache_with_post_variables' => true,
  761. // (mais le cache sera dépendent du tableau $_POST)
  762. 'make_id_with_post_variables' => true,
  763. )
  764. )
  765. );
  766. $backendOptions = array(
  767. 'cache_dir' => '/tmp/'
  768. );
  769. // obtenir un objet Zend_Cache_Frontend_Page
  770. $cache = Zend_Cache::factory('Page',
  771. 'File',
  772. $frontendOptions,
  773. $backendOptions);
  774. $cache->start();
  775. // si nous trouvons un cache, le résultat est envoyé au navigateur,
  776. // et le script s'arrête là
  777. // [...] la fin du fichier de démarrage
  778. // (ces lignes ne seront pas exécutées si on trouve un cache)
  779. ]]></programlisting>
  780. </sect3>
  781. <sect3 id="zend.cache.frontends.page.cancel">
  782. <title>La méthode spécifique cancel()</title>
  783. <para>
  784. A cause de problèmes de design, dans certains cas (par exemple quand on
  785. utilise des codes de retour HTTP autres que HTTP/200), vous pouvez avoir besoin de
  786. stopper le processus de mise en cache courant. Il a donc été introduit pour ce
  787. frontend en particulier, la méthode <code>cancel()</code>.
  788. </para>
  789. <programlisting language="php"><![CDATA[
  790. // [...] require, configuration et fabrique
  791. $cache->start();
  792. // [...]
  793. if ($unTest) {
  794. $cache->cancel();
  795. // [...]
  796. }
  797. // [...]
  798. ]]></programlisting>
  799. </sect3>
  800. </sect2>
  801. </sect1>