Zend_Cache-Frontends.xml 51 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962
  1. <sect1 id="zend.cache.frontends">
  2. <title>Фронтэнды Zend_Cache</title>
  3. <sect2 id="zend.cache.frontends.core">
  4. <title><code>Zend_Cache_Core</code></title>
  5. <sect3 id="zend.cache.frontends.core.introduction">
  6. <title>Введение</title>
  7. <para>
  8. Фронтэнд <code>Zend_Cache_Core</code> является особым,
  9. так как это ядро всего модуля. Это фронтэнд общего назначения и
  10. он расширяется другими классами.
  11. </para>
  12. <note>
  13. <para>
  14. Все фронтэнды наследуют от класса
  15. <code>Zend_Cache_Core</code>, поэтому его методы и опции,
  16. описанные ниже, должны быть доступны в других фронтэндах и
  17. не будут описываться далее.
  18. </para>
  19. </note>
  20. </sect3>
  21. <sect3 id="zend.cache.frontends.core.options">
  22. <title>Доступные опции</title>
  23. <para>
  24. Эти опции передаются фабричному методу, как было показано в
  25. предыдущих примерах.
  26. </para>
  27. <table id="zend.cache.frontends.core.options.table">
  28. <title>Опции <code>Zend_Cache_Core</code></title>
  29. <tgroup cols="4">
  30. <thead>
  31. <row>
  32. <entry>Опция</entry>
  33. <entry>Тип данных</entry>
  34. <entry>Значение по умолчанию</entry>
  35. <entry>Описание</entry>
  36. </row>
  37. </thead>
  38. <tbody>
  39. <row>
  40. <entry><code>caching</code></entry>
  41. <entry><code>boolean</code></entry>
  42. <entry><code>true</code></entry>
  43. <entry>
  44. Включает/отключает кэширование (может быть
  45. очень полезным при отладке кэшируемых
  46. скриптов).
  47. </entry>
  48. </row>
  49. <row>
  50. <entry><code>cache_id_prefix</code></entry>
  51. <entry><code>string</code></entry>
  52. <entry><code>null</code></entry>
  53. <entry>
  54. Префикс для всех идентификаторов кэша. Если
  55. установлен в <code>null</code>, то префикс не
  56. будет использоваться. Префикс идентификатора
  57. кэша в первую очередь создает пространство
  58. имен в кэше, что позволяет нескольким
  59. приложениям или веб-сайтам использовать общий
  60. кэш. Любое приложение или веб-сайт может
  61. использовать свой префикс идентификаторов
  62. кэша, благодаря чему отдельные идентификаторы
  63. кеша могут использоваться многократно.
  64. </entry>
  65. </row>
  66. <row>
  67. <entry><code>lifetime</code></entry>
  68. <entry><code>int</code></entry>
  69. <entry><code>3600</code></entry>
  70. <entry>
  71. Время жизни кэша (в секундах), если установлен в
  72. <code>null</code>, то кэш имеет бесконечное
  73. время жизни.
  74. </entry>
  75. </row>
  76. <row>
  77. <entry><code>logging</code></entry>
  78. <entry><code>boolean</code></entry>
  79. <entry><code>false</code></entry>
  80. <entry>
  81. Если установлен в <code>true</code>, то
  82. включается логирование через
  83. <code>Zend_Log</code> (но система будет
  84. работать медленнее).
  85. </entry>
  86. </row>
  87. <row>
  88. <entry><code>write_сontrol</code></entry>
  89. <entry><code>boolean</code></entry>
  90. <entry><code>true</code></entry>
  91. <entry>
  92. Включает/отключает контроль записи (кэш
  93. читается сразу после записи для выявления
  94. поврежденных записей), включение write_control
  95. немного замедлит запись кэша, но не чтение. Этот
  96. контроль поможет выявить некоторые поврежденные
  97. файлы кэша, но не является совершенным.
  98. </entry>
  99. </row>
  100. <row>
  101. <entry><code>automatic_serialization</code></entry>
  102. <entry><code>boolean</code></entry>
  103. <entry><code>false</code></entry>
  104. <entry>
  105. Включает/отключает автоматическую
  106. сериализацию, она может использоваться для
  107. сохранения напрямую данных, которые не являются
  108. строками (но это будет медленнее).
  109. </entry>
  110. </row>
  111. <row>
  112. <entry><code>automatic_cleaning_factor</code></entry>
  113. <entry><code>int</code></entry>
  114. <entry><code>10</code></entry>
  115. <entry>
  116. Отключает/настраивает процесс автоматической
  117. очистки (сборки мусора):
  118. <code>0</code> означает, что автоматическая
  119. чистка кэша не производится,
  120. <code>1</code> означает систематическую очистку
  121. кэша,
  122. <code>x (integer) &gt; 1</code> означает, что
  123. автоматическая чистка производится случайным
  124. образом 1 раз на x записей кэша.
  125. </entry>
  126. </row>
  127. <row>
  128. <entry><code>ignore_user_abort</code></entry>
  129. <entry><code>boolean</code></entry>
  130. <entry><code>false</code></entry>
  131. <entry>
  132. Если установлен в true, то ядро будет
  133. устанавливать флаг ignore_user_abort в методе
  134. save() во избежание порчи кэша в некоторых
  135. случаях.
  136. </entry>
  137. </row>
  138. </tbody>
  139. </tgroup>
  140. </table>
  141. </sect3>
  142. <sect3 id="zend.cache.core.examples">
  143. <title>Примеры</title>
  144. <para>
  145. Пример был дан в самом начале данного раздела руководства.
  146. </para>
  147. <para>
  148. Если вы храните в кэше только строки (с опцией
  149. <code>automatic_serialization</code> возможно хранить некоторые
  150. булевы значения), вы можете использовать более компактную
  151. конструкцию, как показано ниже:
  152. </para>
  153. <programlisting role="php"><![CDATA[
  154. // предполагается, что переменная $cache уже установлена
  155. $id = 'myBigLoop'; // идентификатор того, что мы хотим закэшировать
  156. if (!($data = $cache->load($id))) {
  157. // промах кэша
  158. $data = '';
  159. for ($i = 0; $i < 10000; $i++) {
  160. $data = $data . $i;
  161. }
  162. $cache->save($data);
  163. }
  164. // [...] делаем что-либо с данными (отображение, передача и т.д.)
  165. ]]>
  166. </programlisting>
  167. <para>
  168. Если вы хотите закэшировать несколько блоков или экземпляров
  169. данных, то принцип будет тот же:
  170. </para>
  171. <programlisting role="php"><![CDATA[
  172. // убедитесь, что используете уникальные идентификаторы:
  173. $id1 = 'foo';
  174. $id2 = 'bar';
  175. // блок 1
  176. if (!($data = $cache->load($id1))) {
  177. // промах кэша
  178. $data = '';
  179. for ($i=0;$i<10000;$i++) {
  180. $data = $data . $i;
  181. }
  182. $cache->save($data);
  183. }
  184. echo($data);
  185. // эта часть не кэшируется
  186. echo('НЕ КЭШИРУЕТСЯ! ');
  187. // блок 2
  188. if (!($data = $cache->load($id2))) {
  189. // промах кэша
  190. $data = '';
  191. for ($i=0;$i<10000;$i++) {
  192. $data = $data . '!';
  193. }
  194. $cache->save($data);
  195. }
  196. echo($data);]]>
  197. </programlisting>
  198. <para>
  199. Если вы хотите кэшировать специальные значения (булево
  200. значение через опцию "automatic_serialization") или пустую
  201. строку, то компактная форма, приведенная выше, уже не
  202. подходит. Проверка на наличие записи кэша должна производиться
  203. созданным для этого методом.
  204. </para>
  205. <programlisting role="php"><![CDATA[
  206. // Копмпактная форма. Не подходит, если могут кэшироваться
  207. // пустые строки и значения булевого типа
  208. if (!($data = $cache->load($id))) {
  209. // промах кэша
  210. // [...] получаем данные и присваиваем их переменной $data
  211. $cache->save($data);
  212. }
  213. // делаем что-либо с данными
  214. // [...]
  215. // Полная форма, будет работать в любом случае
  216. if (!($cache->test($id))) {
  217. // промах кэша
  218. // [...] получаем данные и присваиваем их переменной $data
  219. $cache->save($data);
  220. } else {
  221. // попадание в кэш
  222. $data = $cache->load($id);
  223. }
  224. // делаем что-либо с данными
  225. ]]>
  226. </programlisting>
  227. </sect3>
  228. </sect2>
  229. <sect2 id="zend.cache.frontends.output">
  230. <title><code>Zend_Cache_Frontend_Output</code></title>
  231. <sect3 id="zend.cache.frontends.output.introduction">
  232. <title>Введение</title>
  233. <para>
  234. <code>Zend_Cache_Frontend_Output</code> является фронтэндом,
  235. собирающим выходные данные. Он использует буферизацию вывода
  236. (output buffering) в PHP для сохранения всего, что выводится
  237. между его методами <code>start()</code> и <code>end()</code>.
  238. </para>
  239. </sect3>
  240. <sect3 id="zend.cache.frontends.output.options">
  241. <title>Доступные опции</title>
  242. <para>
  243. Этот фронтэнд не имеет каких-либо специальных опций, отличных
  244. от опций <code>Zend_Cache_Core</code>.
  245. </para>
  246. </sect3>
  247. <sect3 id="zend.cache.frontends.output.examples">
  248. <title>Примеры</title>
  249. <para>
  250. Пример был дан в самом начале данного руководства. Здесь
  251. он с небольшими изменениями:
  252. </para>
  253. <programlisting role="php"><![CDATA[
  254. // если имеет место промах кэша,
  255. // то начинается буферизация вывода
  256. if (!($cache->start('mypage'))) {
  257. // все выводится, как обычно
  258. echo 'Hello world! ';
  259. echo 'This is cached ('.time().') ';
  260. $cache->end(); // завершение буферизации вывода
  261. }
  262. echo 'This is never cached ('.time().').';
  263. ]]>
  264. </programlisting>
  265. <para>
  266. Используя эту форму, довольно легко установить кэширование
  267. вывода в уже работающем проекте с незначительным рефакторингом
  268. кода или совсем без него.
  269. </para>
  270. </sect3>
  271. </sect2>
  272. <sect2 id="zend.cache.frontends.function">
  273. <title><code>Zend_Cache_Frontend_Function</code></title>
  274. <sect3 id="zend.cache.frontends.function.introduction">
  275. <title>Введение</title>
  276. <para>
  277. <code>Zend_Cache_Frontend_Function</code> сохраняет в кэш
  278. результаты вызова функции. Он имеет единственный основной метод
  279. <code>call()</code>, который принимает имя функции и параметры
  280. вызова в виде массива.
  281. </para>
  282. </sect3>
  283. <sect3 id="zend.cache.frontends.function.options">
  284. <title>Доступные опции</title>
  285. <table id="zend.cache.frontends.function.options.table">
  286. <title>Опции <code>Zend_Cache_Frontend_Function</code></title>
  287. <tgroup cols="4">
  288. <thead>
  289. <row>
  290. <entry>Опция</entry>
  291. <entry>Тип данных</entry>
  292. <entry>Значение по умолчанию</entry>
  293. <entry>Описание</entry>
  294. </row>
  295. </thead>
  296. <tbody>
  297. <row>
  298. <entry><code>cache_by_default</code></entry>
  299. <entry><code>boolean</code></entry>
  300. <entry><code>true</code></entry>
  301. <entry>
  302. Если равен true, то вызовы функции по
  303. умолчанию кэшируются.
  304. </entry>
  305. </row>
  306. <row>
  307. <entry><code>cached_functions</code></entry>
  308. <entry><code>array</code></entry>
  309. <entry></entry>
  310. <entry>
  311. Имена функций, которые всегда кэшируются.
  312. </entry>
  313. </row>
  314. <row>
  315. <entry><code>non_cached_functions</code></entry>
  316. <entry><code>array</code></entry>
  317. <entry></entry>
  318. <entry>
  319. Имена функций, которые никогда не должны
  320. кэшироваться.
  321. </entry>
  322. </row>
  323. </tbody>
  324. </tgroup>
  325. </table>
  326. </sect3>
  327. <sect3 id="zend.cache.frontends.function.examples">
  328. <title>Примеры</title>
  329. <para>
  330. Функция <code>call()</code> используется так же, как и
  331. <code>call_user_func_array()</code> в PHP:
  332. </para>
  333. <programlisting role="php"><![CDATA[
  334. $cache->call('veryExpensiveFunc', $params);
  335. // $params является массивом
  336. // Например, если нужно вызвать с кэшированием
  337. // veryExpensiveFunc(1, 'foo', 'bar'),
  338. // то вы должны использовать
  339. // $cache->call('veryExpensiveFunc', array(1, 'foo', 'bar'))
  340. ]]>
  341. </programlisting>
  342. <para>
  343. <code>Zend_Cache_Frontend_Function</code> достаточно
  344. интеллектуален, чтобы кэшировать как возвращаемое функцией
  345. значение, так и данные, выводимые внутри нее.
  346. </para>
  347. <note>
  348. <para>
  349. Вы можете передавать любые как встроенные, так и
  350. определенные пользователем функции, за исключением
  351. <code>array()</code>,
  352. <code>echo()</code>, <code>empty()</code>,
  353. <code>eval()</code>, <code>exit()</code>,
  354. <code>isset()</code>, <code>list()</code>,
  355. <code>print()</code> и <code>unset()</code>.
  356. </para>
  357. </note>
  358. </sect3>
  359. </sect2>
  360. <sect2 id="zend.cache.frontends.class">
  361. <title><code>Zend_Cache_Frontend_Class</code></title>
  362. <sect3 id="zend.cache.frontends.class.introduction">
  363. <title>Введение</title>
  364. <para>
  365. <code>Zend_Cache_Frontend_Class</code> отличается от
  366. <code>Zend_Cache_Frontend_Function</code> тем, что позволяет
  367. кэшировать объекты и статические вызовы методов.
  368. </para>
  369. </sect3>
  370. <sect3 id="zend.cache.frontends.class.options">
  371. <title>Доступные опции</title>
  372. <table id="zend.cache.frontends.class.options.table">
  373. <title>Опции <code>Zend_Cache_Frontend_Class</code></title>
  374. <tgroup cols="4">
  375. <thead>
  376. <row>
  377. <entry>Опция</entry>
  378. <entry>Тип данных</entry>
  379. <entry>Значение по умолчанию</entry>
  380. <entry>Описание</entry>
  381. </row>
  382. </thead>
  383. <tbody>
  384. <row>
  385. <entry><code>cached_entity</code> (required)</entry>
  386. <entry><code>mixed</code></entry>
  387. <entry></entry>
  388. <entry>
  389. Если установлен как имя класса, то будет
  390. кэшироваться абстрактный класс и будут
  391. использоваться только статические вызовы; если
  392. установлен как объект,
  393. то будут кэшироваться методы объекта.
  394. </entry>
  395. </row>
  396. <row>
  397. <entry><code>cache_by_default</code></entry>
  398. <entry><code>boolean</code></entry>
  399. <entry><code>true</code></entry>
  400. <entry>
  401. Если установлен в <code>true</code>, то вызовы
  402. будут кэшироваться по умолчанию.
  403. </entry>
  404. </row>
  405. <row>
  406. <entry><code>cached_methods</code></entry>
  407. <entry><code>array</code></entry>
  408. <entry></entry>
  409. <entry>
  410. Имена методов, которые должны всегда
  411. кэшироваться.
  412. </entry>
  413. </row>
  414. <row>
  415. <entry><code>non_cached_methods</code></entry>
  416. <entry><code>array</code></entry>
  417. <entry></entry>
  418. <entry>
  419. Имена методов, которые никогда не должны
  420. кэшироваться.
  421. </entry>
  422. </row>
  423. </tbody>
  424. </tgroup>
  425. </table>
  426. </sect3>
  427. <sect3 id="zend.cache.frontends.class.examples">
  428. <title>Примеры</title>
  429. <para>
  430. Кэширование статических вызовов:
  431. </para>
  432. <programlisting role="php"><![CDATA[<?php
  433. class Test {
  434. // Статический метод
  435. public static function foobar($param1, $param2) {
  436. echo "foobar_output($param1, $param2)";
  437. return "foobar_return($param1, $param2)";
  438. }
  439. }
  440. // [...]
  441. $frontendOptions = array(
  442. 'cached_entity' => 'Test' // имя класса
  443. );
  444. // [...]
  445. // Кэшируемый вызов
  446. $result = $cache->foobar('1', '2');
  447. ]]>
  448. </programlisting>
  449. <para>
  450. Кэширование обычных вызовов методов:
  451. </para>
  452. <programlisting role="php"><![CDATA[
  453. class Test {
  454. private $_string = 'hello !';
  455. public function foobar2($param1, $param2) {
  456. echo($this->_string);
  457. echo "foobar2_output($param1, $param2)";
  458. return "foobar2_return($param1, $param2)";
  459. }
  460. }
  461. // [...]
  462. $frontendOptions = array(
  463. 'cached_entity' => new Test() // экземпляр класса
  464. );
  465. // [...]
  466. // Кэшируемый вызов
  467. $result = $cache->foobar2('1', '2');
  468. ]]>
  469. </programlisting>
  470. </sect3>
  471. </sect2>
  472. <sect2 id="zend.cache.frontends.file">
  473. <title><code>Zend_Cache_Frontend_File</code></title>
  474. <sect3 id="zend.cache.frontends.file.introduction">
  475. <title>Введение</title>
  476. <para>
  477. <code>Zend_Cache_Frontend_File</code> является фронтэндом,
  478. который управляется временем изменения "ведущего файла".
  479. Он очень полезен для кэширования конфигураций или шаблонов.
  480. Можно использовать несколько ведущих файлов.
  481. </para>
  482. <para>
  483. Например, у вас есть конфигурационный файл XML. Он парсится
  484. функцией, которая возвращает объект конфигурации
  485. (наподобие <code>Zend_Config</code>). С помощью
  486. <code>Zend_Cache_Frontend_File</code> вы можете сохранять объект
  487. конфигурации в кэш, чтобы избежать повторного парсинга
  488. конфигурационного файла XML. Время жизни кэша будет зависеть
  489. от ведущего файла - если конфигурационный
  490. файл XML изменится, то кэш сразу становится недействительным.
  491. </para>
  492. </sect3>
  493. <sect3 id="zend.cache.frontends.file.options">
  494. <title>Доступные опции</title>
  495. <table id="zend.cache.frontends.file.options.table">
  496. <title>Опции <code>Zend_Cache_Frontend_File</code></title>
  497. <tgroup cols="4">
  498. <thead>
  499. <row>
  500. <entry>Опция</entry>
  501. <entry>Тип данных</entry>
  502. <entry>Значение по умолчанию</entry>
  503. <entry>Описание</entry>
  504. </row>
  505. </thead>
  506. <tbody>
  507. <row>
  508. <entry><code>master_file</code> (не рекомендуется к использованию)</entry>
  509. <entry><code>string</code></entry>
  510. <entry><code></code></entry>
  511. <entry>
  512. Полные путь и имя ведущего файла
  513. </entry>
  514. </row>
  515. <row>
  516. <entry><code>master_files</code></entry>
  517. <entry><code>array</code></entry>
  518. <entry><code></code></entry>
  519. <entry>
  520. Массив полных путей к ведущим файлам
  521. </entry>
  522. </row>
  523. <row>
  524. <entry><code>master_files_mode</code></entry>
  525. <entry><code>string</code></entry>
  526. <entry><code>Zend_Cache_Frontend_File::MODE_OR</code></entry>
  527. <entry>
  528. <code>Zend_Cache_Frontend_File::MODE_AND</code> или <code>Zend_Cache_Frontend_File::MODE_OR</code>;
  529. если <code>MODE_AND</code>, то все ведущие файлы должны быть изменены для того, чтобы кэш стал недействительным
  530. если <code>MODE_OR</code>, то достаточно изменения одного ведущего файла, чтобы кэш стал недействительным
  531. </entry>
  532. </row>
  533. <row>
  534. <entry><code>ignore_missing_master_files</code></entry>
  535. <entry><code>boolean</code></entry>
  536. <entry><code>false</code></entry>
  537. <entry>
  538. если равен <code>true</code>, то отсутствующие
  539. ведущие файлы игнорируются, иначе бросается
  540. исключение
  541. </entry>
  542. </row>
  543. </tbody>
  544. </tgroup>
  545. </table>
  546. </sect3>
  547. <sect3 id="zend.cache.frontends.file.examples">
  548. <title>Примеры</title>
  549. <para>
  550. Этот фронтэнд используется так же, как и
  551. <code>Zend_Cache_Core</code>. Специальные примеры не нужны,
  552. единственное, что надо сделать — это указать
  553. <code>masterFile</code> при использовании фабрики.
  554. </para>
  555. </sect3>
  556. </sect2>
  557. <sect2 id="zend.cache.frontends.page">
  558. <title><code>Zend_Cache_Frontend_Page</code></title>
  559. <sect3 id="zend.cache.frontends.page.introduction">
  560. <title>Введение</title>
  561. <para>
  562. <code>Zend_Cache_Frontend_Page</code> похож на
  563. <code>Zend_Cache_Frontend_Output</code>,
  564. но предназначена для кэширования целых страниц.
  565. <code>Zend_Cache_Frontend_Page</code>
  566. нельзя использовать для кэширования отдельных блоков.
  567. </para>
  568. <para>
  569. Идентификатор кэша вычисляется автоматически
  570. с использованием <code>$_SERVER['REQUEST_URI']</code> и
  571. (в зависимости от опций) <code>$_GET</code>,
  572. <code>$_POST</code>, <code>$_SESSION</code>,
  573. <code>$_COOKIE</code>, <code>$_FILES</code>.
  574. Кроме этого, вы используете только один метод для вызова
  575. (<code>start()</code>), потому что <code>end()</code> вызывается
  576. автоматически, когда страница заканчивается.
  577. </para>
  578. <para>
  579. На данный момент мы планируем добавить условную систему HTTP для
  580. сохранения пропускной способности (система будет отправлять
  581. HTTP 304 Not Modified, если есть попадание в кэш и броузер уже
  582. имеет правильную версию страницы).
  583. </para>
  584. </sect3>
  585. <sect3 id="zend.cache.frontends.page.options">
  586. <title>Доступные опции</title>
  587. <table id="zend.cache.frontends.page.options.table">
  588. <title>Опции <code>Zend_Cache_Frontend_Page</code></title>
  589. <tgroup cols="4">
  590. <thead>
  591. <row>
  592. <entry>Опция</entry>
  593. <entry>Тип данных</entry>
  594. <entry>Значение по умолчанию</entry>
  595. <entry>Описание</entry>
  596. </row>
  597. </thead>
  598. <tbody>
  599. <row>
  600. <entry><code>http_conditional</code></entry>
  601. <entry><code>boolean</code></entry>
  602. <entry><code>false</code></entry>
  603. <entry>
  604. Использовать условную систему HTTP (не
  605. реализовано на данный момент)
  606. </entry>
  607. </row>
  608. <row>
  609. <entry><code>debug_header</code></entry>
  610. <entry><code>boolean</code></entry>
  611. <entry><code>false</code></entry>
  612. <entry>
  613. Если установлен в <code>true</code>, то
  614. отладочный текст вставляется перед каждой
  615. кэшируемой страницей.
  616. </entry>
  617. </row>
  618. <row>
  619. <entry><code>default_options</code></entry>
  620. <entry><code>array</code></entry>
  621. <entry><code>array(...смотрите далее...)</code></entry>
  622. <entry>
  623. Ассоциативный массив опций, включаемых по
  624. умолчанию:
  625. <itemizedlist>
  626. <listitem>
  627. <para>
  628. (<code>boolean, true</code> по
  629. умолчанию) <code>cache</code>:
  630. если <code>true</code>, то
  631. кэширование включено
  632. </para>
  633. </listitem>
  634. <listitem>
  635. <para>
  636. (<code>boolean, false</code> по
  637. умолчанию)
  638. <code>cache_with_get_variables</code>:
  639. если <code>true</code>, кэширование
  640. включено, даже если в массиве
  641. <code>$_GET</code> есть переменные
  642. </para>
  643. </listitem>
  644. <listitem>
  645. <para>
  646. (<code>boolean, false</code> по
  647. умолчанию)
  648. <code>cache_with_post_variables</code>:
  649. если <code>true</code>, кэширование
  650. включено, даже если в массиве
  651. <code>$_POST</code> есть переменные
  652. </para>
  653. </listitem>
  654. <listitem>
  655. <para>
  656. (<code>boolean, false</code> по
  657. умолчанию)
  658. <code>cache_with_session_variables</code>:
  659. если <code>true</code>, кэширование
  660. включено, даже если в массиве
  661. <code>$_SESSION</code> есть
  662. переменные
  663. </para>
  664. </listitem>
  665. <listitem>
  666. <para>
  667. (<code>boolean, false</code> по
  668. умолчанию)
  669. <code>cache_with_files_variables</code>:
  670. если <code>true</code>, кэширование
  671. включено, даже если в массиве
  672. <code>$_FILES</code> есть переменные
  673. </para>
  674. </listitem>
  675. <listitem>
  676. <para>
  677. (<code>boolean, false</code> по
  678. умолчанию)
  679. <code>cache_with_cookie_variables</code>:
  680. если <code>true</code>, кэширование
  681. включено, даже если в массиве
  682. <code>$_COOKIE</code> есть
  683. переменные
  684. </para>
  685. </listitem>
  686. <listitem>
  687. <para>
  688. (<code>boolean, true</code> по
  689. умолчанию)
  690. <code>make_id_with_get_variables</code>:
  691. если <code>true</code>, то
  692. идентификатор кэша будет зависеть
  693. от содержимого массива
  694. <code>$_GET</code>
  695. </para>
  696. </listitem>
  697. <listitem>
  698. <para>
  699. (<code>boolean, true</code> по
  700. умолчанию)
  701. <code>make_id_with_post_variables</code>:
  702. если <code>true</code>, то
  703. идентификатор кэша будет зависеть
  704. от содержимого массива
  705. <code>$_POST</code>
  706. </para>
  707. </listitem>
  708. <listitem>
  709. <para>
  710. (<code>boolean, true</code> по
  711. умолчанию)
  712. <code>make_id_with_session_variables</code>:
  713. если <code>true</code>, то
  714. идентификатор кэша будет зависеть
  715. от содержимого массива
  716. <code>$_SESSION</code>
  717. </para>
  718. </listitem>
  719. <listitem>
  720. <para>
  721. (<code>boolean, true</code> по
  722. умолчанию)
  723. <code>make_id_with_files_variables</code>:
  724. если <code>true</code>, то
  725. идентификатор кэша будет зависеть от
  726. содержимого массива
  727. <code>$_FILES</code>
  728. </para>
  729. </listitem>
  730. <listitem>
  731. <para>
  732. (<code>boolean, true</code> по
  733. умолчанию)
  734. <code>make_id_with_cookie_variables</code>:
  735. если <code>true</code>, то
  736. идентификатор кэша будет зависеть от
  737. содержимого массива
  738. <code>$_COOKIE</code>
  739. </para>
  740. </listitem>
  741. <listitem>
  742. <para>
  743. (<code>int, false</code> по
  744. умолчанию)
  745. <code>specific_lifetime</code>:
  746. если не <code>false</code>,
  747. то значение этой опции,
  748. обозначающей время жизни кэша,
  749. будет использоваться для выбранного
  750. регулярного выражения
  751. </para>
  752. </listitem>
  753. <listitem>
  754. <para>
  755. (<code>array, array()</code> по
  756. умолчанию)
  757. <code>tags</code>:
  758. теги для записи в кэше
  759. </para>
  760. </listitem>
  761. <listitem>
  762. <para>
  763. (<code>int, null</code> по
  764. умолчанию)
  765. <code>priority</code>:
  766. приоритет. Действует только
  767. если выбранный бэкэнд поддерживает
  768. приоритеты.
  769. </para>
  770. </listitem>
  771. </itemizedlist>
  772. </entry>
  773. </row>
  774. <row>
  775. <entry><code>regexps</code></entry>
  776. <entry><code>array</code></entry>
  777. <entry><code>array()</code></entry>
  778. <entry>
  779. Ассоциативный массив для установки опций
  780. только для некоторых REQUEST_URI. Ключами
  781. этого массива являются регулярные выражения
  782. (PCRE), значениями — ассоциативные массивы со
  783. специальными опциями, которые устанавливаются,
  784. если $_SERVER['REQUEST_URI']
  785. соответствует регулярному выражению
  786. (см. default_options в этом списке доступных
  787. опций). Если $_SERVER['REQUEST_URI']
  788. соответствует нескольким регулярным
  789. выражениям, то используется только последнее
  790. из них.
  791. </entry>
  792. </row>
  793. <row>
  794. <entry><code>memorize_headers</code></entry>
  795. <entry><code>array</code></entry>
  796. <entry><code>array()</code></entry>
  797. <entry>
  798. Массив строк с именами HTTP-заголовков.
  799. Перечисленные заголовки будут сохранены в
  800. кэше и будут замещены при попадании в кэш.
  801. </entry>
  802. </row>
  803. </tbody>
  804. </tgroup>
  805. </table>
  806. </sect3>
  807. <sect3 id="zend.cache.frontends.page.examples">
  808. <title>Примеры</title>
  809. <para>
  810. Использование <code>Zend_Cache_Frontend_Page</code> довольно
  811. простое:
  812. </para>
  813. <programlisting role="php"><![CDATA[
  814. // [...]
  815. $cache->start();
  816. // если есть попадание в кэш, то результат отправляется броузеру
  817. // и выполнение скрипта на этом прекращается
  818. // остальная часть страницы ...
  819. ]]>
  820. </programlisting>
  821. <para>
  822. Более сложный пример, показывающий способ создания
  823. централизованного управления кэшированием в загрузочном файле
  824. (например, для использования с <code>Zend_Controller</code>).
  825. </para>
  826. <programlisting role="php"><![CDATA[
  827. /*
  828. * Вы должны избегать слишком большого количества строк кода перед этим участком
  829. * кэша. Например, для наибольшей производительности "require_once" или
  830. * "Zend_Loader::loadClass" должны находиться после кэшируемого участка
  831. */
  832. $frontendOptions = array(
  833. 'lifetime' => 7200,
  834. 'debug_header' => true, // для отладки
  835. 'regexps' => array(
  836. // кэширование всего IndexController
  837. '^/$' => array('cache' => true),
  838. // кэширование всего IndexController
  839. '^/index/' => array('cache' => true),
  840. // не кэшируем ArticleController...
  841. '^/article/' => array('cache' => false),
  842. // ...но кэшируем действие "view" контроллера ArticleController
  843. '^/article/view/' => array(
  844. 'cache' => true,
  845. // кэшируем, даже если есть переменные $_POST
  846. 'cache_with_post_variables' => true,
  847. // но кэш будет зависеть от массива $_POST
  848. 'make_id_with_post_variables' => true,
  849. )
  850. )
  851. );
  852. $backendOptions = array(
  853. 'cache_dir' => '/tmp/'
  854. );
  855. // получение объекта Zend_Cache_Frontend_Page
  856. $cache = Zend_Cache::factory('Page',
  857. 'File',
  858. $frontendOptions,
  859. $backendOptions);
  860. $cache->start();
  861. // если есть попадание в кэш, результат отправляется броузеру,
  862. // и выполнение скрипта на этом завершается
  863. // [...] конец загрузочного файла
  864. // (этот код не исполняется, если есть попадание в кэш)
  865. ]]>
  866. </programlisting>
  867. </sect3>
  868. <sect3 id="zend.cache.frontends.page.cancel">
  869. <title>Специальный метод отмены</title>
  870. <para>
  871. В некоторых случаях может потребоваться отменить текущий
  872. процесс кэширования - например, если используется код
  873. возврата, отличный от HTTP/200. Поэтому мы добавили метод
  874. <code>cancel()</code>:
  875. </para>
  876. <programlisting role="php"><![CDATA[
  877. // [...]
  878. $cache->start();
  879. // [...]
  880. if ($someTest) {
  881. $cache->cancel();
  882. // [...]
  883. }
  884. // [...]
  885. ]]>
  886. </programlisting>
  887. </sect3>
  888. </sect2>
  889. </sect1>
  890. <!--
  891. vim:se ts=4 sw=4 et:
  892. -->