Zend_Cache-Frontends.xml 52 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965
  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. устанавливать <acronym>PHP</acronym>-флаг
  136. ignore_user_abort в методе
  137. save() во избежание порчи кэша в некоторых
  138. случаях.
  139. </entry>
  140. </row>
  141. </tbody>
  142. </tgroup>
  143. </table>
  144. </sect3>
  145. <sect3 id="zend.cache.core.examples">
  146. <title>Примеры</title>
  147. <para>
  148. Пример был дан в самом начале данного раздела руководства.
  149. </para>
  150. <para>
  151. Если вы храните в кэше только строки (с опцией
  152. <emphasis>automatic_serialization</emphasis> возможно хранить некоторые
  153. булевы значения), вы можете использовать более компактную
  154. конструкцию, как показано ниже:
  155. </para>
  156. <programlisting language="php"><![CDATA[
  157. // предполагается, что переменная $cache уже установлена
  158. $id = 'myBigLoop'; // идентификатор того, что мы хотим закэшировать
  159. if (!($data = $cache->load($id))) {
  160. // промах кэша
  161. $data = '';
  162. for ($i = 0; $i < 10000; $i++) {
  163. $data = $data . $i;
  164. }
  165. $cache->save($data);
  166. }
  167. // [...] делаем что-либо с данными (отображение, передача и т.д.)
  168. ]]></programlisting>
  169. <para>
  170. Если вы хотите закэшировать несколько блоков или экземпляров
  171. данных, то принцип будет тот же:
  172. </para>
  173. <programlisting language="php"><![CDATA[
  174. // убедитесь, что используете уникальные идентификаторы:
  175. $id1 = 'foo';
  176. $id2 = 'bar';
  177. // блок 1
  178. if (!($data = $cache->load($id1))) {
  179. // промах кэша
  180. $data = '';
  181. for ($i=0;$i<10000;$i++) {
  182. $data = $data . $i;
  183. }
  184. $cache->save($data);
  185. }
  186. echo($data);
  187. // эта часть не кэшируется
  188. echo('НЕ КЭШИРУЕТСЯ! ');
  189. // блок 2
  190. if (!($data = $cache->load($id2))) {
  191. // промах кэша
  192. $data = '';
  193. for ($i=0;$i<10000;$i++) {
  194. $data = $data . '!';
  195. }
  196. $cache->save($data);
  197. }
  198. echo($data);]]></programlisting>
  199. <para>
  200. Если вы хотите кэшировать специальные значения (булево
  201. значение через опцию "automatic_serialization") или пустую
  202. строку, то компактная форма, приведенная выше, уже не
  203. подходит. Проверка на наличие записи кэша должна производиться
  204. созданным для этого методом.
  205. </para>
  206. <programlisting language="php"><![CDATA[
  207. // Копмпактная форма. Не подходит, если могут кэшироваться
  208. // пустые строки и значения булевого типа
  209. if (!($data = $cache->load($id))) {
  210. // промах кэша
  211. // [...] получаем данные и присваиваем их переменной $data
  212. $cache->save($data);
  213. }
  214. // делаем что-либо с данными
  215. // [...]
  216. // Полная форма, будет работать в любом случае
  217. if (!($cache->test($id))) {
  218. // промах кэша
  219. // [...] получаем данные и присваиваем их переменной $data
  220. $cache->save($data);
  221. } else {
  222. // попадание в кэш
  223. $data = $cache->load($id);
  224. }
  225. // делаем что-либо с данными
  226. ]]></programlisting>
  227. </sect3>
  228. </sect2>
  229. <sect2 id="zend.cache.frontends.output">
  230. <title>Zend_Cache_Frontend_Output</title>
  231. <sect3 id="zend.cache.frontends.output.introduction">
  232. <title>Введение</title>
  233. <para>
  234. <classname>Zend_Cache_Frontend_Output</classname> является фронтэндом,
  235. собирающим выходные данные. Он использует буферизацию вывода
  236. (output buffering) в <acronym>PHP</acronym> для сохранения
  237. всего, что выводится между его методами
  238. <methodname>start()</methodname> и <methodname>end()</methodname>.
  239. </para>
  240. </sect3>
  241. <sect3 id="zend.cache.frontends.output.options">
  242. <title>Доступные опции</title>
  243. <para>
  244. Этот фронтэнд не имеет каких-либо специальных опций, отличных
  245. от опций <classname>Zend_Cache_Core</classname>.
  246. </para>
  247. </sect3>
  248. <sect3 id="zend.cache.frontends.output.examples">
  249. <title>Примеры</title>
  250. <para>
  251. Пример был дан в самом начале данного руководства. Здесь
  252. он с небольшими изменениями:
  253. </para>
  254. <programlisting language="php"><![CDATA[
  255. // если имеет место промах кэша,
  256. // то начинается буферизация вывода
  257. if (!($cache->start('mypage'))) {
  258. // все выводится, как обычно
  259. echo 'Hello world! ';
  260. echo 'This is cached ('.time().') ';
  261. $cache->end(); // завершение буферизации вывода
  262. }
  263. echo 'This is never cached ('.time().').';
  264. ]]></programlisting>
  265. <para>
  266. Используя эту форму, довольно легко установить кэширование
  267. вывода в уже работающем проекте с незначительным рефакторингом
  268. кода или совсем без него.
  269. </para>
  270. </sect3>
  271. </sect2>
  272. <sect2 id="zend.cache.frontends.function">
  273. <title>Zend_Cache_Frontend_Function</title>
  274. <sect3 id="zend.cache.frontends.function.introduction">
  275. <title>Введение</title>
  276. <para>
  277. <classname>Zend_Cache_Frontend_Function</classname> сохраняет в кэш
  278. результаты вызова функции. Он имеет единственный основной метод
  279. <methodname>call()</methodname>, который принимает имя функции и параметры
  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>Опции Zend_Cache_Frontend_Function</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><emphasis>cache_by_default</emphasis></entry>
  299. <entry><type>Boolean</type></entry>
  300. <entry><constant>TRUE</constant></entry>
  301. <entry>
  302. Если равен true, то вызовы функции по
  303. умолчанию кэшируются.
  304. </entry>
  305. </row>
  306. <row>
  307. <entry><emphasis>cached_functions</emphasis></entry>
  308. <entry><type>Array</type></entry>
  309. <entry></entry>
  310. <entry>
  311. Имена функций, которые всегда кэшируются.
  312. </entry>
  313. </row>
  314. <row>
  315. <entry><emphasis>non_cached_functions</emphasis></entry>
  316. <entry><type>Array</type></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. Функция <methodname>call()</methodname> используется так же, как и
  331. <methodname>call_user_func_array()</methodname> в
  332. <acronym>PHP</acronym>:
  333. </para>
  334. <programlisting language="php"><![CDATA[
  335. $cache->call('veryExpensiveFunc', $params);
  336. // $params является массивом
  337. // Например, если нужно вызвать с кэшированием
  338. // veryExpensiveFunc(1, 'foo', 'bar'),
  339. // то вы должны использовать
  340. // $cache->call('veryExpensiveFunc', array(1, 'foo', 'bar'))
  341. ]]></programlisting>
  342. <para>
  343. <classname>Zend_Cache_Frontend_Function</classname> достаточно
  344. интеллектуален, чтобы кэшировать как возвращаемое функцией
  345. значение, так и данные, выводимые внутри нее.
  346. </para>
  347. <note>
  348. <para>
  349. Вы можете передавать любые как встроенные, так и
  350. определенные пользователем функции, за исключением
  351. <methodname>array()</methodname>,
  352. <methodname>echo()</methodname>, <methodname>empty()</methodname>,
  353. <methodname>eval()</methodname>, <methodname>exit()</methodname>,
  354. <methodname>isset()</methodname>, <methodname>list()</methodname>,
  355. <methodname>print()</methodname> и <methodname>unset()</methodname>.
  356. </para>
  357. </note>
  358. </sect3>
  359. </sect2>
  360. <sect2 id="zend.cache.frontends.class">
  361. <title>Zend_Cache_Frontend_Class</title>
  362. <sect3 id="zend.cache.frontends.class.introduction">
  363. <title>Введение</title>
  364. <para>
  365. <classname>Zend_Cache_Frontend_Class</classname> отличается от
  366. <classname>Zend_Cache_Frontend_Function</classname> тем, что позволяет
  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>Опции Zend_Cache_Frontend_Class</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><emphasis>cached_entity</emphasis> (required)</entry>
  386. <entry><type>Mixed</type></entry>
  387. <entry></entry>
  388. <entry>
  389. Если установлен как имя класса, то будет
  390. кэшироваться абстрактный класс и будут
  391. использоваться только статические вызовы; если
  392. установлен как объект,
  393. то будут кэшироваться методы объекта.
  394. </entry>
  395. </row>
  396. <row>
  397. <entry><emphasis>cache_by_default</emphasis></entry>
  398. <entry><type>Boolean</type></entry>
  399. <entry><constant>TRUE</constant></entry>
  400. <entry>
  401. Если установлен в <constant>TRUE</constant>, то вызовы
  402. будут кэшироваться по умолчанию.
  403. </entry>
  404. </row>
  405. <row>
  406. <entry><emphasis>cached_methods</emphasis></entry>
  407. <entry><type>Array</type></entry>
  408. <entry></entry>
  409. <entry>
  410. Имена методов, которые должны всегда
  411. кэшироваться.
  412. </entry>
  413. </row>
  414. <row>
  415. <entry><emphasis>non_cached_methods</emphasis></entry>
  416. <entry><type>Array</type></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 language="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. ]]></programlisting>
  448. <para>
  449. Кэширование обычных вызовов методов:
  450. </para>
  451. <programlisting language="php"><![CDATA[
  452. class Test {
  453. private $_string = 'hello !';
  454. public function foobar2($param1, $param2) {
  455. echo($this->_string);
  456. echo "foobar2_output($param1, $param2)";
  457. return "foobar2_return($param1, $param2)";
  458. }
  459. }
  460. // [...]
  461. $frontendOptions = array(
  462. 'cached_entity' => new Test() // экземпляр класса
  463. );
  464. // [...]
  465. // Кэшируемый вызов
  466. $result = $cache->foobar2('1', '2');
  467. ]]></programlisting>
  468. </sect3>
  469. </sect2>
  470. <sect2 id="zend.cache.frontends.file">
  471. <title>Zend_Cache_Frontend_File</title>
  472. <sect3 id="zend.cache.frontends.file.introduction">
  473. <title>Введение</title>
  474. <para>
  475. <classname>Zend_Cache_Frontend_File</classname> является фронтэндом,
  476. который управляется временем изменения "ведущего файла".
  477. Он очень полезен для кэширования конфигураций или шаблонов.
  478. Можно использовать несколько ведущих файлов.
  479. </para>
  480. <para>
  481. Например, у вас есть конфигурационный файл
  482. <acronym>XML</acronym>. Он парсится
  483. функцией, которая возвращает объект конфигурации
  484. (наподобие <classname>Zend_Config</classname>). С помощью
  485. <classname>Zend_Cache_Frontend_File</classname> вы можете сохранять объект
  486. конфигурации в кэш, чтобы избежать повторного парсинга
  487. конфигурационного файла <acronym>XML</acronym>. Время жизни
  488. кэша будет зависеть от ведущего файла - если конфигурационный
  489. файл <acronym>XML</acronym> изменится, то кэш сразу становится
  490. недействительным.
  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>Опции Zend_Cache_Frontend_File</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><emphasis>master_file</emphasis>
  509. (не рекомендуется к использованию)</entry>
  510. <entry><type>String</type></entry>
  511. <entry>''</entry>
  512. <entry>
  513. Полные путь и имя ведущего файла
  514. </entry>
  515. </row>
  516. <row>
  517. <entry><emphasis>master_files</emphasis></entry>
  518. <entry><type>Array</type></entry>
  519. <entry><methodname>array()</methodname></entry>
  520. <entry>
  521. Массив полных путей к ведущим файлам
  522. </entry>
  523. </row>
  524. <row>
  525. <entry><emphasis>master_files_mode</emphasis></entry>
  526. <entry><type>String</type></entry>
  527. <entry><constant>Zend_Cache_Frontend_File::MODE_OR</constant></entry>
  528. <entry>
  529. <constant>Zend_Cache_Frontend_File::MODE_AND</constant> или <constant>Zend_Cache_Frontend_File::MODE_OR</constant>;
  530. если <constant>MODE_AND</constant>, то все ведущие файлы должны быть изменены для того, чтобы кэш стал недействительным
  531. если <constant>MODE_OR</constant>, то достаточно изменения одного ведущего файла, чтобы кэш стал недействительным
  532. </entry>
  533. </row>
  534. <row>
  535. <entry><emphasis>ignore_missing_master_files</emphasis></entry>
  536. <entry><type>Boolean</type></entry>
  537. <entry><constant>FALSE</constant></entry>
  538. <entry>
  539. если равен <constant>TRUE</constant>, то отсутствующие
  540. ведущие файлы игнорируются, иначе бросается
  541. исключение
  542. </entry>
  543. </row>
  544. </tbody>
  545. </tgroup>
  546. </table>
  547. </sect3>
  548. <sect3 id="zend.cache.frontends.file.examples">
  549. <title>Примеры</title>
  550. <para>
  551. Этот фронтэнд используется так же, как и
  552. <classname>Zend_Cache_Core</classname>. Специальные примеры не нужны,
  553. единственное, что надо сделать — это указать
  554. <emphasis>masterFile</emphasis> при использовании фабрики.
  555. </para>
  556. </sect3>
  557. </sect2>
  558. <sect2 id="zend.cache.frontends.page">
  559. <title>Zend_Cache_Frontend_Page</title>
  560. <sect3 id="zend.cache.frontends.page.introduction">
  561. <title>Введение</title>
  562. <para>
  563. <classname>Zend_Cache_Frontend_Page</classname> похож на
  564. <classname>Zend_Cache_Frontend_Output</classname>,
  565. но предназначена для кэширования целых страниц.
  566. <classname>Zend_Cache_Frontend_Page</classname>
  567. нельзя использовать для кэширования отдельных блоков.
  568. </para>
  569. <para>
  570. Идентификатор кэша вычисляется автоматически
  571. с использованием <varname>$_SERVER['REQUEST_URI']</varname> и
  572. (в зависимости от опций) <varname>$_GET</varname>,
  573. <varname>$_POST</varname>, <varname>$_SESSION</varname>,
  574. <varname>$_COOKIE</varname>, <varname>$_FILES</varname>.
  575. Кроме этого, вы используете только один метод для вызова
  576. (<methodname>start()</methodname>), потому что
  577. <methodname>end()</methodname> вызывается
  578. автоматически, когда страница заканчивается.
  579. </para>
  580. <para>
  581. На данный момент мы планируем добавить условную систему
  582. <acronym>HTTP</acronym> для
  583. сохранения пропускной способности (система будет отправлять
  584. <acronym>HTTP</acronym> 304 Not Modified, если есть попадание
  585. в кэш и броузер уже имеет правильную версию страницы).
  586. </para>
  587. </sect3>
  588. <sect3 id="zend.cache.frontends.page.options">
  589. <title>Доступные опции</title>
  590. <table id="zend.cache.frontends.page.options.table">
  591. <title>Опции Zend_Cache_Frontend_Page</title>
  592. <tgroup cols="4">
  593. <thead>
  594. <row>
  595. <entry>Опция</entry>
  596. <entry>Тип данных</entry>
  597. <entry>Значение по умолчанию</entry>
  598. <entry>Описание</entry>
  599. </row>
  600. </thead>
  601. <tbody>
  602. <row>
  603. <entry><emphasis>http_conditional</emphasis></entry>
  604. <entry><type>Boolean</type></entry>
  605. <entry><constant>FALSE</constant></entry>
  606. <entry>
  607. Использовать условную систему HTTP (не
  608. реализовано на данный момент)
  609. </entry>
  610. </row>
  611. <row>
  612. <entry><emphasis>debug_header</emphasis></entry>
  613. <entry><type>Boolean</type></entry>
  614. <entry><constant>FALSE</constant></entry>
  615. <entry>
  616. Если установлен в <constant>TRUE</constant>, то
  617. отладочный текст вставляется перед каждой
  618. кэшируемой страницей.
  619. </entry>
  620. </row>
  621. <row>
  622. <entry><emphasis>default_options</emphasis></entry>
  623. <entry><type>Array</type></entry>
  624. <entry><methodname>array(...смотрите далее...)</methodname></entry>
  625. <entry>
  626. Ассоциативный массив опций, включаемых по
  627. умолчанию:
  628. <itemizedlist>
  629. <listitem>
  630. <para>
  631. (<emphasis>boolean, true</emphasis> по
  632. умолчанию) <emphasis>cache</emphasis>:
  633. если <constant>TRUE</constant>, то
  634. кэширование включено
  635. </para>
  636. </listitem>
  637. <listitem>
  638. <para>
  639. (<emphasis>boolean, false</emphasis> по
  640. умолчанию)
  641. <emphasis>cache_with_get_variables</emphasis>:
  642. если <constant>TRUE</constant>, кэширование
  643. включено, даже если в массиве
  644. <varname>$_GET</varname> есть переменные
  645. </para>
  646. </listitem>
  647. <listitem>
  648. <para>
  649. (<emphasis>boolean, false</emphasis> по
  650. умолчанию)
  651. <emphasis>cache_with_post_variables</emphasis>:
  652. если <constant>TRUE</constant>, кэширование
  653. включено, даже если в массиве
  654. <varname>$_POST</varname> есть переменные
  655. </para>
  656. </listitem>
  657. <listitem>
  658. <para>
  659. (<emphasis>boolean, false</emphasis> по
  660. умолчанию)
  661. <emphasis>cache_with_session_variables</emphasis>:
  662. если <constant>TRUE</constant>, кэширование
  663. включено, даже если в массиве
  664. <varname>$_SESSION</varname> есть
  665. переменные
  666. </para>
  667. </listitem>
  668. <listitem>
  669. <para>
  670. (<emphasis>boolean, false</emphasis> по
  671. умолчанию)
  672. <emphasis>cache_with_files_variables</emphasis>:
  673. если <constant>TRUE</constant>, кэширование
  674. включено, даже если в массиве
  675. <varname>$_FILES</varname> есть переменные
  676. </para>
  677. </listitem>
  678. <listitem>
  679. <para>
  680. (<emphasis>boolean, false</emphasis> по
  681. умолчанию)
  682. <emphasis>cache_with_cookie_variables</emphasis>:
  683. если <constant>TRUE</constant>, кэширование
  684. включено, даже если в массиве
  685. <varname>$_COOKIE</varname> есть
  686. переменные
  687. </para>
  688. </listitem>
  689. <listitem>
  690. <para>
  691. (<emphasis>boolean, true</emphasis> по
  692. умолчанию)
  693. <emphasis>make_id_with_get_variables</emphasis>:
  694. если <constant>TRUE</constant>, то
  695. идентификатор кэша будет зависеть
  696. от содержимого массива
  697. <varname>$_GET</varname>
  698. </para>
  699. </listitem>
  700. <listitem>
  701. <para>
  702. (<emphasis>boolean, true</emphasis> по
  703. умолчанию)
  704. <emphasis>make_id_with_post_variables</emphasis>:
  705. если <constant>TRUE</constant>, то
  706. идентификатор кэша будет зависеть
  707. от содержимого массива
  708. <varname>$_POST</varname>
  709. </para>
  710. </listitem>
  711. <listitem>
  712. <para>
  713. (<emphasis>boolean, true</emphasis> по
  714. умолчанию)
  715. <emphasis>make_id_with_session_variables</emphasis>:
  716. если <constant>TRUE</constant>, то
  717. идентификатор кэша будет зависеть
  718. от содержимого массива
  719. <varname>$_SESSION</varname>
  720. </para>
  721. </listitem>
  722. <listitem>
  723. <para>
  724. (<emphasis>boolean, true</emphasis> по
  725. умолчанию)
  726. <emphasis>make_id_with_files_variables</emphasis>:
  727. если <constant>TRUE</constant>, то
  728. идентификатор кэша будет зависеть от
  729. содержимого массива
  730. <varname>$_FILES</varname>
  731. </para>
  732. </listitem>
  733. <listitem>
  734. <para>
  735. (<emphasis>boolean, true</emphasis> по
  736. умолчанию)
  737. <emphasis>make_id_with_cookie_variables</emphasis>:
  738. если <constant>TRUE</constant>, то
  739. идентификатор кэша будет зависеть от
  740. содержимого массива
  741. <varname>$_COOKIE</varname>
  742. </para>
  743. </listitem>
  744. <listitem>
  745. <para>
  746. (<emphasis>int, false</emphasis> по
  747. умолчанию)
  748. <emphasis>specific_lifetime</emphasis>:
  749. если не <constant>FALSE</constant>,
  750. то значение этой опции,
  751. обозначающей время жизни кэша,
  752. будет использоваться для выбранного
  753. регулярного выражения
  754. </para>
  755. </listitem>
  756. <listitem>
  757. <para>
  758. (<emphasis>array, array()</emphasis> по
  759. умолчанию)
  760. <emphasis>tags</emphasis>:
  761. теги для записи в кэше
  762. </para>
  763. </listitem>
  764. <listitem>
  765. <para>
  766. (<emphasis>int, null</emphasis> по
  767. умолчанию)
  768. <emphasis>priority</emphasis>:
  769. приоритет. Действует только
  770. если выбранный бэкэнд поддерживает
  771. приоритеты.
  772. </para>
  773. </listitem>
  774. </itemizedlist>
  775. </entry>
  776. </row>
  777. <row>
  778. <entry><emphasis>regexps</emphasis></entry>
  779. <entry><type>Array</type></entry>
  780. <entry><methodname>array()</methodname></entry>
  781. <entry>
  782. Ассоциативный массив для установки опций
  783. только для некоторых
  784. <acronym>REQUEST_URI</acronym>. Ключами
  785. этого массива являются регулярные выражения
  786. (<acronym>PCRE</acronym>), значениями —
  787. ассоциативные массивы со
  788. специальными опциями, которые устанавливаются,
  789. если <varname>$_SERVER['REQUEST_URI']</varname>
  790. соответствует регулярному выражению
  791. (см. default_options в этом списке доступных
  792. опций). Если <varname>$_SERVER['REQUEST_URI']</varname>
  793. соответствует нескольким регулярным
  794. выражениям, то используется только последнее
  795. из них.
  796. </entry>
  797. </row>
  798. <row>
  799. <entry><emphasis>memorize_headers</emphasis></entry>
  800. <entry><type>Array</type></entry>
  801. <entry><methodname>array()</methodname></entry>
  802. <entry>
  803. Массив строк с именами
  804. <acronym>HTTP</acronym>-заголовков.
  805. Перечисленные заголовки будут сохранены в
  806. кэше и будут замещены при попадании в кэш.
  807. </entry>
  808. </row>
  809. </tbody>
  810. </tgroup>
  811. </table>
  812. </sect3>
  813. <sect3 id="zend.cache.frontends.page.examples">
  814. <title>Примеры</title>
  815. <para>
  816. Использование <classname>Zend_Cache_Frontend_Page</classname> довольно
  817. простое:
  818. </para>
  819. <programlisting language="php"><![CDATA[
  820. // [...]
  821. $cache->start();
  822. // если есть попадание в кэш, то результат отправляется броузеру
  823. // и выполнение скрипта на этом прекращается
  824. // остальная часть страницы ...
  825. ]]></programlisting>
  826. <para>
  827. Более сложный пример, показывающий способ создания
  828. централизованного управления кэшированием в загрузочном файле
  829. (например, для использования с <classname>Zend_Controller</classname>).
  830. </para>
  831. <programlisting language="php"><![CDATA[
  832. /*
  833. * Вы должны избегать слишком большого количества строк кода перед этим участком
  834. * кэша. Например, для наибольшей производительности "require_once" или
  835. * "Zend_Loader::loadClass" должны находиться после кэшируемого участка
  836. */
  837. $frontendOptions = array(
  838. 'lifetime' => 7200,
  839. 'debug_header' => true, // для отладки
  840. 'regexps' => array(
  841. // кэширование всего IndexController
  842. '^/$' => array('cache' => true),
  843. // кэширование всего IndexController
  844. '^/index/' => array('cache' => true),
  845. // не кэшируем ArticleController...
  846. '^/article/' => array('cache' => false),
  847. // ...но кэшируем действие "view" контроллера ArticleController
  848. '^/article/view/' => array(
  849. 'cache' => true,
  850. // кэшируем, даже если есть переменные $_POST
  851. 'cache_with_post_variables' => true,
  852. // но кэш будет зависеть от массива $_POST
  853. 'make_id_with_post_variables' => true,
  854. )
  855. )
  856. );
  857. $backendOptions = array(
  858. 'cache_dir' => '/tmp/'
  859. );
  860. // получение объекта Zend_Cache_Frontend_Page
  861. $cache = Zend_Cache::factory('Page',
  862. 'File',
  863. $frontendOptions,
  864. $backendOptions);
  865. $cache->start();
  866. // если есть попадание в кэш, результат отправляется броузеру,
  867. // и выполнение скрипта на этом завершается
  868. // [...] конец загрузочного файла
  869. // (этот код не исполняется, если есть попадание в кэш)
  870. ]]></programlisting>
  871. </sect3>
  872. <sect3 id="zend.cache.frontends.page.cancel">
  873. <title>Отмена кэширования</title>
  874. <para>
  875. В некоторых случаях может потребоваться отменить текущий
  876. процесс кэширования - например, если используется код
  877. возврата, отличный от <acronym>HTTP</acronym> 200. Поэтому
  878. мы добавили метод <methodname>cancel()</methodname>:
  879. </para>
  880. <programlisting language="php"><![CDATA[
  881. // [...]
  882. $cache->start();
  883. // [...]
  884. if ($someTest) {
  885. $cache->cancel();
  886. // [...]
  887. }
  888. // [...]
  889. ]]></programlisting>
  890. </sect3>
  891. </sect2>
  892. </sect1>
  893. <!--
  894. vim:se ts=4 sw=4 et:
  895. -->