2
0

Zend_Cache-Frontends.xml 52 KB

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