FilesystemAdapter
class FilesystemAdapter extends AbstractAdapter implements PruneableInterface
Свойства
| FilesystemTrait | |
| FilesystemCommonTrait | |
| AbstractTrait | |
| LoggerAwareTrait |
Свойства
| protected int|null | $maxIdLength | из AbstractTrait |
Методы
| array|Traversable | doFetch(array $ids) Извлекает несколько элементов кэша. | из AbstractTrait |
| bool | doHave(string $id) Проверяет, содержит ли кэш указанный элемент кэша. | из AbstractTrait |
| bool | doClear(string $namespace) Удаляет все элементы в пуле. | из AbstractTrait |
| bool | doDelete(array $ids) Удаляет несколько элементов из пула. | из AbstractTrait |
| array|bool | doSave(array $values, int $lifetime) Непосредственно сохраняет несколько элементов кэша. | из AbstractTrait |
| hasItem($key) {@inheritdoc} | из AbstractTrait | |
| clear() {@inheritdoc} | из AbstractTrait | |
| deleteItem($key) {@inheritdoc} | из AbstractTrait | |
| deleteItems(array $keys) {@inheritdoc} | из AbstractTrait | |
| bool | enableVersioning(bool $enable = true) Включает/отключает версионирование элементов. | из AbstractTrait |
| reset() {@inheritdoc} | из AbstractTrait | |
| static mixed | unserialize(string $value) Аналогично функции native unserialize(), но выбрасывает исключение, если что-то идет не так. | из AbstractTrait |
| static | handleUnserializeCallback($class) | из AbstractTrait |
| __construct(string $namespace = '', int $defaultLifetime = 0, string $directory = null) | ||
| static AdapterInterface | createSystemCache(string $namespace, int $defaultLifetime, string $version, string $directory, LoggerInterface $logger = null) | из AbstractAdapter |
| static | createConnection($dsn, array $options = array()) | из AbstractAdapter |
| CacheItem | getItem($key) {@inheritdoc} | из AbstractAdapter |
| Traversable|CacheItem[] | getItems(array $keys = array()) {@inheritdoc} | из AbstractAdapter |
| save(CacheItemInterface $item) {@inheritdoc} | из AbstractAdapter | |
| saveDeferred(CacheItemInterface $item) {@inheritdoc} | из AbstractAdapter | |
| commit() {@inheritdoc} | из AbstractAdapter | |
| __destruct() | из FilesystemCommonTrait | |
| static | throwError($type, $message, $file, $line) | из FilesystemCommonTrait |
| bool | prune() | из FilesystemTrait |
Детали
abstract protected array|Traversable doFetch(array $ids)
Извлекает несколько элементов кэша.
Параметры
| array | $ids | Идентификаторы элементов кэша для извлечения |
Возвращаемое значение
| array|Traversable | Соответствующие значения, найденные в кэше |
abstract protected bool doHave(string $id)
Проверяет, содержит ли кэш указанный элемент.
Параметры
| string | $id | Идентификатор для проверки существования |
Возвращаемое значение
| bool | True, если элемент существует в кэше, иначе false |
abstract protected bool doClear(string $namespace)
Удаляет все элементы из пула.
Параметры
| string | $namespace | Префикс, используемый для всех идентификаторов, управляемых этим пулом |
Возвращаемое значение
| bool | True, если пул был успешно очищен, иначе false |
abstract protected bool doDelete(array $ids)
Удаляет несколько элементов из пула.
Параметры
| array | $ids | Массив идентификаторов, которые должны быть удалены из пула |
Возвращаемое значение
| bool | True, если элементы были успешно удалены, иначе false |
abstract protected array|bool doSave(array $values, int $lifetime)
Немедленно сохраняет несколько элементов кэша.
Параметры
| array | $values | Значения для кэширования, индексированные по их идентификаторам кэша |
| int | $lifetime | Срок хранения кэшированных значений, 0 для сохранения до ручного удаления |
Возвращаемое значение
| array|bool | Идентификаторы, которые не удалось кэшировать, или boolean, указывающий, удалось ли кэширование |
hasItem($key)
{@inheritdoc}
Параметры
| $key |
clear()
{@inheritdoc}
deleteItem($key)
{@inheritdoc}
Параметры
| $key |
deleteItems(array $keys)
{@inheritdoc}
Параметры
| array | $keys |
bool enableVersioning(bool $enable = true)
Включает/выключает версионирование элементов.
При включенном версионировании очистка кэша атомарна и не требует перечисления существующих ключей, но старые ключи могут потребовать сборки мусора, а также дополнительных обращений к бэкенду.
Вызов этого метода также очищает кешированный номер версии пространства имен, что заставляет его перезапуститься.
Параметры
| bool | $enable |
Возвращаемое значение
| bool | предыдущее состояние версионирования |
reset()
{@inheritdoc}
static protected mixed unserialize(string $value)
Аналогично функции native unserialize(), но выбрасывает исключение, если что-то пойдёт не так.
Параметры
| string | $value |
Возвращаемое значение
| mixed |
Исключения
| Exception |
static handleUnserializeCallback($class)
Параметры
| $class |
__construct(string $namespace = '', int $defaultLifetime = 0, string $directory = null)
Параметры
| string | $namespace | |
| int | $defaultLifetime | |
| string | $directory |
static AdapterInterface createSystemCache(string $namespace, int $defaultLifetime, string $version, string $directory, LoggerInterface $logger = null)
Параметры
| string | $namespace | |
| int | $defaultLifetime | |
| string | $version | |
| string | $directory | |
| LoggerInterface | $logger |
Возвращаемое значение
| AdapterInterface |
static createConnection($dsn, array $options = array())
Параметры
| $dsn | ||
| array | $options |
CacheItem getItem($key)
{@inheritdoc}
Параметры
| $key |
Возвращаемое значение
| CacheItem |
Traversable|CacheItem[] getItems(array $keys = array())
{@inheritdoc}
Параметры
| array | $keys |
Возвращаемое значение
| Traversable|CacheItem[] |
save(CacheItemInterface $item)
{@inheritdoc}
Параметры
| CacheItemInterface | $item |
saveDeferred(CacheItemInterface $item)
{@inheritdoc}
Параметры
| CacheItemInterface | $item |
commit()
{@inheritdoc}
__destruct()
static throwError($type, $message, $file, $line)
Параметры
| $type | ||
| $message | ||
| $file | ||
| $line |
bool prune()
Возвращаемое значение
| bool |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/Cache/Adapter/FilesystemAdapter.html