iiifx-production/yii2-folder-dependency

Folder dependency for Yii2 framework

Yii2 Folder Dependency

FolderDependency - дополнительная зависимость для фреймворка Yii2, которая позволяет сбрасывать кэш при обнаружении изменений папки или содержащихся в ней файлов., _(*1)

![Build Status][ico-travis] ![Software License][ico-license] , _(*2)

Установка

Используя Composer:, _(*3)

``` bash $ composer require iiifx-production/yii2-folder-dependency, <sub>(*4)</sub>

или добавить в composer.json, в секцию require:

``` json
    "iiifx-production/yii2-folder-dependency": "0.1.*@stable"

Использование

``` php use iiifx\cache\dependency\FolderDependency;, <sub>(*5)</sub>

$cache = Yii::$app->cache;, <sub>(*6)</sub>

Проверяем наличие кэша

if ( ( $cachedData = $cache->get( 'some-cache-key' ) ) === FALSE ) {, <sub>(*7)</sub>

# Кэша нет, подготавливаем данные
$cachedData = [ /* .. */ ];

# Создаем зависимость для кэша
$folderDependency = new FolderDependency( [
    'folder' => '/path/to/folder'
] );

# Кэшируем данные
$cache->set( 'some-cache-key', $cachedData, 0, $folderDependency );

}, <sub>(*8)</sub>

Пользуемся данными

var_export( $cachedData );, <sub>(*9)</sub>

В данном примере кэш будет создан при первом запросе. При последующих запросах будут использоваться закэшариванные данные, пока папка folder или размещенные в ней файлы не изменятся. Любое изменение файла внутри folder будет обнаружено и кэш потеряет свою актуальность.
Не имеет значения какое количество файлов будет содержать folder, это никак не повлияет на производительность. Зависимость проверяет лишь папку, не затрагивая файлы, который в ней содержаться.


Для создания зависимости от нескольких папок пути можно передать списком:

``` php
$foldersDependency = new FolderDependency( [
    'folder' => [
        '/path/to/folder1',
        '/path/to/folder2',
        '/path/to/folder3',
    ]
] );

В этом случае кэш потеряет свою актуальность при изменении любой папки или любого файла внутри папок., <sub>(*10)</sub>

!!! Важно !!!

Зависимость не обнаружит изменения во вложенных папках, которые размещены внутри указанных в folder., <sub>(*11)</sub>

Флаг reusable по умолчанию установлен в TRUE., <sub>(*12)</sub>

Тесты

В данный момент не реализованы., <sub>(*13)</sub>

Лизценция

![Software License][ico-license], <sub>(*14)</sub>

, <sub>(*15)</sub>