Zend_Cache-Backends.xml 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 17749 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.cache.backends">
  5. <title>Zend_Cache Backends</title>
  6. <para>
  7. Es gibt zwei Arten von Backends: Standard und erweiterte. Natürlich bieten erweiterte
  8. Backends mehr Features.
  9. </para>
  10. <sect2 id="zend.cache.backends.file">
  11. <title>Zend_Cache_Backend_File</title>
  12. <para>
  13. Dieses (erweiterte) Backend speichert Cache Datensätze in Dateien (in einem gewählten
  14. Verzeichnis).
  15. </para>
  16. <para>
  17. Mögliche Optionen sind :
  18. </para>
  19. <table id="zend.cache.backends.file.table">
  20. <title>File Backend Optionen</title>
  21. <tgroup cols="4">
  22. <thead>
  23. <row>
  24. <entry>Option</entry>
  25. <entry>Daten Typ</entry>
  26. <entry>Standardwert</entry>
  27. <entry>Beschreibung</entry>
  28. </row>
  29. </thead>
  30. <tbody>
  31. <row>
  32. <entry><emphasis>cache_dir</emphasis></entry>
  33. <entry><type>String</type></entry>
  34. <entry>'<filename>/tmp/</filename>'</entry>
  35. <entry>
  36. Verzeichnis, in dem die Cache Dateien gespeichert werden
  37. </entry>
  38. </row>
  39. <row>
  40. <entry><emphasis>file_locking</emphasis></entry>
  41. <entry><type>Boolean</type></entry>
  42. <entry><constant>TRUE</constant></entry>
  43. <entry>
  44. Ein- oder Ausschalten von file_locking: kann die Beschädigung des
  45. Caches unter schlechten Bedingungen verhindern, aber es hilft nicht bei
  46. Multithreaded Webservern oder bei <acronym>NFS</acronym>
  47. Filesystemen...
  48. </entry>
  49. </row>
  50. <row>
  51. <entry><emphasis>read_control</emphasis></entry>
  52. <entry><type>Boolean</type></entry>
  53. <entry><constant>TRUE</constant></entry>
  54. <entry>
  55. Ein- oder Ausschalten von read_control: eingeschaltet wird ein
  56. Kontrollschlüssel im Cache File inkludiert und dieser Schlüssel wird mit
  57. dem Schlüssel verglichen, der nach dem Lesen berechnet wird.
  58. </entry>
  59. </row>
  60. <row>
  61. <entry><emphasis>read_control_type</emphasis></entry>
  62. <entry><type>String</type></entry>
  63. <entry>'crc32'</entry>
  64. <entry>
  65. Typ der Schreibkontrolle (nur wenn read_control eingeschaltet ist).
  66. Mögliche Werte sind : 'md5' (bestes, aber am Langsamsten), 'crc32'
  67. (etwas weniger sicher, aber schneller, beste Wahl), 'adler32' (neue
  68. Wahl, schneller als crc32), 'strlen' um nur die Länge zu testen
  69. (schnellstes).
  70. </entry>
  71. </row>
  72. <row>
  73. <entry><emphasis>hashed_directory_level</emphasis></entry>
  74. <entry><type>Integer</type></entry>
  75. <entry>0</entry>
  76. <entry>
  77. Level der gehashten Verzeichnis Struktur: 0 heißt "keine gehashte
  78. Verzeichnis Strutur, 1 heißt "ein Level von Verzeichnissen", 2 heißt
  79. "zwei Levels"... Diese Option kann den Cache nur dann schneller machen,
  80. wenn viele Tausende Cache Dateien verwendet werden. Nur spezielle
  81. Messungen können helfen, den perfekten Wert zu finden. Möglicherweise
  82. ist 1 oder 2 ein guter Anfang.
  83. </entry>
  84. </row>
  85. <row>
  86. <entry><emphasis>hashed_directory_umask</emphasis></entry>
  87. <entry><type>Integer</type></entry>
  88. <entry>0700</entry>
  89. <entry>
  90. Umask für die gehashte Verzeichnis Struktur
  91. </entry>
  92. </row>
  93. <row>
  94. <entry><emphasis>file_name_prefix</emphasis></entry>
  95. <entry><type>String</type></entry>
  96. <entry>'zend_cache'</entry>
  97. <entry>
  98. Präfix für Cache Dateien; man muss mit dieser Option sehr vorsichtig
  99. umgehen, weil ein zu generischer Wert in einem System Cache
  100. Verzeichnis (wie <filename>/tmp</filename>) kann beim Löschen des
  101. Caches zu großen Problemen führen.
  102. </entry>
  103. </row>
  104. <row>
  105. <entry><emphasis>cache_file_umask</emphasis></entry>
  106. <entry><type>Integer</type></entry>
  107. <entry>0700</entry>
  108. <entry>
  109. umask nach Cache Dateien
  110. </entry>
  111. </row>
  112. <row>
  113. <entry><emphasis>metatadatas_array_max_size</emphasis></entry>
  114. <entry><type>Integer</type></entry>
  115. <entry>100</entry>
  116. <entry>
  117. Interne maximale Größe für das Metadaten Array (dieser Wert sollte
  118. nicht geändert werden außer man weiß was man macht)
  119. </entry>
  120. </row>
  121. </tbody>
  122. </tgroup>
  123. </table>
  124. </sect2>
  125. <sect2 id="zend.cache.backends.sqlite">
  126. <title>Zend_Cache_Backend_Sqlite</title>
  127. <para>
  128. Dieses (erweiterte) Backend speichert die Cache Datensätze in einer SQLite Datenbank.
  129. </para>
  130. <para>
  131. Mögliche Optionen sind :
  132. </para>
  133. <table id="zend.cache.backends.sqlite.table">
  134. <title>Sqlite Backend Optionen</title>
  135. <tgroup cols="4">
  136. <thead>
  137. <row>
  138. <entry>Option</entry>
  139. <entry>Daten Typ</entry>
  140. <entry>Standardwert</entry>
  141. <entry>Beschreibung</entry>
  142. </row>
  143. </thead>
  144. <tbody>
  145. <row>
  146. <entry><emphasis>cache_db_complete_path (mandatory)</emphasis></entry>
  147. <entry><type>String</type></entry>
  148. <entry><constant>NULL</constant></entry>
  149. <entry>
  150. Der komplette Pfad (inklusive Dateiname) der SQLite Datenbank
  151. </entry>
  152. </row>
  153. <row>
  154. <entry><emphasis>automatic_vacuum_factor</emphasis></entry>
  155. <entry><type>Integer</type></entry>
  156. <entry>10</entry>
  157. <entry>
  158. Deaktiviert oder stellt den automatischen Vakuumprozess ein.
  159. Der automatische Vakuumprozess defragmentiert die Datenbankdatei (und
  160. verkleinert sie) wenn <methodname>clean()</methodname> oder
  161. <methodname>delete()</methodname> aufgerufen wird: 0 bedeutet kein
  162. automatisches Vakuum; 1 bedeutet systematisches Vakuum (wenn die
  163. <methodname>delete()</methodname> or <methodname>clean()</methodname>
  164. Methoden aufgerufen werden; x (integer) > 1 => automatisches Vakuum
  165. zufällig einmal pro x <methodname>clean()</methodname> oder
  166. <methodname>delete()</methodname> Aufrufe.
  167. </entry>
  168. </row>
  169. </tbody>
  170. </tgroup>
  171. </table>
  172. </sect2>
  173. <sect2 id="zend.cache.backends.memcached">
  174. <title>Zend_Cache_Backend_Memcached</title>
  175. <para>
  176. Dieses (erweiterte) Backend speichert Cache Datensätze in einem Memcached Server. <ulink
  177. url="http://www.danga.com/memcached/">memcached</ulink> ist ein hoch-performantes,
  178. verteiltes Speicher Objekt Caching System. Um dieses Backend zu benutzen, wird ein
  179. Memcached Dämon benötigt und <ulink url="http://pecl.php.net/package/memcache">die
  180. Memcached <acronym>PECL</acronym> Erweiterung</ulink>.
  181. </para>
  182. <para>
  183. Vorsicht: mit diesem Backend werden zur Zeit "Marker" nicht unterstützt genauso wie das
  184. "doNotTestCacheValidity=true" Argument.
  185. </para>
  186. <para>
  187. Mögliche Optionen sind :
  188. </para>
  189. <table id="zend.cache.backends.memcached.table">
  190. <title>Memcached Backend Optionen</title>
  191. <tgroup cols="4">
  192. <thead>
  193. <row>
  194. <entry>Option</entry>
  195. <entry>Daten Typ</entry>
  196. <entry>Standardwert</entry>
  197. <entry>Beschreibung</entry>
  198. </row>
  199. </thead>
  200. <tbody>
  201. <row>
  202. <entry><emphasis>servers</emphasis></entry>
  203. <entry><type>Array</type></entry>
  204. <entry>
  205. <command>array(array('host' => 'localhost','port' => 11211,
  206. 'persistent' => true, 'weight' => 1, 'timeout' => 5,
  207. 'retry_interval' => 15, 'status' => true,
  208. 'failure_callback' => '' ))</command>
  209. </entry>
  210. <entry>
  211. Ein Array von Memcached Servern; jeder Memcached Server wird durch ein
  212. assoziatives Array beschrieben : 'host' => (string) : Der Name des
  213. Memcached Servers, 'port' => (int) : Der Port des Memcached Servers,
  214. 'persistent' => (bool) : Persistente Verbindungen für diesen Memcached
  215. Server verwenden oder nicht 'weight' => (int) : Das Gewicht des
  216. Memcached Servers, 'timeout' => (int) : Das Timeout des Memcached
  217. Servers, 'retry_interval' => (int) : Das Wiederholungsintervall des
  218. Memcached Servers, 'status' => (bool) : Der Status des Memcached
  219. Servers, 'failure_callback' => (callback) : Der failure_callback des
  220. Memcached Servers
  221. </entry>
  222. </row>
  223. <row>
  224. <entry><emphasis>compression</emphasis></entry>
  225. <entry><type>Boolean</type></entry>
  226. <entry><constant>FALSE</constant></entry>
  227. <entry>
  228. <constant>TRUE</constant> wenn on-the-fly Kompression verwendet werden
  229. soll
  230. </entry>
  231. </row>
  232. <row>
  233. <entry><emphasis>compatibility</emphasis></entry>
  234. <entry><type>Boolean</type></entry>
  235. <entry><constant>FALSE</constant></entry>
  236. <entry>
  237. <constant>TRUE</constant> wenn man den Compatibility Modus mit alten
  238. Memcache Servern oder Erweiterungen verwenden will
  239. </entry>
  240. </row>
  241. </tbody>
  242. </tgroup>
  243. </table>
  244. </sect2>
  245. <sect2 id="zend.cache.backends.apc">
  246. <title>Zend_Cache_Backend_Apc</title>
  247. <para>
  248. Dieses (erweiterte) Backend speichert Cache Datensätze im Shared Memory durch die
  249. <ulink url="http://pecl.php.net/package/APC">APC</ulink> (Alternativer
  250. <acronym>PHP</acronym> Cache) Erweiterung (welche natürlich für die Verwendung dieses
  251. Backends benötigt wird).
  252. </para>
  253. <para>
  254. Vorsicht: mit diesem Backend werden "Marker" zur Zeit nicht unterstützt genauso wie das
  255. "doNotTestCacheValidity=true" Argument.
  256. </para>
  257. <para>
  258. Es gibt keine Optionen für dieses Backend.
  259. </para>
  260. </sect2>
  261. <sect2 id="zend.cache.backends.xcache">
  262. <title>Zend_Cache_Backend_Xcache</title>
  263. <para>
  264. Dieses Backend speichert Cache Einträge im Shared Memory durch die
  265. <ulink url="http://xcache.lighttpd.net/">XCache</ulink> Erweiterung (welche natürlich
  266. benötigt wird, damit dieses Backend verwendet werden kann).
  267. </para>
  268. <para>
  269. Achtung: Bei diesem Backend werden "tags" aktuell nicht unterstützt sowie das
  270. "doNotTestCacheValidity=true" Argument.
  271. </para>
  272. <para>
  273. Mögliche Optionen sind:
  274. </para>
  275. <table id="zend.cache.backends.xcache.table">
  276. <title>Xcache backend options</title>
  277. <tgroup cols="4">
  278. <thead>
  279. <row>
  280. <entry>Option</entry>
  281. <entry>Daten Typ</entry>
  282. <entry>Standardwert</entry>
  283. <entry>Beschreibung</entry>
  284. </row>
  285. </thead>
  286. <tbody>
  287. <row>
  288. <entry><emphasis>user</emphasis></entry>
  289. <entry><type>String</type></entry>
  290. <entry><constant>NULL</constant></entry>
  291. <entry>
  292. <filename>xcache.admin.user</filename>, notwendig für die
  293. <methodname>clean()</methodname> Methode
  294. </entry>
  295. </row>
  296. <row>
  297. <entry><emphasis>password</emphasis></entry>
  298. <entry><type>String</type></entry>
  299. <entry><constant>NULL</constant></entry>
  300. <entry>
  301. <filename>xcache.admin.pass</filename> (in offener Form, nicht
  302. <acronym>MD5</acronym>), notwendig für die
  303. <methodname>clean()</methodname> Methode
  304. </entry>
  305. </row>
  306. </tbody>
  307. </tgroup>
  308. </table>
  309. </sect2>
  310. <sect2 id="zend.cache.backends.platform">
  311. <title>Zend_Cache_Backend_ZendPlatform</title>
  312. <para>
  313. Dieses Backend verwendet die Content Caching <acronym>API</acronym> des
  314. <ulink url="http://www.zend.com/en/products/platform">Zend Platform</ulink> Produktes.
  315. Natürlich muss man die Zend Platform installiert haben, um dieses Backend verwenden zu
  316. können.
  317. </para>
  318. <para>
  319. Dieses Backend unterstützt Tags, aber nicht den
  320. <constant>CLEANING_MODE_NOT_MATCHING_TAG</constant> Löschmodus.
  321. </para>
  322. <para>
  323. Bei Definition dieses Backends muß ein Trennzeichen -- '-', '.', ' ', oder '_'
  324. -- zwischen den Wörtern 'Zend' und 'Platform' definiert sein wenn die
  325. <methodname>Zend_Cache::factory()</methodname> Methode verwendet wird:
  326. </para>
  327. <programlisting language="php"><![CDATA[
  328. $cache = Zend_Cache::factory('Core', 'Zend Platform');
  329. ]]></programlisting>
  330. <para>
  331. Es gibt keine Optionen für dieses Backend.
  332. </para>
  333. </sect2>
  334. <sect2 id="zend.cache.backends.twolevels">
  335. <title>Zend_Cache_Backend_TwoLevels</title>
  336. <para>
  337. Dieses (erweiterte) Backend ist ein Hybrides. Es speichert Cache Einträge in zwei
  338. anderen Backends: Ein schnelles (aber limitiertes) wie Apc, Memcache... und ein
  339. "langsames" wie File, Sqlite...
  340. </para>
  341. <para>
  342. Dieses Backend verwendet den Priority Parameter (der auf Frontend Level angegeben wird
  343. wenn ein Eintrag gespeichert wird) und den verbleibenden Platz im schnellen Backend um
  344. die Verwendung dieser zwei Backends zu optimieren.
  345. </para>
  346. <para>
  347. Dieses Backend sollte mit Verwendung eines Word Separators -- '-', '.', ' ', oder '_' --
  348. zwischen den Wörtern 'Two' und 'Levels' spezifiziert werden wenn die
  349. <methodname>Zend_Cache::factory()</methodname> Methode verwendet wird:
  350. </para>
  351. <programlisting language="php"><![CDATA[
  352. $cache = Zend_Cache::factory('Core', 'Two Levels');
  353. ]]></programlisting>
  354. <para>
  355. Vorhandene Optionen sind:
  356. </para>
  357. <table id="zend.cache.backends.twolevels.table">
  358. <title>TwoLevels Backend Optionen</title>
  359. <tgroup cols="4">
  360. <thead>
  361. <row>
  362. <entry>Option</entry>
  363. <entry>Datentyp</entry>
  364. <entry>Standardwert</entry>
  365. <entry>Beschreibung</entry>
  366. </row>
  367. </thead>
  368. <tbody>
  369. <row>
  370. <entry><emphasis>slow_backend</emphasis></entry>
  371. <entry><type>String</type></entry>
  372. <entry>File</entry>
  373. <entry>
  374. Der "langsame" Backendname
  375. </entry>
  376. </row>
  377. <row>
  378. <entry><emphasis>fast_backend</emphasis></entry>
  379. <entry><type>String</type></entry>
  380. <entry>Apc</entry>
  381. <entry>
  382. Der "schnelle" Backendname
  383. </entry>
  384. </row>
  385. <row>
  386. <entry><emphasis>slow_backend_options</emphasis></entry>
  387. <entry><type>Array</type></entry>
  388. <entry><methodname>array()</methodname></entry>
  389. <entry>
  390. Die "langsamen" Backendoptionen
  391. </entry>
  392. </row>
  393. <row>
  394. <entry><emphasis>fast_backend_options</emphasis></entry>
  395. <entry><type>Array</type></entry>
  396. <entry><methodname>array()</methodname></entry>
  397. <entry>
  398. Die "schnellen" Backendoptionen
  399. </entry>
  400. </row>
  401. <row>
  402. <entry><emphasis>slow_backend_custom_naming</emphasis></entry>
  403. <entry><type>Boolean</type></entry>
  404. <entry><constant>FALSE</constant></entry>
  405. <entry>
  406. Wenn <constant>TRUE</constant>, wird das slow_backend Argument als
  407. kompletter Klassenname verwendet; wenn <constant>FALSE</constant>,
  408. wird das frontend Argument als Ende des
  409. "<classname>Zend_Cache_Backend_</classname>[...]" Klassennamens
  410. verwendet
  411. </entry>
  412. </row>
  413. <row>
  414. <entry><emphasis>fast_backend_custom_naming</emphasis></entry>
  415. <entry><type>Boolean</type></entry>
  416. <entry><constant>FALSE</constant></entry>
  417. <entry>
  418. Wenn <constant>TRUE</constant>, wird das fast_backend Argument als
  419. kompletter Klassenname verwendet; wenn <constant>false</constant>,
  420. wird das frontend Argument als Ende des
  421. "<classname>Zend_Cache_Backend_</classname>[...]" Klassennamens
  422. verwendet
  423. </entry>
  424. </row>
  425. <row>
  426. <entry><emphasis>slow_backend_autoload</emphasis></entry>
  427. <entry><type>Boolean</type></entry>
  428. <entry><constant>FALSE</constant></entry>
  429. <entry>
  430. Wenn <constant>TRUE</constant>, wird kein require_once für das
  431. langsame Backend verwendet (nur für eigene Backends nützlich)
  432. </entry>
  433. </row>
  434. <row>
  435. <entry><emphasis>fast_backend_autoload</emphasis></entry>
  436. <entry><type>Boolean</type></entry>
  437. <entry><constant>FALSE</constant></entry>
  438. <entry>
  439. Wenn <constant>TRUE</constant>, wird kein require_once für das
  440. schnelle Backend verwendet (nur für eigene Backends nützlich)
  441. </entry>
  442. </row>
  443. <row>
  444. <entry><emphasis>auto_refresh_fast_cache</emphasis></entry>
  445. <entry><type>Boolean</type></entry>
  446. <entry><constant>TRUE</constant></entry>
  447. <entry>
  448. Wenn <constant>TRUE</constant>, wird der schnelle Cache automatisch
  449. refresht wenn ein Cache Eintrag getroffen wird
  450. </entry>
  451. </row>
  452. <row>
  453. <entry><emphasis>stats_update_factor</emphasis></entry>
  454. <entry><type>Integer</type></entry>
  455. <entry>10</entry>
  456. <entry>
  457. Ausschalten / Feintunen der Berechnung des Füll-Prozentsatzes des
  458. schnellen Backends (wenn ein Eintrag in den Cache gespeichert wird,
  459. die Berechnung des Füll-Prozentsatzes des schnellen Backends zufällig
  460. 1 mal bei x Cache Schreibvorgängen)
  461. </entry>
  462. </row>
  463. </tbody>
  464. </tgroup>
  465. </table>
  466. </sect2>
  467. <sect2 id="zend.cache.backends.zendserver">
  468. <title>Zend_Cache_Backend_ZendServer_Disk und Zend_Cache_Backend_ZendServer_ShMem</title>
  469. <para>
  470. Diese Backends speichern Cacheeinträge indem Sie die Caching Funktionalitäten von <ulink
  471. url="http://www.zend.com/en/products/server/downloads-all?zfs=zf_download">Zend
  472. Server</ulink> verwenden.
  473. </para>
  474. <para>
  475. Achtung: mit diesen Backends werden für den Moment "Tags" nicht unterstützt, wegen dem
  476. "doNotTestCacheValidity=true" Argument.
  477. </para>
  478. <para>
  479. Diese Backends arbeiten nur in einer Zend Server Umgebung für Seiten die über
  480. <acronym>HTTP</acronym> oder <acronym>HTTPS</acronym> angefragt wurden und nicht für
  481. Kommandozeilen Ausführung.
  482. </para>
  483. <para>
  484. Dieses Backend muß durch Verwendung des <emphasis>customBackendNaming</emphasis>
  485. Parameter mit <constant>TRUE</constant> spezifiziert werden wenn die Methode
  486. <methodname>Zend_Cache::factory()</methodname> verwendet wird:
  487. </para>
  488. <programlisting language="php"><![CDATA[
  489. $cache = Zend_Cache::factory('Core', 'Zend_Cache_Backend_ZendServer_Disk',
  490. $frontendOptions, $backendOptions, false, true);
  491. ]]></programlisting>
  492. <para>
  493. Es gibt keine Optionen für diese Backends.
  494. </para>
  495. </sect2>
  496. </sect1>
  497. <!--
  498. vim:se ts=4 sw=4 et:
  499. +-->