Zend_Cache-Backends.xml 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <!-- EN-Revision: 15617 -->
  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><code>cache_dir</code></entry>
  31. <entry><code>string</code></entry>
  32. <entry><code>'/tmp/'</code></entry>
  33. <entry>Répertoire où stocker les fichiers de cache</entry>
  34. </row>
  35. <row>
  36. <entry><code>file_locking</code></entry>
  37. <entry><code>boolean</code></entry>
  38. <entry><code>true</code></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. NFS...
  44. </entry>
  45. </row>
  46. <row>
  47. <entry><code>read_control</code></entry>
  48. <entry><code>boolean</code></entry>
  49. <entry><code>true</code></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><code>read_control_type</code></entry>
  58. <entry><code>string</code></entry>
  59. <entry><code>'crc32'</code></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><code>hashed_directory_level</code></entry>
  71. <entry><code>int</code></entry>
  72. <entry><code>0</code></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><code>hashed_directory_umask</code></entry>
  85. <entry><code>int</code></entry>
  86. <entry><code>0700</code></entry>
  87. <entry>Umask pour l'arborescence</entry>
  88. </row>
  89. <row>
  90. <entry><code>file_name_prefix</code></entry>
  91. <entry><code>string</code></entry>
  92. <entry><code>'zend_cache'</code></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 /tmp), ceci peut causer des désastres lors du nettoyage du
  97. cache.
  98. </entry>
  99. </row>
  100. <row>
  101. <entry><code>cache_file_umask</code></entry>
  102. <entry><code>int</code></entry>
  103. <entry><code>0700</code></entry>
  104. <entry>umask des fichiers de cache.</entry>
  105. </row>
  106. <row>
  107. <entry><code>metatadatas_array_max_size</code></entry>
  108. <entry><code>int</code></entry>
  109. <entry><code>100</code></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><code>cache_db_complete_path (obligatoire)</code></entry>
  141. <entry><code>string</code></entry>
  142. <entry><code>null</code></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><code>automatic_vacuum_factor</code></entry>
  150. <entry><code>int</code></entry>
  151. <entry><code>10</code></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. clean() ou delete() est appelé : 0 pour une vidange automatique ; 1
  156. pour une vidange systématique (quand clean() ou delete() est
  157. appelé)&#160;; x (entier) &gt; 1 pour une vidange automatique
  158. aléatoirement 1 fois sur x clean() ou delete().
  159. </entry>
  160. </row>
  161. </tbody>
  162. </tgroup>
  163. </table>
  164. </sect2>
  165. <sect2 id="zend.cache.backends.memcached">
  166. <title>Zend_Cache_Backend_Memcached</title>
  167. <para>
  168. Ce backend (étendu) stocke les enregistrements de cache dans un serveur memcached.
  169. <ulink url="http://www.danga.com/memcached/">Memcached</ulink> est un système de cache
  170. en mémoire distribuée, de haute performance. Pour utiliser ce backend, vous devez avoir
  171. un démon memcached et l'extension PECL
  172. <ulink url="http://pecl.php.net/package/memcache">memcache</ulink>.
  173. </para>
  174. <para>
  175. ATTENTION : avec ce backend, les balises ("tags") ne sont pas supportées pour le
  176. moment comme l'argument "<code>doNotTestCacheValidity=true</code>".
  177. </para>
  178. <para>Les options disponibles sont&#160;:</para>
  179. <table id="zend.cache.backends.memcached.table">
  180. <title>Options du backend Memcached</title>
  181. <tgroup cols="4">
  182. <thead>
  183. <row>
  184. <entry>Option</entry>
  185. <entry>Type de données</entry>
  186. <entry>Valeur par défaut</entry>
  187. <entry>Description</entry>
  188. </row>
  189. </thead>
  190. <tbody>
  191. <row>
  192. <entry><code>servers</code></entry>
  193. <entry><code>array</code></entry>
  194. <entry>
  195. <code>array(array('host' =&gt; 'localhost', 'port' =&gt; 11211,
  196. 'persistent' =&gt; true, 'weight' =&gt; 1, 'timeout' =&gt; 5,
  197. 'retry_interval' =&gt; 15, 'status' =&gt; true, 'failure_callback'
  198. =&gt; ''))</code>
  199. </entry>
  200. <entry>
  201. Un tableau de serveurs memcached&#160;; chaque serveur memcached est
  202. décrit par un tableau associatif&#160;: 'host' =&gt; (string)&#160;: le
  203. nom du serveur memcached, 'port' =&gt; (int)&#160;: le port du serveur
  204. memcached, 'persistent' =&gt; (bool)&#160;: utilisation ou pas des
  205. connexions persistantes pour ce serveur memcached, 'weight' =&gt;
  206. (int)&#160;: le poids du serveur memcached, 'timeout' =&gt;
  207. (int)&#160;: le time out du serveur memcached, 'retry_interval' =&gt;
  208. (int)&#160;: l'intervalle avant réexécution du serveur memcached,
  209. 'status' =&gt; (bool)&#160;: le statut du serveur memcached,
  210. 'failure_callback' =&gt; (callback)&#160;: le failure_callback d'échec
  211. du serveur memcached.
  212. </entry>
  213. </row>
  214. <row>
  215. <entry><code>compression</code></entry>
  216. <entry><code>boolean</code></entry>
  217. <entry><code>false</code></entry>
  218. <entry>
  219. <code>true</code>, si vous voulez utiliser la compression à la
  220. volée
  221. </entry>
  222. </row>
  223. <row>
  224. <entry><code>compatibility</code></entry>
  225. <entry><code>boolean</code></entry>
  226. <entry><code>false</code></entry>
  227. <entry>
  228. <code>true</code>, si vous voulez utiliser le mode de
  229. compatibilité avec les anciens serveurs/extensions memcache
  230. </entry>
  231. </row>
  232. </tbody>
  233. </tgroup>
  234. </table>
  235. </sect2>
  236. <sect2 id="zend.cache.backends.apc">
  237. <title>Zend_Cache_Backend_Apc</title>
  238. <para>
  239. Ce backend (étendu) stocke les enregistrements de cache en mémoire partagée grâce
  240. à l'extension <ulink url="http://pecl.php.net/package/APC">APC</ulink>
  241. (Alternative PHP Cache) qui est requise pour utiliser ce backend.
  242. </para>
  243. <para>
  244. Attention: avec ce backend, les balises ("tags") ne sont pas supportées pour le
  245. moment comme l'argument "<code>doNotTestCacheValidity=true</code>".
  246. </para>
  247. <para>Il n'y a pas d'options pour ce backend.</para>
  248. </sect2>
  249. <sect2 id="zend.cache.backends.xcache">
  250. <title>Zend_Cache_Backend_Xcache</title>
  251. <para>
  252. Ce backend stocke ces enregistrements de cache dans la mémoire partagée à travers
  253. l'extension <ulink url="http://xcache.lighttpd.net/">XCache</ulink>(qui est bien sûr
  254. nécessaire pour utiliser ce backend).
  255. </para>
  256. <para>
  257. ATTENTION : avec ce backend, les balises ("tags") ne sont pas supportées pour le
  258. moment comme l'argument "<code>doNotTestCacheValidity=true</code>".
  259. </para>
  260. <para>Les options disponibles sont&#160;:</para>
  261. <table id="zend.cache.backends.xcache.table">
  262. <title>Options du backend Xcache</title>
  263. <tgroup cols="4">
  264. <thead>
  265. <row>
  266. <entry>Option</entry>
  267. <entry>Type de données</entry>
  268. <entry>Valeur par défaut</entry>
  269. <entry>Description</entry>
  270. </row>
  271. </thead>
  272. <tbody>
  273. <row>
  274. <entry><code>user</code></entry>
  275. <entry><code>string</code></entry>
  276. <entry><code>null</code></entry>
  277. <entry>
  278. <code>xcache.admin.user</code>, nécessaire pour la méthode
  279. <code>clean()</code>.
  280. </entry>
  281. </row>
  282. <row>
  283. <entry><code>password</code></entry>
  284. <entry><code>string</code></entry>
  285. <entry><code>null</code></entry>
  286. <entry>
  287. <code>xcache.admin.pass</code> (en texte clair non MD5),
  288. nécessaire pour la méthode <code>clean()</code>.
  289. </entry>
  290. </row>
  291. </tbody>
  292. </tgroup>
  293. </table>
  294. </sect2>
  295. <sect2 id="zend.cache.backends.platform">
  296. <title>Zend_Cache_Backend_ZendPlatform</title>
  297. <para>
  298. Ce backend utilise l'API de cache de contenu de la
  299. <ulink url="http://www.zend.com/products/platform">Zend Platform</ulink>.
  300. Naturellement, pour utiliser ce backend, vous devez avoir installé une Zend Platorm.
  301. </para>
  302. <para>
  303. Ce backend supporte les balises ("tags") mais ne supporte pas le mode de
  304. nettoyage <code>CLEANING_MODE_NOT_MATCHING_TAG</code>.
  305. </para>
  306. <para>
  307. Spécifiez ce backend en utilisant un séparateur de mot - "-", ".", " " ou "_" -
  308. entre les mots "Zend" et "Platform" quand vous utilisez la méthode
  309. <classname>Zend_Cache::factory()</classname>&#160;:
  310. </para>
  311. <programlisting language="php"><![CDATA[
  312. $cache = Zend_Cache::factory('Core', 'Zend Platform');
  313. ]]></programlisting>
  314. <para>Il n'y a pas d'options pour ce backend.</para>
  315. </sect2>
  316. <sect2 id="zend.cache.backends.twolevels">
  317. <title>Zend_Cache_Backend_TwoLevels</title>
  318. <para>
  319. Ce backend (étendu) est un hybride. Il stocke les enregistrements de cache dans
  320. deux autres backends&#160;: un rapide (mais limité) comme Apc, Memcache... et un plus
  321. "lent" comme File, Sqlite...
  322. </para>
  323. <para>
  324. Ce backend utilise le paramètre priorité (fourni au niveau du frontend au moment
  325. d'un enregistrement) et l'espace restant dans le backend rapide pour optimiser
  326. l'utilisation de ces deux backends.
  327. </para>
  328. <para>Les options disponibles sont :</para>
  329. <table id="zend.cache.backends.twolevels.table">
  330. <title>Options du backend TwoLevels</title>
  331. <tgroup cols="4">
  332. <thead>
  333. <row>
  334. <entry>Option</entry>
  335. <entry>Type de données</entry>
  336. <entry>Valeur par défaut</entry>
  337. <entry>Description</entry>
  338. </row>
  339. </thead>
  340. <tbody>
  341. <row>
  342. <entry><code>slow_backend</code></entry>
  343. <entry><code>string</code></entry>
  344. <entry><code>File</code></entry>
  345. <entry>le nom du backend "lent"</entry>
  346. </row>
  347. <row>
  348. <entry><code>fast_backend</code></entry>
  349. <entry><code>string</code></entry>
  350. <entry><code>Apc</code></entry>
  351. <entry>le nom du backend "rapide"</entry>
  352. </row>
  353. <row>
  354. <entry><code>slow_backend_options</code></entry>
  355. <entry><code>array</code></entry>
  356. <entry><code>array()</code></entry>
  357. <entry>les options du backend "lent"</entry>
  358. </row>
  359. <row>
  360. <entry><code>fast_backend_options</code></entry>
  361. <entry><code>array</code></entry>
  362. <entry><code>array()</code></entry>
  363. <entry>les options du backend "rapide"</entry>
  364. </row>
  365. <row>
  366. <entry><code>slow_backend_custom_naming</code></entry>
  367. <entry><code>boolean</code></entry>
  368. <entry><code>false</code></entry>
  369. <entry>
  370. si <code>true</code>, l'argument <code>slow_backend</code> est
  371. utilisé en tant que nom complet de classe ; si <code>false</code>,
  372. l'argument frontend est utilisé concaténé à
  373. "Zend_Cache_Backend_[...]"
  374. </entry>
  375. </row>
  376. <row>
  377. <entry><code>fast_backend_custom_naming</code></entry>
  378. <entry><code>boolean</code></entry>
  379. <entry><code>false</code></entry>
  380. <entry>
  381. si <code>true</code>, l'argument <code>fast_backend</code> est
  382. utilisé en tant que nom complet de classe ; si <code>false</code>,
  383. l'argument frontend est utilisé concaténé à
  384. "Zend_Cache_Backend_[...]"
  385. </entry>
  386. </row>
  387. <row>
  388. <entry><code>slow_backend_autoload</code></entry>
  389. <entry><code>boolean</code></entry>
  390. <entry><code>false</code></entry>
  391. <entry>
  392. si <code>true</code>, il n'y aura pas de require_once pour le
  393. <code>slow_backend</code> (utile seulement pour les backends
  394. personnalisés)
  395. </entry>
  396. </row>
  397. <row>
  398. <entry><code>fast_backend_autoload</code></entry>
  399. <entry><code>boolean</code></entry>
  400. <entry><code>false</code></entry>
  401. <entry>
  402. si <code>true</code>, il n'y aura pas de require_once pour le
  403. <code>fast_backend</code> (utile seulement pour les backends
  404. personnalisés)
  405. </entry>
  406. </row>
  407. <row>
  408. <entry><code>auto_refresh_fast_cache</code></entry>
  409. <entry><code>boolean</code></entry>
  410. <entry><code>true</code></entry>
  411. <entry>
  412. si <code>true</code>, rafraîchissement automatique du cache
  413. rapide quand un enregistrement est appelé
  414. </entry>
  415. </row>
  416. <row>
  417. <entry><code>stats_update_factor</code></entry>
  418. <entry><code>integer</code></entry>
  419. <entry><code>10</code></entry>
  420. <entry>
  421. désactive / personnalise le calcul du pourcentage de remplissage
  422. du backend rapide (lors d'une sauvegarde d'un enregistrement dans le
  423. cache, le calcul du remplissage est effectué aléatoirement 1 fois sur x
  424. écritures de cache)
  425. </entry>
  426. </row>
  427. </tbody>
  428. </tgroup>
  429. </table>
  430. </sect2>
  431. <sect2 id="zend.cache.backends.zendserver">
  432. <title> Zend_Cache_Backend_ZendServer_Disk et Zend_Cache_Backend_ZendServer_ShMem </title>
  433. <para>
  434. Ces backends utilisent les fonctionnalités de mise en cache de
  435. <ulink url="http://www.zend.com/en/products/server/downloads-all?zfs=zf_download">Zend
  436. Server</ulink>pour stocker les données.
  437. </para>
  438. <para>
  439. ATTENTION : avec ces backends ne supportent pas les balises ("tags") pour le
  440. moment de même que l'argument "doNotTestCacheValidity=true".
  441. </para>
  442. <para>
  443. Ces backends fonctionnent seulement dans l'environnement de Zend Server pour les
  444. pages requêtées à travers HTTP(S) et ne fonctionnent pas pour les scripts exécutés en
  445. ligne de commande.
  446. </para>
  447. <para>Il n'y a pas d'options pour ce backend.</para>
  448. </sect2>
  449. </sect1>