Класс Wrong\Memory\Cache

Cache класс, отвечающий за кеширование Подробнее...

Открытые члены
	__construct ($prefix='cache', $type='internal')
	set ($key, $value, $timeout=self::DEFAULT_TIMEOUT)
	get ($key, $timeout=0)
	delete ($key)

Открытые статические члены
static	deleteByPrefix ($prefix)
static	deleteAll ()
static	getSize ()

Поля данных
const	DIR_CACHE = __DIR__ . '/../../../temp/cache'
const	DEFAULT_TIMEOUT = 3600

Закрытые члены
	getFile ($key)
	clean ()

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

Cache класс, отвечающий за кеширование

См. определение в файле Cache.php строка 18

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

__construct()

Wrong\Memory\Cache::__construct	(		$prefix = 'cache',
			$type = 'internal'
	)

Конструктор

Аргументы

string	$prefix	- префикс к именам файлов, на случай установки идентичных ключей для разных хранимых сущностей
string	$type	- тип кеша, пока поддерживается только внутренний кеш системы

См. определение в файле Cache.php строка 34

Методы

clean()

Wrong\Memory\Cache::clean ( )

private

очищает устаревшие файлы кеша и периодически удаляет пустые каталоги кеша.

См. определение в файле Cache.php строка 160

delete()

Wrong\Memory\Cache::delete

(

$key

)

удаляет файл кеша на основе заданного ключа.

Аргументы

int|string

key уникальный идентификатор или ключ, связанный с определенным файлом или данными, которые необходимо удалить.

Возвращает

bool возвращает результат вызова функции rm() класса Path

См. определение в файле Cache.php строка 96

deleteAll()

static Wrong\Memory\Cache::deleteAll ( )

static

очищает весь кеш полностью

См. определение в файле Cache.php строка 121

deleteByPrefix()

static Wrong\Memory\Cache::deleteByPrefix (   $prefix )

static

очищает файлы кеша по указанному префиксу

Аргументы

string

$prefix

строка с префиксом

См. определение в файле Cache.php строка 107

get()

Wrong\Memory\Cache::get	(		$key,
			$timeout = 0
	)

извлекает содержимое файла, если он существует и таймаут кеширования не истек

Аргументы

	string|int	key Ключ — это уникальный идентификатор извлекаемых данных. Он используется для создания имени файла, в котором хранятся данные.
int	$timeout	- если указано, то сверка будет происходить в соответствии с указанным таймаутом(на случай если таймаут был изменен уже после кеширования)

Возвращает

string Если кеша таймаут не истек, то возвращает записанные данные. Иначе ничего не возвращается.

См. определение в файле Cache.php строка 78

getFile()

Wrong\Memory\Cache::getFile (   $key )

private

возвращает путь к файлу на основе заданного ключа с использованием алгоритма MD5.

Аргументы

key	Параметр представляет собой строковое значение, которое используется для создания хэша MD5. Затем этот хэш используется для создания пути к файлу, в котором будут храниться кэшированные данные.

Возвращает

string путь к файлу, созданный на основе предоставленного ключа. Путь к файлу состоит из пути к каталогу кэша, подкаталога, основанного на последних 8 символах хеша MD5 ключа, подкаталога, основанного на последних 4 символах хеша MD5 ключа, и имени файла, который является префикс, объединенный с хешем MD5 ключа

См. определение в файле Cache.php строка 150

getSize()

static Wrong\Memory\Cache::getSize ( )

static

возвращает общий размер каталога кеша

См. определение в файле Cache.php строка 131

set()

Wrong\Memory\Cache::set	(		$key,
			$value,
			$timeout = self::DEFAULT_TIMEOUT
	)

устанавливает значение в файловом кеше с указанным ключом, строкой и временем ожидания.

Аргументы

	string|int	key Ключ — это уникальный идентификатор данных, хранящихся в кэше. Он используется для последующего извлечения данных.
mixed	$value	переменная, которая будет сериализована и записана в файл.
int	$timeout	Параметр тайм-аута — это необязательный параметр, указывающий время в секундах, в течение которого кэшированные данные должны быть действительными. По истечении этого времени кэшированные данные будут считаться просроченными и будут удалены из кэша. Значение по умолчанию для этого параметра устанавливается равным значению константы DEFAULT_TIMEOUT

См. определение в файле Cache.php строка 56

Поля

DEFAULT_TIMEOUT

const Wrong\Memory\Cache::DEFAULT_TIMEOUT = 3600

время кеширования в секундах по умолчанию

См. определение в файле Cache.php строка 24

DIR_CACHE

const Wrong\Memory\Cache::DIR_CACHE = __DIR__ . '/../../../temp/cache'

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

См. определение в файле Cache.php строка 21

---

Объявления и описания членов класса находятся в файле:

• classes/system/Memory/Cache.php