Граф наследования:Manager:

Подробное описание

Класс, содержащий api функции для работы с кэшем

Открытые члены
	__construct ()

	expire ($time)

	tags ($tags=null)

	request ($callback,...$params)

	invalidate ($callback,...$params)

	invalidateAll ()

	getTagsKey ()

	generateKey ($user_key)

	invalidateByTags ($tags)

	validate ($key)

	exists ($key)

	tableIsChanged ($table, $db=DB_NAME)

	tablesIsActual (array $tables, $key)

	normalizeTable ($table)

	watchTables ($tables)

	prepareClass ($class_name)

	tableFilename ($table, $db)

	write ($key, $value)

	read ($key)

Открытые статические члены
static	obj ()

Поля данных
	$cache_table_folder = CACHE_TABLE_FOLDER

	$tags = []

	$before_expire

	$watch_tables = null

	$enabled = CACHE_ENABLED

	$expire = CACHE_TIME

Защищенные члены
	keyByCallback ($callback, $params=[])

	checkTableActual (array $tables, $key)

Защищенные данные
	$cache_folder = CACHE_FOLDER

Конструктор(ы)

__construct ( )

Методы

checkTableActual	(	array	$tables,
			$key
	)

protected

Возвращает true - если все таблицы актуальны

Аргументы

array $tables список таблиц

Возвращает: boolean

exists ( $key )

Проверяет, существует ли кэш

Аргументы

mixed $key ключ

Возвращает: bool - если true, то кэш с таким key существует

expire ( $time )

Устанавливает срок в секундах в течение котороо кэш считается валидным. Сбрасывается после вызова метода request

Аргументы

integer $time - количество секунд хранения кэша

Возвращает: Manager

generateKey ( $user_key )

Генерирует имя ключа с учетом заданных раннее тегов, которое можно использовать в методе read, write.

Аргументы

mixed $user_key - произвольный ключ

Возвращает: string

getTagsKey ( )

Возвращает строку из добавленных ранее тегов, которая может использоваться в имени файла кэш файла

Возвращает: string

invalidate	(	$callback,
		$params
	)

Сбрасывает кэш по заданным параметрам

Аргументы

string \| array	$callback,.	В качестве имени метода допустимо использовать '*', что будет означать - удаление кэша всех методов класса.
	параметр
	параметр	...

Возвращает: void

invalidateAll ( )

Сбрасывает абсолютно весь кэш

Возвращает: void

invalidateByTags ( $tags )

Сбрасывает кэш по тегам

Аргументы

string | array $tags - тег или массив тегов

Возвращает: void

keyByCallback	(	$callback,
		$params = `[]`
	)

protected

Возвращает уникальный идентификатор для функции callback и параметорв

Аргументы

mixed	$callback
mixed	$params

Возвращает: string

normalizeTable ( $table )

Возвращает массив с именем базы данных и именем таблицы.

Аргументы

mixed $table

Возвращает: array of string

static obj ( )

static

Возвращает экземпляр текущего объекта

Возвращает: Manager

prepareClass ( $class_name )

Возвращает специально экранированное имя класса

Аргументы

mixed $class_name

Возвращает: string

read ( $key )

Производит чтение данных с диска

Аргументы

string $key - ключ

Возвращает: mixed

request	(	$callback,
		$params
	)

Выполняет функцию и кэширует ее результаты или возвращает результаты из кэша

Аргументы

callback	$callback
	mixed	параметр
	mixed	параметр ...

Возвращает: mixed результат вызова $callback

tableFilename	(	$table,
		$db
	)

Возвращает имя файла для пары база данных, таблица

Аргументы

mixed	$table
mixed	$db

Возвращает: string

tableIsChanged	(	$table,
		$db = `DB_NAME`
	)

Делает пометку, что таблица изменена

Аргументы

string $table Имя таблицы

Возвращает: void

tablesIsActual	(	array	$tables,
			$key
	)

Делает пометку, что таблица находится в актуальном состоянии

Аргументы

string $table Имя таблицы

Возвращает: void

tags ( $tags = null )

Задает теги, по которым далее можно будет сбросить кэш

Аргументы

string \| array	$tag	тег или список тегов
string	$tag	тег ...

Возвращает: Manager

validate ( $key )

Проверяет, актуален ли кэш.

Аргументы

mixed $key ключ

Возвращает: boolean True - да, кэш можно использовать, False - Кэш не атуален

watchTables ( $tables )

Устанавливает какие таблицы отвечают за актуальность кэша для следующего вызова request

Аргументы

string | \RS\Orm\AbstractObject | array $tables

Возвращает: Manager

write	(	$key,
		$value
	)

Производит запись данных на диск

Аргументы

mixed	$key	- ключ
mixed	$value	- значение

Возвращает: integer - количество записанных байт

Поля

$before_expire

$cache_folder = CACHE_FOLDER

protected

$cache_table_folder = CACHE_TABLE_FOLDER

$enabled = CACHE_ENABLED

$expire = CACHE_TIME

$tags = []

$watch_tables = null

Подробное описание

Открытые члены

Открытые статические члены

Поля данных

Защищенные члены

Защищенные данные

Конструктор(ы)

Методы

Поля