Класс CacheHelper
CacheHelper помогает создать кэширование полных страниц.
При использовании CacheHelper вы не вызываете его методы, они все автоматически вызываются View и используют настройки $cacheAction, установленные в контроллере.
- AppHelper
-
CacheHelper
Ссылка: https://book.cakephp.org/2.0/ru/core-libraries/helpers/cache.html
Устаревший:
Этот класс будет удален в версии 3.0. Вы должны использовать отдельный кэш ответов, например, Varnish.
Авторские права: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/View/Helper/CacheHelper.php
Краткое описание свойств
-
$_counterprotectedСчётчик, используемый для подсчёта тегов раздела nocache.integer -
$_matchprotectedarrayМассив строк, которые заменяются на переменные выше. Строки — это любое содержимое внутри
<!--nocache--><!--/nocache-->, и они включают теги в представлениях. -
$_replaceprotectedarrayМассив строк, заменяемых в кэшированных представлениях. Строки находятся между
<!--nocache--><!--/nocache-->в представлениях.
Краткое описание методов
- _enabled() protectedВключён ли CacheHelper? Должны ли файлы + вывод быть обработаны.
- _parseContent() protected
Обработка файла + вывода. Сопоставляет теги nocache между текущим выводом и текущим файлом, сохраняет ссылку на файл, чтобы сгенерированное содержимое можно было вернуть в исходный файл при записи файла кэша.
- _parseFile() protectedОбработка файла, поиск тегов nocache
- _parseOutput() protectedОбработка вывода и замена тегов кэша
- _replaceSection() protected
Изменяет вывод из представления с тегами кэша и нумерует разделы. Это помогает решить проблемы с пустым/дублированным содержимым.
- _stripTags() protected
Удаляет теги cake:nocache из строки. Так как View::render() удаляет только не пронумерованные теги nocache, удалите все пронумерованные. Это дополнение к _replaceSection.
- _writeFile() protectedЗапись кэшированной версии файла
- afterLayout() publicОбрабатывает файл макета и сохраняет содержимое для создания файла кэша.
- afterRenderFile() publicОбрабатывает файл представления и сохраняет содержимое для создания файла кэша.
- cache() publicОсновной метод для кэширования представления
Подробное описание методов
_enabled()source protected
_enabled( )
Включён ли CacheHelper? Должны ли файлы + вывод быть обработаны.
Возвращает
boolean_parseContent()source protected
_parseContent( string $file , string $out )
Обработка файла + вывода. Сопоставляет теги nocache между текущим выводом и текущим файлом, сохраняет ссылку на файл, чтобы сгенерированное содержимое можно было вернуть в исходный файл при записи файла кэша.
Параметры
- string
$file - Имя файла для обработки.
- string
$out - Вывод для файла.
Возвращает
stringОбновлённое содержимое.
_parseFile()source protected
_parseFile( string $file , string $cache )
Обработка файла, поиск тегов nocache
Параметры
- string
$file - Имя файла, который требуется обработать.
- string
$cache - Кэшированное содержимое
_parseOutput()source protected
_parseOutput( string $cache )
Обработка вывода и замена тегов кэша
Параметры
- string
$cache - Вывод для замены содержимого.
Возвращает
stringсо всеми выполненными заменами в
_replaceSection()source protected
_replaceSection( )
Изменяет вывод из представления с тегами кэша и нумерует разделы. Это помогает решить проблемы с пустым/дублированным содержимым.
Возвращает
stringСодержимое с заменёнными тегами cake:nocache.
_stripTags()source protected
_stripTags( string $content )
Удаляет теги cake:nocache из строки. Так как View::render() удаляет только не пронумерованные теги nocache, удалите все пронумерованные. Это дополнение к _replaceSection.
Параметры
- string
$content - Строка для удаления тегов.
Возвращает
stringСтрока с удалёнными тегами.
_writeFile()source protected
_writeFile( string $content , string $timestamp , boolean|null $useCallbacks false )
Запись кэшированной версии файла
Параметры
- string
$content - содержимое представления для записи в файл кэша.
- string
$timestamp - Срок действия для файла кэша.
- boolean|null
$useCallbacksнеобязательно false Включать ли в кэшированный файл операторы, которые выполняют обратные вызовы, иначе null.
Возвращает
booleanУспешность кэширования представления.
afterLayout()source public
afterLayout( string $layoutFile )
Обрабатывает файл макета и сохраняет содержимое для создания файла кэша.
Параметры
- string
$layoutFile - Имя файла макета.
afterRenderFile()source public
afterRenderFile( string $viewFile , string $output )
Обрабатывает файл представления и сохраняет содержимое для создания файла кэша.
Параметры
- string
$viewFile - Имя файла представления.
- string
$output - Вывод для файла.
Возвращает
stringОбновлённое содержимое.
cache()source public
cache( string $file , string $out )
Основной метод для кэширования представления
Параметры
- string
$file - Файл для кэширования
- string
$out - Вывод для кэширования
Возвращает
stringВывод представления
Исключения
ExceptionЕсли режим отладки включён и запись в файл кэша не удалась.
Ссылка
https://book.cakephp.org/2.0/ru/core-libraries/helpers/cache.htmlПодробное описание свойств
$_matchsource
protected массив
Массив строк, которые заменяются на переменные выше. Строки — это любое содержимое внутри <!--nocache--><!--/nocache-->, и они включают теги в представлениях
array()
$_replacesource
protected массив
Массив строк, заменённых в кэшированных представлениях. Строки находятся между <!--nocache--><!--/nocache--> в представлениях
array()
© 2005–2017 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/2.10/class-CacheHelper.html