Zend_Cache-Backends.xml 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <!-- EN-Revision: 16382 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.cache.backends">
  5. <title>Les backends Zend_Cache</title>
  6. <para>
  7. Il existe deux types de backends&#160;: les standards et les étendus. Bien sûr, les
  8. backends étendus offrent des fonctionnalités supplémentaires.
  9. </para>
  10. <sect2 id="zend.cache.backends.file">
  11. <title>Zend_Cache_Backend_File</title>
  12. <para>
  13. Ces backends (étendus) stockent les enregistrements de cache dans des fichiers
  14. (dans un dossier choisi).
  15. </para>
  16. <para>Les options disponibles sont&#160;:</para>
  17. <table id="zend.cache.backends.file.table">
  18. <title>Options du backend File</title>
  19. <tgroup cols="4">
  20. <thead>
  21. <row>
  22. <entry>Option</entry>
  23. <entry>Type de données</entry>
  24. <entry>Valeur par défaut</entry>
  25. <entry>Description</entry>
  26. </row>
  27. </thead>
  28. <tbody>
  29. <row>
  30. <entry><emphasis>cache_dir</emphasis></entry>
  31. <entry><type>String</type></entry>
  32. <entry><filename>/tmp/</filename></entry>
  33. <entry>Répertoire où stocker les fichiers de cache</entry>
  34. </row>
  35. <row>
  36. <entry><emphasis>file_locking</emphasis></entry>
  37. <entry><type>Boolean</type></entry>
  38. <entry><constant>TRUE</constant></entry>
  39. <entry>
  40. Active / désactive le verrou de fichier&#160;: peut éviter la
  41. corruption du cache dans de mauvaises circonstances, mais il n'aide en
  42. rien sur des serveur multithreadés ou sur des systèmes de fichier
  43. <acronym>NFS</acronym>...
  44. </entry>
  45. </row>
  46. <row>
  47. <entry><emphasis>read_control</emphasis></entry>
  48. <entry><type>Boolean</type></entry>
  49. <entry><constant>TRUE</constant></entry>
  50. <entry>
  51. Active / désactive le contrôle de lecture&#160;: si activé, une clé
  52. de contrôle est embarquée dans le fichier de cache et cette clé est
  53. comparée avec celle calculée après la lecture.
  54. </entry>
  55. </row>
  56. <row>
  57. <entry><emphasis>read_control_type</emphasis></entry>
  58. <entry><type>String</type></entry>
  59. <entry>'crc32'</entry>
  60. <entry>
  61. Type de contrôle de lecture (seulement si le contrôle de lecture
  62. est activé). Les valeurs disponibles sont&#160;: "md5" (meilleur mais
  63. plus lent), "crc32" (un peu moins sécurisé, mais plus rapide, c'est un
  64. meilleur choix), "adler32" (nouveau choix, plus rapide que
  65. crc32),"strlen" pour un test de longueur uniquement (le plus
  66. rapide).
  67. </entry>
  68. </row>
  69. <row>
  70. <entry><emphasis>hashed_directory_level</emphasis></entry>
  71. <entry><type>Integer</type></entry>
  72. <entry>0</entry>
  73. <entry>
  74. Niveau de structure du hash du répertoire&#160;: 0 signifie "pas de
  75. hashage de la structure du répertoire", 1 signifie "un niveau de
  76. répertoire", 2 signifie "deux niveaux"... Cette option peut accélérer
  77. le cache seulement lorsque vous avez plusieurs centaines de fichiers de
  78. cache. Seuls des tests de performance spécifiques peuvent vous aider à
  79. choisir la meilleure valeur pour vous. 1 ou 2, peut-être un bon
  80. départ.
  81. </entry>
  82. </row>
  83. <row>
  84. <entry><emphasis>hashed_directory_umask</emphasis></entry>
  85. <entry><type>Integer</type></entry>
  86. <entry>0700</entry>
  87. <entry>Umask pour l'arborescence</entry>
  88. </row>
  89. <row>
  90. <entry><emphasis>file_name_prefix</emphasis></entry>
  91. <entry><type>String</type></entry>
  92. <entry>'zend_cache'</entry>
  93. <entry>
  94. Préfixe pour les fichiers mis en cache&#160;; faîtes très attention
  95. avec cette option, en cas de valeur trop générique dans le dossier de
  96. cache (comme <filename>/tmp</filename>), ceci peut causer des désastres
  97. lors du nettoyage du cache.
  98. </entry>
  99. </row>
  100. <row>
  101. <entry><emphasis>cache_file_umask</emphasis></entry>
  102. <entry><type>Integer</type></entry>
  103. <entry>0700</entry>
  104. <entry>umask des fichiers de cache.</entry>
  105. </row>
  106. <row>
  107. <entry><emphasis>metatadatas_array_max_size</emphasis></entry>
  108. <entry><type>Integer</type></entry>
  109. <entry>100</entry>
  110. <entry>
  111. Taille maximale interne pour les tableaux de métadonnées (ne
  112. changez pas cette valeur à moins de bien savoir ce que vous
  113. faîtes).
  114. </entry>
  115. </row>
  116. </tbody>
  117. </tgroup>
  118. </table>
  119. </sect2>
  120. <sect2 id="zend.cache.backends.sqlite">
  121. <title>Zend_Cache_Backend_Sqlite</title>
  122. <para>
  123. Ce backend (étendu) stocke les enregistrements de cache dans une base de donnée
  124. SQLite.
  125. </para>
  126. <para>Les options disponibles sont&#160;:</para>
  127. <table id="zend.cache.backends.sqlite.table">
  128. <title>Options du backend Sqlite</title>
  129. <tgroup cols="4">
  130. <thead>
  131. <row>
  132. <entry>Option</entry>
  133. <entry>Type de données</entry>
  134. <entry>Valeur par défaut</entry>
  135. <entry>Description</entry>
  136. </row>
  137. </thead>
  138. <tbody>
  139. <row>
  140. <entry><emphasis>cache_db_complete_path (obligatoire)</emphasis></entry>
  141. <entry><type>String</type></entry>
  142. <entry><constant>NULL</constant></entry>
  143. <entry>
  144. Le chemin complet (nom du fichier inclus) de la base de donnée
  145. SQLite
  146. </entry>
  147. </row>
  148. <row>
  149. <entry><emphasis>automatic_vacuum_factor</emphasis></entry>
  150. <entry><type>Integer</type></entry>
  151. <entry>10</entry>
  152. <entry>
  153. Désactive / Active le processus de vidange automatique. Celui-ci
  154. défragmente le fichier de base de données (et diminue sa taille) quand
  155. <methodname>clean()</methodname> ou <methodname>delete()</methodname>
  156. est appelé&#160;: 0 pour une vidange automatique&#160;; 1
  157. pour une vidange systématique (quand <methodname>clean()</methodname>
  158. ou <methodname>delete()</methodname> est
  159. appelé)&#160;; x (entier) &gt; 1 pour une vidange automatique
  160. aléatoirement 1 fois sur x <methodname>clean()</methodname> ou
  161. <methodname>delete()</methodname>.
  162. </entry>
  163. </row>
  164. </tbody>
  165. </tgroup>
  166. </table>
  167. </sect2>
  168. <sect2 id="zend.cache.backends.memcached">
  169. <title>Zend_Cache_Backend_Memcached</title>
  170. <para>
  171. Ce backend (étendu) stocke les enregistrements de cache dans un serveur memcached.
  172. <ulink url="http://www.danga.com/memcached/">Memcached</ulink> est un système de cache
  173. en mémoire distribuée, de haute performance. Pour utiliser ce backend, vous devez avoir
  174. un démon memcached et l'extension
  175. <ulink url="http://pecl.php.net/package/memcache">PECL memcache</ulink>.
  176. </para>
  177. <para>
  178. Attention : avec ce backend, les balises ("tags") ne sont pas supportées pour le
  179. moment comme l'argument "doNotTestCacheValidity=true".
  180. </para>
  181. <para>Les options disponibles sont&#160;:</para>
  182. <table id="zend.cache.backends.memcached.table">
  183. <title>Options du backend Memcached</title>
  184. <tgroup cols="4">
  185. <thead>
  186. <row>
  187. <entry>Option</entry>
  188. <entry>Type de données</entry>
  189. <entry>Valeur par défaut</entry>
  190. <entry>Description</entry>
  191. </row>
  192. </thead>
  193. <tbody>
  194. <row>
  195. <entry><emphasis>servers</emphasis></entry>
  196. <entry><type>Array</type></entry>
  197. <entry>
  198. array(array('host' => 'localhost', 'port' => 11211, 'persistent' =>
  199. true, 'weight' => 1, 'timeout' => 5, 'retry_interval' => 15,
  200. 'status' => true, 'failure_callback' => '' ))
  201. </entry>
  202. <entry>
  203. Un tableau de serveurs memcached&#160;; chaque serveur memcached est
  204. décrit par un tableau associatif&#160;: 'host' =&gt; (string)&#160;: le
  205. nom du serveur memcached, 'port' =&gt; (int)&#160;: le port du serveur
  206. memcached, 'persistent' =&gt; (bool)&#160;: utilisation ou pas des
  207. connexions persistantes pour ce serveur memcached, 'weight' =&gt;
  208. (int)&#160;: le poids du serveur memcached, 'timeout' =&gt;
  209. (int)&#160;: le time out du serveur memcached, 'retry_interval' =&gt;
  210. (int)&#160;: l'intervalle avant réexécution du serveur memcached,
  211. 'status' =&gt; (bool)&#160;: le statut du serveur memcached,
  212. 'failure_callback' =&gt; (callback)&#160;: le failure_callback d'échec
  213. du serveur memcached.
  214. </entry>
  215. </row>
  216. <row>
  217. <entry><emphasis>compression</emphasis></entry>
  218. <entry><type>Boolean</type></entry>
  219. <entry><constant>FALSE</constant></entry>
  220. <entry>
  221. <constant>TRUE</constant>, si vous voulez utiliser la compression à la
  222. volée
  223. </entry>
  224. </row>
  225. <row>
  226. <entry><emphasis>compatibility</emphasis></entry>
  227. <entry><type>Boolean</type></entry>
  228. <entry><constant>FALSE</constant></entry>
  229. <entry>
  230. <constant>TRUE</constant>, si vous voulez utiliser le mode de
  231. compatibilité avec les anciens serveurs&#160;/&#160;extensions memcache
  232. </entry>
  233. </row>
  234. </tbody>
  235. </tgroup>
  236. </table>
  237. </sect2>
  238. <sect2 id="zend.cache.backends.apc">
  239. <title>Zend_Cache_Backend_Apc</title>
  240. <para>
  241. Ce backend (étendu) stocke les enregistrements de cache en mémoire partagée grâce
  242. à l'extension <ulink url="http://pecl.php.net/package/APC">APC</ulink>
  243. (Alternative <acronym>PHP</acronym> Cache) qui est requise pour utiliser ce backend.
  244. </para>
  245. <para>
  246. Attention: avec ce backend, les balises ("tags") ne sont pas supportées pour le
  247. moment comme l'argument "doNotTestCacheValidity=true".
  248. </para>
  249. <para>Il n'y a pas d'options pour ce backend.</para>
  250. </sect2>
  251. <sect2 id="zend.cache.backends.xcache">
  252. <title>Zend_Cache_Backend_Xcache</title>
  253. <para>
  254. Ce backend stocke ces enregistrements de cache dans la mémoire partagée à travers
  255. l'extension <ulink url="http://xcache.lighttpd.net/">XCache</ulink>(qui est bien sûr
  256. nécessaire pour utiliser ce backend).
  257. </para>
  258. <para>
  259. Attention : avec ce backend, les balises ("tags") ne sont pas supportées pour le
  260. moment comme l'argument "doNotTestCacheValidity=true".
  261. </para>
  262. <para>Les options disponibles sont&#160;:</para>
  263. <table id="zend.cache.backends.xcache.table">
  264. <title>Options du backend Xcache</title>
  265. <tgroup cols="4">
  266. <thead>
  267. <row>
  268. <entry>Option</entry>
  269. <entry>Type de données</entry>
  270. <entry>Valeur par défaut</entry>
  271. <entry>Description</entry>
  272. </row>
  273. </thead>
  274. <tbody>
  275. <row>
  276. <entry><emphasis>user</emphasis></entry>
  277. <entry><type>String</type></entry>
  278. <entry><constant>NULL</constant></entry>
  279. <entry>
  280. <filename>xcache.admin.user</filename>, nécessaire pour la
  281. méthode <methodname>clean()</methodname>.
  282. </entry>
  283. </row>
  284. <row>
  285. <entry><emphasis>password</emphasis></entry>
  286. <entry><type>String</type></entry>
  287. <entry><constant>NULL</constant></entry>
  288. <entry>
  289. <filename>xcache.admin.pass</filename> (en texte clair non
  290. <acronym>MD5</acronym>), nécessaire pour la méthode
  291. <methodname>clean()</methodname>.
  292. </entry>
  293. </row>
  294. </tbody>
  295. </tgroup>
  296. </table>
  297. </sect2>
  298. <sect2 id="zend.cache.backends.platform">
  299. <title>Zend_Cache_Backend_ZendPlatform</title>
  300. <para>
  301. Ce backend utilise l'<acronym>API</acronym> de cache de contenu de la
  302. <ulink url="http://www.zend.com/products/platform">Zend Platform</ulink>.
  303. Naturellement, pour utiliser ce backend, vous devez avoir installé une Zend Platorm.
  304. </para>
  305. <para>
  306. Ce backend supporte les balises ("tags") mais ne supporte pas le mode de
  307. nettoyage <constant>CLEANING_MODE_NOT_MATCHING_TAG</constant>.
  308. </para>
  309. <para>
  310. Spécifiez ce backend en utilisant un séparateur de mot - "-", ".", " " ou "_" -
  311. entre les mots "Zend" et "Platform" quand vous utilisez la méthode
  312. <methodname>Zend_Cache::factory()</methodname>&#160;:
  313. </para>
  314. <programlisting language="php"><![CDATA[
  315. $cache = Zend_Cache::factory('Core', 'Zend Platform');
  316. ]]></programlisting>
  317. <para>Il n'y a pas d'options pour ce backend.</para>
  318. </sect2>
  319. <sect2 id="zend.cache.backends.twolevels">
  320. <title>Zend_Cache_Backend_TwoLevels</title>
  321. <para>
  322. Ce backend (étendu) est un hybride. Il stocke les enregistrements de cache dans
  323. deux autres backends&#160;: un rapide (mais limité) comme Apc, Memcache... et un plus
  324. "lent" comme File, Sqlite...
  325. </para>
  326. <para>
  327. Ce backend utilise le paramètre priorité (fourni au niveau du frontend au moment
  328. d'un enregistrement) et l'espace restant dans le backend rapide pour optimiser
  329. l'utilisation de ces deux backends.
  330. </para>
  331. <para>Les options disponibles sont :</para>
  332. <table id="zend.cache.backends.twolevels.table">
  333. <title>Options du backend TwoLevels</title>
  334. <tgroup cols="4">
  335. <thead>
  336. <row>
  337. <entry>Option</entry>
  338. <entry>Type de données</entry>
  339. <entry>Valeur par défaut</entry>
  340. <entry>Description</entry>
  341. </row>
  342. </thead>
  343. <tbody>
  344. <row>
  345. <entry><emphasis>slow_backend</emphasis></entry>
  346. <entry><type>String</type></entry>
  347. <entry>File</entry>
  348. <entry>le nom du backend "lent"</entry>
  349. </row>
  350. <row>
  351. <entry><emphasis>fast_backend</emphasis></entry>
  352. <entry><type>String</type></entry>
  353. <entry>Apc</entry>
  354. <entry>le nom du backend "rapide"</entry>
  355. </row>
  356. <row>
  357. <entry><emphasis>slow_backend_options</emphasis></entry>
  358. <entry><type>Array</type></entry>
  359. <entry><methodname>array()</methodname></entry>
  360. <entry>les options du backend "lent"</entry>
  361. </row>
  362. <row>
  363. <entry><emphasis>fast_backend_options</emphasis></entry>
  364. <entry><type>Array</type></entry>
  365. <entry><methodname>array()</methodname></entry>
  366. <entry>les options du backend "rapide"</entry>
  367. </row>
  368. <row>
  369. <entry><emphasis>slow_backend_custom_naming</emphasis></entry>
  370. <entry><type>Boolean</type></entry>
  371. <entry><constant>FALSE</constant></entry>
  372. <entry>
  373. si <constant>TRUE</constant>, l'argument "slow_backend" est
  374. utilisé en tant que nom complet de classe&#160;; si
  375. <constant>FALSE</constant>, l'argument frontend est utilisé concaténé à
  376. "<classname>Zend_Cache_Backend_&lt;...&gt;</classname>"
  377. </entry>
  378. </row>
  379. <row>
  380. <entry><emphasis>fast_backend_custom_naming</emphasis></entry>
  381. <entry><type>Boolean</type></entry>
  382. <entry><constant>FALSE</constant></entry>
  383. <entry>
  384. si <constant>TRUE</constant>, l'argument "fast_backend" est
  385. utilisé en tant que nom complet de classe&#160;; si
  386. <constant>FALSE</constant>, l'argument frontend est utilisé concaténé à
  387. "<classname>Zend_Cache_Backend_&lt;...&gt;</classname>"
  388. </entry>
  389. </row>
  390. <row>
  391. <entry><emphasis>slow_backend_autoload</emphasis></entry>
  392. <entry><type>Boolean</type></entry>
  393. <entry><constant>FALSE</constant></entry>
  394. <entry>
  395. si <constant>TRUE</constant>, il n'y aura pas de require_once pour le
  396. "slow_backend" (utile seulement pour les backends
  397. personnalisés)
  398. </entry>
  399. </row>
  400. <row>
  401. <entry><emphasis>fast_backend_autoload</emphasis></entry>
  402. <entry><type>Boolean</type></entry>
  403. <entry><constant>FALSE</constant></entry>
  404. <entry>
  405. si <constant>TRUE</constant>, il n'y aura pas de require_once pour le
  406. "fast_backend" (utile seulement pour les backends
  407. personnalisés)
  408. </entry>
  409. </row>
  410. <row>
  411. <entry><emphasis>auto_refresh_fast_cache</emphasis></entry>
  412. <entry><type>Boolean</type></entry>
  413. <entry><constant>TRUE</constant></entry>
  414. <entry>
  415. si <constant>TRUE</constant>, rafraîchissement automatique du cache
  416. rapide quand un enregistrement est appelé
  417. </entry>
  418. </row>
  419. <row>
  420. <entry><emphasis>stats_update_factor</emphasis></entry>
  421. <entry><type>Integer</type></entry>
  422. <entry>10</entry>
  423. <entry>
  424. désactive&#160;/&#160;personnalise le calcul du pourcentage de
  425. remplissage du backend rapide (lors d'une sauvegarde d'un enregistrement
  426. dans le cache, le calcul du remplissage est effectué aléatoirement
  427. 1 fois sur x écritures de cache)
  428. </entry>
  429. </row>
  430. </tbody>
  431. </tgroup>
  432. </table>
  433. </sect2>
  434. <sect2 id="zend.cache.backends.zendserver">
  435. <title> Zend_Cache_Backend_ZendServer_Disk et Zend_Cache_Backend_ZendServer_ShMem </title>
  436. <para>
  437. Ces backends utilisent les fonctionnalités de mise en cache de
  438. <ulink url="http://www.zend.com/en/products/server/downloads-all?zfs=zf_download">Zend
  439. Server</ulink>pour stocker les données.
  440. </para>
  441. <para>
  442. Attention : avec ces backends ne supportent pas les balises ("tags") pour le
  443. moment de même que l'argument "doNotTestCacheValidity=true".
  444. </para>
  445. <para>
  446. Ces backends fonctionnent seulement dans l'environnement de Zend Server pour les
  447. pages requêtées à travers <acronym>HTTP</acronym> ou <acronym>HTTPS</acronym> et ne
  448. fonctionnent pas pour les scripts exécutés en ligne de commande.
  449. </para>
  450. <para>Il n'y a pas d'options pour ce backend.</para>
  451. </sect2>
  452. </sect1>