Download the PHP package ngsoft/cache without Composer

On this page you can find all versions of the php package ngsoft/cache. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package cache

Documentation

Table of Contents

Method Description
ApcuDriver
ApcuDriver::isSupported
ApcuDriver::__construct
ApcuDriver::clear
ApcuDriver::delete
ApcuDriver::getCacheEntry
ApcuDriver::has
ApcuDriver::__debugInfo
ArrayDriver
ArrayDriver::__construct
ArrayDriver::clear {@inheritdoc}
ArrayDriver::purge Removes expired item entries if supported
ArrayDriver::delete {@inheritdoc}
ArrayDriver::getCacheEntry {@inheritdoc}
ArrayDriver::has {@inheritdoc}
ArrayDriver::__debugInfo
Cache
Cache::invalidateTags Invalidates cached items using tags.
Cache::purge Removes expired item entries if supported
Cache::get Fetches a value from the pool or computes it if not found.
Cache::increment Increment the value of an item in the cache.
Cache::decrement Decrement the value of an item in the cache.
Cache::add Adds data if it doesn't already exists
Cache::clear {@inheritdoc}
Cache::commit {@inheritdoc}
Cache::deleteItem {@inheritdoc}
Cache::deleteItems {@inheritdoc}
Cache::getItem {@inheritdoc}
Cache::getItems {@inheritdoc}
Cache::hasItem {@inheritdoc}
Cache::save {@inheritdoc}
Cache::saveDeferred {@inheritdoc}
Cache::lock {@inheritdoc}
Cache::setPrefix Change cache prefix
Cache::getDriver Access Cache driver directly
Cache::invalidate Increase prefix version, invalidating all prefixed entries
CacheEntry
CacheEntry::__construct
CacheEntry::getCacheItem
CacheEntry::isHit
CacheEntry::create
CacheEntry::createEmpty
CacheEntry::__serialize
CacheEntry::__unserialize
CacheEntry::__toString
CacheError
CacheEvent
CacheEvent::__construct
CacheEvent::getCachePool
CacheHit
CacheHit::__construct
CacheItem A Cache Item
CacheItem::validateKey
CacheItem::create
CacheItem::__construct
CacheItem::tag Adds a tag to a cache item.
CacheItem::getMetadata Returns a list of metadata info that were saved alongside with the cached value.
CacheItem::expiresAfter {@inheritdoc}
CacheItem::expiresAt {@inheritdoc}
CacheItem::get {@inheritdoc}
CacheItem::getKey {@inheritdoc}
CacheItem::isHit {@inheritdoc}
CacheItem::set {@inheritdoc}
CacheItem::__clone {@inheritdoc}
CacheItem::__debugInfo
CacheMiss
CachePool A PSR-6 cache pool
CachePool::__construct
CachePool::__destruct
CachePool::__debugInfo
CachePool::setLogger
CachePool::invalidateTags Invalidates cached items using tags.
CachePool::purge Removes expired item entries if supported
CachePool::get Fetches a value from the pool or computes it if not found.
CachePool::increment Increment the value of an item in the cache.
CachePool::decrement Decrement the value of an item in the cache.
CachePool::add Adds data if it doesn't already exists
CachePool::clear {@inheritdoc}
CachePool::commit {@inheritdoc}
CachePool::deleteItem {@inheritdoc}
CachePool::deleteItems {@inheritdoc}
CachePool::getItem {@inheritdoc}
CachePool::getItems {@inheritdoc}
CachePool::hasItem {@inheritdoc}
CachePool::save {@inheritdoc}
CachePool::saveDeferred {@inheritdoc}
CachePool::lock {@inheritdoc}
ChainDriver
ChainDriver::__construct
ChainDriver::setDefaultLifetime set the default ttl
ChainDriver::count
ChainDriver::getIterator
ChainDriver::getReverseIterator
ChainDriver::set Persists data in the cache
ChainDriver::purge Removes expired item entries if supported
ChainDriver::clear
ChainDriver::delete
ChainDriver::getCacheEntry
ChainDriver::has
ChainDriver::__debugInfo
DoctrineCacheProvider
DoctrineCacheProvider::__construct
DoctrineCacheProvider::getNamespace
DoctrineCacheProvider::setNamespace
DoctrineCacheProvider::setLogger {@inheritdoc}
DoctrineCacheProvider::contains {@inheritdoc}
DoctrineCacheProvider::delete {@inheritdoc}
DoctrineCacheProvider::fetch {@inheritdoc}
DoctrineCacheProvider::save {@inheritdoc}
DoctrineCacheProvider::deleteAll {@inheritdoc}
DoctrineCacheProvider::flushAll {@inheritdoc}
DoctrineCacheProvider::deleteMultiple {@inheritdoc}
DoctrineCacheProvider::fetchMultiple {@inheritdoc}
DoctrineCacheProvider::saveMultiple {@inheritdoc}
DoctrineCacheProvider::getStats
DoctrineDriver
DoctrineDriver::__construct
DoctrineDriver::clear
DoctrineDriver::delete
DoctrineDriver::getCacheEntry
DoctrineDriver::has
DoctrineDriver::__debugInfo
FileCache
FileCache::invalidateTags Invalidates cached items using tags.
FileCache::purge Removes expired item entries if supported
FileCache::get Fetches a value from the pool or computes it if not found.
FileCache::increment Increment the value of an item in the cache.
FileCache::decrement Decrement the value of an item in the cache.
FileCache::add Adds data if it doesn't already exists
FileCache::clear {@inheritdoc}
FileCache::commit {@inheritdoc}
FileCache::deleteItem {@inheritdoc}
FileCache::deleteItems {@inheritdoc}
FileCache::getItem {@inheritdoc}
FileCache::getItems {@inheritdoc}
FileCache::hasItem {@inheritdoc}
FileCache::save {@inheritdoc}
FileCache::saveDeferred {@inheritdoc}
FileCache::lock {@inheritdoc}
FileCache::setPrefix Change cache prefix
FileCache::getDriver Access Cache driver directly
FileCache::invalidate Increase prefix version, invalidating all prefixed entries
FileDriver The oldest cache driver that store binary datas
FileDriver::onWindows
FileDriver::__construct
FileDriver::__destruct
FileDriver::purge Removes expired item entries if supported
FileDriver::clear
FileDriver::delete
FileDriver::getCacheEntry
FileDriver::has
FileDriver::__debugInfo
IlluminateDriver
IlluminateDriver::__construct
IlluminateDriver::clear
IlluminateDriver::delete
IlluminateDriver::getCacheEntry
IlluminateDriver::has
IlluminateDriver::__debugInfo
InvalidArgument
JsonDriver A driver that can be used for Cli applicationsCan store data inside a json config file for example
JsonDriver::__construct
JsonDriver::purge Removes expired item entries if supported
JsonDriver::clear
JsonDriver::delete
JsonDriver::getCacheEntry
JsonDriver::has
JsonDriver::count
JsonDriver::__debugInfo
KeyDeleted
KeySaved
KeySaved::__construct
LaravelStore
LaravelStore::__construct
LaravelStore::setLogger {@inheritdoc}
LaravelStore::increment {@inheritdoc}
LaravelStore::decrement {@inheritdoc}
LaravelStore::flush {@inheritdoc}
LaravelStore::forever {@inheritdoc}
LaravelStore::forget {@inheritdoc}
LaravelStore::get {@inheritdoc}
LaravelStore::getPrefix {@inheritdoc}
LaravelStore::many {@inheritdoc}
LaravelStore::put {@inheritdoc}
LaravelStore::putMany {@inheritdoc}
NullDriver
NullDriver::clear
NullDriver::delete
NullDriver::getCacheEntry
NullDriver::has
PDOAdapter
PDOAdapter::__construct
PDOAdapter::read
PDOAdapter::query
PHPCache A preconfigured cache poolChains ArrayDriver, ApcuDriver, PhpDriver
PHPCache::__construct
PHPCache::appendDriver Put a driver at the end of the chain
PHPCache::prependDriver Put a driver at the beginning of the chain
PhpDriver
PhpDriver::opCacheSupported
PhpDriver::onWindows
PhpDriver::__construct
PhpDriver::__destruct
PhpDriver::purge Removes expired item entries if supported
PhpDriver::clear
PhpDriver::delete
PhpDriver::getCacheEntry
PhpDriver::has
PhpDriver::__debugInfo
PSR16Driver
PSR16Driver::__construct
PSR16Driver::clear
PSR16Driver::delete
PSR16Driver::getCacheEntry
PSR16Driver::has
PSR16Driver::__debugInfo
PSR6Driver
PSR6Driver::__construct
PSR6Driver::getCacheEntry
PSR6Driver::clear
PSR6Driver::delete
PSR6Driver::has
PSR6Driver::__debugInfo
ReactCache
ReactCache::__construct
ReactCache::setLogger {@inheritdoc}
ReactCache::increment Increment the value of an item in the cache.
ReactCache::decrement Decrement the value of an item in the cache.
ReactCache::add Adds data if it doesn't already exists
ReactCache::clear {@inheritdoc}
ReactCache::delete {@inheritdoc}
ReactCache::has {@inheritdoc}
ReactCache::get {@inheritdoc}
ReactCache::set {@inheritdoc}
ReactCache::deleteMultiple {@inheritdoc}
ReactCache::getMultiple {@inheritdoc}
ReactCache::setMultiple {@inheritdoc}
SimpleCachePool PSR-6 to PSR-16 Adapter
SimpleCachePool::__construct
SimpleCachePool::getCachePool {@inheritdoc}
SimpleCachePool::increment Increment the value of an item in the cache.
SimpleCachePool::decrement Decrement the value of an item in the cache.
SimpleCachePool::add Adds data if it doesn't already exists
SimpleCachePool::clear {@inheritdoc}
SimpleCachePool::delete {@inheritdoc}
SimpleCachePool::deleteMultiple {@inheritdoc}
SimpleCachePool::get {@inheritdoc}
SimpleCachePool::getMultiple {@inheritdoc}
SimpleCachePool::has {@inheritdoc}
SimpleCachePool::set {@inheritdoc}
SimpleCachePool::setMultiple {@inheritdoc}
SimpleCachePool::__debugInfo
SQLite3Adapter
SQLite3Adapter::__construct
SQLite3Adapter::read
SQLite3Adapter::query
Sqlite3Driver
Sqlite3Driver::__construct
Sqlite3Driver::purge Removes expired item entries if supported
Sqlite3Driver::clear
Sqlite3Driver::delete
Sqlite3Driver::getCacheEntry
Sqlite3Driver::has
Sqlite3Driver::__debugInfo

ApcuDriver

ApcuDriver::isSupported

Return Value:


ApcuDriver::__construct

Return Value:


ApcuDriver::clear

Return Value:


ApcuDriver::delete

Parameters:

Parameter Type Description
key string

Return Value:


ApcuDriver::getCacheEntry

Parameters:

Parameter Type Description
key string

Return Value:


ApcuDriver::has

Parameters:

Parameter Type Description
key string

Return Value:


ApcuDriver::__debugInfo

Return Value:


ArrayDriver

ArrayDriver::__construct

Parameters:

Parameter Type Description
size int

Return Value:


ArrayDriver::clear

{@inheritdoc}

Return Value:


ArrayDriver::purge

Removes expired item entries if supported

Return Value:


ArrayDriver::delete

{@inheritdoc}

Parameters:

Parameter Type Description
key string

Return Value:


ArrayDriver::getCacheEntry

{@inheritdoc}

Parameters:

Parameter Type Description
key string

Return Value:


ArrayDriver::has

{@inheritdoc}

Parameters:

Parameter Type Description
key string

Return Value:


ArrayDriver::__debugInfo

Return Value:


Cache

Cache::invalidateTags

Invalidates cached items using tags.

When implemented on a PSR-6 pool, invalidation should not apply to deferred items. Instead, they should be committed as usual. This allows replacing old tagged values by new ones without race conditions.

Parameter Type Description
tags string[]|string An array of tags to invalidate

Return Value:

True on success


Cache::purge

Removes expired item entries if supported

Return Value:


Cache::get

Fetches a value from the pool or computes it if not found.

Parameter Type Description
key string
default mixed|\Closure if set the item will be saved with that value

Return Value:


Cache::increment

Increment the value of an item in the cache.

Parameter Type Description
key string
value int

Return Value:


Cache::decrement

Decrement the value of an item in the cache.

Parameter Type Description
key string
value int

Return Value:


Cache::add

Adds data if it doesn't already exists

Parameter Type Description
key string
value mixed|\Closure

Return Value:

True if the data have been added, false otherwise


Cache::clear

{@inheritdoc}

Return Value:


Cache::commit

{@inheritdoc}

Return Value:


Cache::deleteItem

{@inheritdoc}

Parameter Type Description
key string

Return Value:


Cache::deleteItems

{@inheritdoc}

Parameter Type Description
keys array

Return Value:


Cache::getItem

{@inheritdoc}

Parameter Type Description
key string

Return Value:


Cache::getItems

{@inheritdoc}

Parameter Type Description
keys array

Return Value:


Cache::hasItem

{@inheritdoc}

Parameter Type Description
key string

Return Value:


Cache::save

{@inheritdoc}

Parameter Type Description
item \Psr\Cache\CacheItemInterface

Return Value:


Cache::saveDeferred

{@inheritdoc}

Parameter Type Description
item \Psr\Cache\CacheItemInterface

Return Value:


Cache::lock

{@inheritdoc}

Parameter Type Description
name string
seconds int|float
owner string

Return Value:


Cache::setPrefix

Change cache prefix

Parameter Type Description
prefix string

Return Value:


Cache::getDriver

Access Cache driver directly

Return Value:


Cache::invalidate

Increase prefix version, invalidating all prefixed entries

Return Value:


CacheEntry

CacheEntry::__construct

Parameters:

Parameter Type Description
key string
expiry int
value mixed
tags array

Return Value:


CacheEntry::getCacheItem

Parameters:

Parameter Type Description
key string

Return Value:


CacheEntry::isHit

Return Value:


CacheEntry::create

Parameter Type Description
key string
expiry int
value mixed
tags array

Return Value:


CacheEntry::createEmpty

Parameter Type Description
key string

Return Value:


CacheEntry::__serialize

Return Value:


CacheEntry::__unserialize

Parameters:

Parameter Type Description
data array

Return Value:


CacheEntry::__toString

Return Value:


CacheError

CacheEvent

CacheEvent::__construct

Parameters:

Parameter Type Description
cachePool \Psr\Cache\CacheItemPoolInterface
key string

Return Value:


CacheEvent::getCachePool

Return Value:


CacheHit

CacheHit::__construct

Parameters:

Parameter Type Description
cachePool \Psr\Cache\CacheItemPoolInterface
key string
value mixed

Return Value:


CacheItem

A Cache Item

CacheItem::validateKey

Parameter Type Description
key mixed

Return Value:


CacheItem::create

Parameter Type Description
key string
metadata ?array

Return Value:


CacheItem::__construct

Parameters:

Parameter Type Description
key string
metadata ?array

Return Value:


CacheItem::tag

Adds a tag to a cache item.

Parameters:

Parameter Type Description
tags string|iterable A tag or array of tags

Return Value:


CacheItem::getMetadata

Returns a list of metadata info that were saved alongside with the cached value.

Return Value:


CacheItem::expiresAfter

{@inheritdoc}

Parameters:

Parameter Type Description
time int|\DateInterval|null

Return Value:


CacheItem::expiresAt

{@inheritdoc}

Parameters:

Parameter Type Description
expiration ?\DateTimeInterface

Return Value:


CacheItem::get

{@inheritdoc}

Return Value:


CacheItem::getKey

{@inheritdoc}

Return Value:


CacheItem::isHit

{@inheritdoc}

Return Value:


CacheItem::set

{@inheritdoc}

Parameters:

Parameter Type Description
value mixed

Return Value:


CacheItem::__clone

{@inheritdoc}

Return Value:


CacheItem::__debugInfo

Return Value:


CacheMiss

CachePool

A PSR-6 cache pool

CachePool::__construct

Parameters:

Parameter Type Description
driver \NGSOFT\Cache\Interfaces\CacheDriver
prefix string
defaultLifetime int
logger ?\Psr\Log\LoggerInterface
eventDispatcher ?\Psr\EventDispatcher\EventDispatcherInterface

Return Value:


CachePool::__destruct

Return Value:


CachePool::__debugInfo

Return Value:


CachePool::setLogger

Parameters:

Parameter Type Description
logger \Psr\Log\LoggerInterface

Return Value:


CachePool::invalidateTags

Invalidates cached items using tags.

When implemented on a PSR-6 pool, invalidation should not apply to deferred items. Instead, they should be committed as usual. This allows replacing old tagged values by new ones without race conditions.

Parameters:

Parameter Type Description
tags string[]|string An array of tags to invalidate

Return Value:

True on success


CachePool::purge

Removes expired item entries if supported

Return Value:


CachePool::get

Fetches a value from the pool or computes it if not found.

Parameters:

Parameter Type Description
key string
default mixed|\Closure if set the item will be saved with that value

Return Value:


CachePool::increment

Increment the value of an item in the cache.

Parameters:

Parameter Type Description
key string
value int

Return Value:


CachePool::decrement

Decrement the value of an item in the cache.

Parameters:

Parameter Type Description
key string
value int

Return Value:


CachePool::add

Adds data if it doesn't already exists

Parameters:

Parameter Type Description
key string
value mixed|\Closure

Return Value:

True if the data have been added, false otherwise


CachePool::clear

{@inheritdoc}

Return Value:


CachePool::commit

{@inheritdoc}

Return Value:


CachePool::deleteItem

{@inheritdoc}

Parameters:

Parameter Type Description
key string

Return Value:


CachePool::deleteItems

{@inheritdoc}

Parameters:

Parameter Type Description
keys array

Return Value:


CachePool::getItem

{@inheritdoc}

Parameters:

Parameter Type Description
key string

Return Value:


CachePool::getItems

{@inheritdoc}

Parameters:

Parameter Type Description
keys array

Return Value:


CachePool::hasItem

{@inheritdoc}

Parameters:

Parameter Type Description
key string

Return Value:


CachePool::save

{@inheritdoc}

Parameters:

Parameter Type Description
item \Psr\Cache\CacheItemInterface

Return Value:


CachePool::saveDeferred

{@inheritdoc}

Parameters:

Parameter Type Description
item \Psr\Cache\CacheItemInterface

Return Value:


CachePool::lock

{@inheritdoc}

Parameters:

Parameter Type Description
name string
seconds int|float
owner string

Return Value:


ChainDriver

ChainDriver::__construct

Parameters:

Parameter Type Description
drivers iterable

Return Value:


ChainDriver::setDefaultLifetime

set the default ttl

Parameters:

Parameter Type Description
defaultLifetime int

Return Value:


ChainDriver::count

Return Value:


ChainDriver::getIterator

Return Value:


ChainDriver::getReverseIterator

Parameters:

Parameter Type Description
current ?int

Return Value:


ChainDriver::set

Persists data in the cache

Parameters:

Parameter Type Description
key string
value mixed
ttl ?int a value of 0 never expires, a null value uses the default value set in the driver
tags string|array

Return Value:


ChainDriver::purge

Removes expired item entries if supported

Return Value:


ChainDriver::clear

Return Value:


ChainDriver::delete

Parameters:

Parameter Type Description
key string

Return Value:


ChainDriver::getCacheEntry

Parameters:

Parameter Type Description
key string

Return Value:


ChainDriver::has

Parameters:

Parameter Type Description
key string

Return Value:


ChainDriver::__debugInfo

Return Value:


DoctrineCacheProvider

DoctrineCacheProvider::__construct

Parameters:

Parameter Type Description
driver \NGSOFT\Cache\Interfaces\CacheDriver
prefix string
defaultLifetime int

Return Value:


DoctrineCacheProvider::getNamespace

Return Value:


DoctrineCacheProvider::setNamespace

Parameters:

Parameter Type Description
namespace mixed

Return Value:


DoctrineCacheProvider::setLogger

{@inheritdoc}

Parameters:

Parameter Type Description
logger \Psr\Log\LoggerInterface

Return Value:


DoctrineCacheProvider::contains

{@inheritdoc}

Parameters:

Parameter Type Description
id mixed

Return Value:


DoctrineCacheProvider::delete

{@inheritdoc}

Parameters:

Parameter Type Description
id mixed

Return Value:


DoctrineCacheProvider::fetch

{@inheritdoc}

Parameters:

Parameter Type Description
id mixed

Return Value:


DoctrineCacheProvider::save

{@inheritdoc}

Parameters:

Parameter Type Description
id mixed
data mixed
lifeTime mixed

Return Value:


DoctrineCacheProvider::deleteAll

{@inheritdoc}

Return Value:


DoctrineCacheProvider::flushAll

{@inheritdoc}

Return Value:


DoctrineCacheProvider::deleteMultiple

{@inheritdoc}

Parameters:

Parameter Type Description
keys array

Return Value:


DoctrineCacheProvider::fetchMultiple

{@inheritdoc}

Parameters:

Parameter Type Description
keys array

Return Value:


DoctrineCacheProvider::saveMultiple

{@inheritdoc}

Parameters:

Parameter Type Description
keysAndValues array
lifetime mixed

Return Value:


DoctrineCacheProvider::getStats

Return Value:


DoctrineDriver

DoctrineDriver::__construct

Parameters:

Parameter Type Description
provider \Doctrine\Common\Cache\CacheProvider

Return Value:


DoctrineDriver::clear

Return Value:


DoctrineDriver::delete

Parameters:

Parameter Type Description
key string

Return Value:


DoctrineDriver::getCacheEntry

Parameters:

Parameter Type Description
key string

Return Value:


DoctrineDriver::has

Parameters:

Parameter Type Description
key string

Return Value:


DoctrineDriver::__debugInfo

Return Value:


FileCache

FileCache::invalidateTags

Invalidates cached items using tags.

When implemented on a PSR-6 pool, invalidation should not apply to deferred items. Instead, they should be committed as usual. This allows replacing old tagged values by new ones without race conditions.

Parameter Type Description
tags string[]|string An array of tags to invalidate

Return Value:

True on success


FileCache::purge

Removes expired item entries if supported

Return Value:


FileCache::get

Fetches a value from the pool or computes it if not found.

Parameter Type Description
key string
default mixed|\Closure if set the item will be saved with that value

Return Value:


FileCache::increment

Increment the value of an item in the cache.

Parameter Type Description
key string
value int

Return Value:


FileCache::decrement

Decrement the value of an item in the cache.

Parameter Type Description
key string
value int

Return Value:


FileCache::add

Adds data if it doesn't already exists

Parameter Type Description
key string
value mixed|\Closure

Return Value:

True if the data have been added, false otherwise


FileCache::clear

{@inheritdoc}

Return Value:


FileCache::commit

{@inheritdoc}

Return Value:


FileCache::deleteItem

{@inheritdoc}

Parameter Type Description
key string

Return Value:


FileCache::deleteItems

{@inheritdoc}

Parameter Type Description
keys array

Return Value:


FileCache::getItem

{@inheritdoc}

Parameter Type Description
key string

Return Value:


FileCache::getItems

{@inheritdoc}

Parameter Type Description
keys array

Return Value:


FileCache::hasItem

{@inheritdoc}

Parameter Type Description
key string

Return Value:


FileCache::save

{@inheritdoc}

Parameter Type Description
item \Psr\Cache\CacheItemInterface

Return Value:


FileCache::saveDeferred

{@inheritdoc}

Parameter Type Description
item \Psr\Cache\CacheItemInterface

Return Value:


FileCache::lock

{@inheritdoc}

Parameter Type Description
name string
seconds int|float
owner string

Return Value:


FileCache::setPrefix

Change cache prefix

Parameter Type Description
prefix string

Return Value:


FileCache::getDriver

Access Cache driver directly

Return Value:


FileCache::invalidate

Increase prefix version, invalidating all prefixed entries

Return Value:


FileDriver

The oldest cache driver that store binary datas

FileDriver::onWindows

Return Value:


FileDriver::__construct

Parameters:

Parameter Type Description
root string
prefix string

Return Value:


FileDriver::__destruct

Return Value:


FileDriver::purge

Removes expired item entries if supported

Return Value:


FileDriver::clear

Return Value:


FileDriver::delete

Parameters:

Parameter Type Description
key string

Return Value:


FileDriver::getCacheEntry

Parameters:

Parameter Type Description
key string

Return Value:


FileDriver::has

Parameters:

Parameter Type Description
key string

Return Value:


FileDriver::__debugInfo

Return Value:


IlluminateDriver

IlluminateDriver::__construct

Parameters:

Parameter Type Description
provider \Illuminate\Contracts\Cache\Store

Return Value:


IlluminateDriver::clear

Return Value:


IlluminateDriver::delete

Parameters:

Parameter Type Description
key string

Return Value:


IlluminateDriver::getCacheEntry

Parameters:

Parameter Type Description
key string

Return Value:


IlluminateDriver::has

Parameters:

Parameter Type Description
key string

Return Value:


IlluminateDriver::__debugInfo

Return Value:


InvalidArgument

JsonDriver

A driver that can be used for Cli applications Can store data inside a json config file for example

JsonDriver::__construct

Parameters:

Parameter Type Description
file string|\NGSOFT\Filesystem\File
key string Key to use inside the object

Return Value:


JsonDriver::purge

Removes expired item entries if supported

Return Value:


JsonDriver::clear

Return Value:


JsonDriver::delete

Parameters:

Parameter Type Description
key string

Return Value:


JsonDriver::getCacheEntry

Parameters:

Parameter Type Description
key string

Return Value:


JsonDriver::has

Parameters:

Parameter Type Description
key string

Return Value:


JsonDriver::count

Return Value:


JsonDriver::__debugInfo

Return Value:


KeyDeleted

KeySaved

KeySaved::__construct

Parameters:

Parameter Type Description
cachePool \Psr\Cache\CacheItemPoolInterface
key string
value mixed

Return Value:


LaravelStore

LaravelStore::__construct

Parameters:

Parameter Type Description
driver \NGSOFT\Cache\Interfaces\CacheDriver
prefix string
defaultLifetime int

Return Value:


LaravelStore::setLogger

{@inheritdoc}

Parameters:

Parameter Type Description
logger \Psr\Log\LoggerInterface

Return Value:


LaravelStore::increment

{@inheritdoc}

Parameters:

Parameter Type Description
key mixed
value mixed

Return Value:


LaravelStore::decrement

{@inheritdoc}

Parameters:

Parameter Type Description
key mixed
value mixed

Return Value:


LaravelStore::flush

{@inheritdoc}

Return Value:


LaravelStore::forever

{@inheritdoc}

Parameters:

Parameter Type Description
key mixed
value mixed

Return Value:


LaravelStore::forget

{@inheritdoc}

Parameters:

Parameter Type Description
key mixed

Return Value:


LaravelStore::get

{@inheritdoc}

Parameters:

Parameter Type Description
key mixed

Return Value:


LaravelStore::getPrefix

{@inheritdoc}

Return Value:


LaravelStore::many

{@inheritdoc}

Parameters:

Parameter Type Description
keys array

Return Value:


LaravelStore::put

{@inheritdoc}

Parameters:

Parameter Type Description
key mixed
value mixed
seconds mixed

Return Value:


LaravelStore::putMany

{@inheritdoc}

Parameters:

Parameter Type Description
values array
seconds mixed

Return Value:


NullDriver

NullDriver::clear

Return Value:


NullDriver::delete

Parameters:

Parameter Type Description
key string

Return Value:


NullDriver::getCacheEntry

Parameters:

Parameter Type Description
key string

Return Value:


NullDriver::has

Parameters:

Parameter Type Description
key string

Return Value:


PDOAdapter

PDOAdapter::__construct

Parameters:

Parameter Type Description
driver \PDO
table string

Return Value:


PDOAdapter::read

Parameters:

Parameter Type Description
key string
data bool

Return Value:


PDOAdapter::query

Parameters:

Parameter Type Description
query string

Return Value:


PHPCache

A preconfigured cache pool Chains ArrayDriver, ApcuDriver, PhpDriver

PHPCache::__construct

Parameters:

Parameter Type Description
rootpath string
prefix string
defaultLifetime int
logger ?\Psr\Log\LoggerInterface
eventDispatcher ?\Psr\EventDispatcher\EventDispatcherInterface

Return Value:


PHPCache::appendDriver

Put a driver at the end of the chain

Parameters:

Parameter Type Description
driver \NGSOFT\Cache\Interfaces\CacheDriver

Return Value:


PHPCache::prependDriver

Put a driver at the beginning of the chain

Parameters:

Parameter Type Description
driver \NGSOFT\Cache\Interfaces\CacheDriver

Return Value:


PhpDriver

PhpDriver::opCacheSupported

Return Value:


PhpDriver::onWindows

Return Value:


PhpDriver::__construct

Parameters:

Parameter Type Description
root string
prefix string

Return Value:


PhpDriver::__destruct

Return Value:


PhpDriver::purge

Removes expired item entries if supported

Return Value:


PhpDriver::clear

Return Value:


PhpDriver::delete

Parameters:

Parameter Type Description
key string

Return Value:


PhpDriver::getCacheEntry

Parameters:

Parameter Type Description
key string

Return Value:


PhpDriver::has

Parameters:

Parameter Type Description
key string

Return Value:


PhpDriver::__debugInfo

Return Value:


PSR16Driver

PSR16Driver::__construct

Parameters:

Parameter Type Description
provider \Psr\SimpleCache\CacheInterface

Return Value:


PSR16Driver::clear

Return Value:


PSR16Driver::delete

Parameters:

Parameter Type Description
key string

Return Value:


PSR16Driver::getCacheEntry

Parameters:

Parameter Type Description
key string

Return Value:


PSR16Driver::has

Parameters:

Parameter Type Description
key string

Return Value:


PSR16Driver::__debugInfo

Return Value:


PSR6Driver

PSR6Driver::__construct

Parameters:

Parameter Type Description
provider \Psr\Cache\CacheItemPoolInterface

Return Value:


PSR6Driver::getCacheEntry

Parameters:

Parameter Type Description
key string

Return Value:


PSR6Driver::clear

Return Value:


PSR6Driver::delete

Parameters:

Parameter Type Description
key string

Return Value:


PSR6Driver::has

Parameters:

Parameter Type Description
key string

Return Value:


PSR6Driver::__debugInfo

Return Value:


ReactCache

ReactCache::__construct

Parameters:

Parameter Type Description
driver \NGSOFT\Cache\Interfaces\CacheDriver
prefix string
defaultLifetime int

Return Value:


ReactCache::setLogger

{@inheritdoc}

Parameters:

Parameter Type Description
logger \Psr\Log\LoggerInterface

Return Value:


ReactCache::increment

Increment the value of an item in the cache.

Parameters:

Parameter Type Description
key string
value int

Return Value:

new value


ReactCache::decrement

Decrement the value of an item in the cache.

Parameters:

Parameter Type Description
key string
value int

Return Value:

new value


ReactCache::add

Adds data if it doesn't already exists

ReactCache::add( string key, mixed|\Closure value ): \React\Promise\PromiseInterface<bool>

Parameters:

Parameter Type Description
key string
value mixed|\Closure

Return Value:

True if the data have been added, false otherwise


ReactCache::clear

{@inheritdoc}

ReactCache::clear(  ): \React\Promise\PromiseInterface

Return Value:


ReactCache::delete

{@inheritdoc}

ReactCache::delete( mixed key ): \React\Promise\PromiseInterface

Parameters:

Parameter Type Description
key mixed

Return Value:


ReactCache::has

{@inheritdoc}

ReactCache::has( mixed key ): \React\Promise\PromiseInterface

Parameters:

Parameter Type Description
key mixed

Return Value:


ReactCache::get

{@inheritdoc}

ReactCache::get( mixed key, mixed default = null ): \React\Promise\PromiseInterface

Parameters:

Parameter Type Description
key mixed
default mixed

Return Value:


ReactCache::set

{@inheritdoc}

ReactCache::set( mixed key, mixed value, mixed ttl = null ): \React\Promise\PromiseInterface

Parameters:

Parameter Type Description
key mixed
value mixed
ttl mixed

Return Value:


ReactCache::deleteMultiple

{@inheritdoc}

ReactCache::deleteMultiple( array keys ): \React\Promise\PromiseInterface

Parameters:

Parameter Type Description
keys array

Return Value:


ReactCache::getMultiple

{@inheritdoc}

ReactCache::getMultiple( array keys, mixed default = null ): \React\Promise\PromiseInterface

Parameters:

Parameter Type Description
keys array
default mixed

Return Value:


ReactCache::setMultiple

{@inheritdoc}

ReactCache::setMultiple( array values, mixed ttl = null ): \React\Promise\PromiseInterface

Parameters:

Parameter Type Description
values array
ttl mixed

Return Value:


SimpleCachePool

PSR-6 to PSR-16 Adapter

SimpleCachePool::__construct

SimpleCachePool::__construct( \Psr\Cache\CacheItemPoolInterface cachePool, ?int defaultLifetime = null ): mixed

Parameters:

Parameter Type Description
cachePool \Psr\Cache\CacheItemPoolInterface
defaultLifetime ?int

Return Value:


SimpleCachePool::getCachePool

{@inheritdoc}

SimpleCachePool::getCachePool(  ): \Psr\Cache\CacheItemPoolInterface

Return Value:


SimpleCachePool::increment

Increment the value of an item in the cache.

SimpleCachePool::increment( string key, int value = 1 ): int

Parameters:

Parameter Type Description
key string
value int

Return Value:


SimpleCachePool::decrement

Decrement the value of an item in the cache.

SimpleCachePool::decrement( string key, int value = 1 ): int

Parameters:

Parameter Type Description
key string
value int

Return Value:


SimpleCachePool::add

Adds data if it doesn't already exists

SimpleCachePool::add( string key, mixed|\Closure value ): bool

Parameters:

Parameter Type Description
key string
value mixed|\Closure

Return Value:

True if the data have been added, false otherwise


SimpleCachePool::clear

{@inheritdoc}

SimpleCachePool::clear(  ): bool

Return Value:


SimpleCachePool::delete

{@inheritdoc}

SimpleCachePool::delete( string key ): bool

Parameters:

Parameter Type Description
key string

Return Value:


SimpleCachePool::deleteMultiple

{@inheritdoc}

SimpleCachePool::deleteMultiple( iterable keys ): bool

Parameters:

Parameter Type Description
keys iterable

Return Value:


SimpleCachePool::get

{@inheritdoc}

SimpleCachePool::get( string key, mixed default = null ): mixed

Parameters:

Parameter Type Description
key string
default mixed

Return Value:


SimpleCachePool::getMultiple

{@inheritdoc}

SimpleCachePool::getMultiple( iterable keys, mixed default = null ): iterable

Parameters:

Parameter Type Description
keys iterable
default mixed

Return Value:


SimpleCachePool::has

{@inheritdoc}

SimpleCachePool::has( string key ): bool

Parameters:

Parameter Type Description
key string

Return Value:


SimpleCachePool::set

{@inheritdoc}

SimpleCachePool::set( string key, mixed value, null|int|\DateInterval ttl = null ): bool

Parameters:

Parameter Type Description
key string
value mixed
ttl null|int|\DateInterval

Return Value:


SimpleCachePool::setMultiple

{@inheritdoc}

SimpleCachePool::setMultiple( iterable values, null|int|\DateInterval ttl = null ): bool

Parameters:

Parameter Type Description
values iterable
ttl null|int|\DateInterval

Return Value:


SimpleCachePool::__debugInfo

SimpleCachePool::__debugInfo(  ): array

Return Value:


SQLite3Adapter

SQLite3Adapter::__construct

SQLite3Adapter::__construct( \SQLite3 driver, string table ): mixed

Parameters:

Parameter Type Description
driver \SQLite3
table string

Return Value:


SQLite3Adapter::read

SQLite3Adapter::read( string key, bool data = true ): array|false

Parameters:

Parameter Type Description
key string
data bool

Return Value:


SQLite3Adapter::query

SQLite3Adapter::query( string query ): array|bool

Parameters:

Parameter Type Description
query string

Return Value:


Sqlite3Driver

Sqlite3Driver::__construct

Sqlite3Driver::__construct( \SQLite3|\PDO|string driver = '', string table = 'cache' ): mixed

Parameters:

Parameter Type Description
driver \SQLite3|\PDO|string A SQLite3 instance or a filename
table string

Return Value:


Sqlite3Driver::purge

Removes expired item entries if supported

Sqlite3Driver::purge(  ): void

Return Value:


Sqlite3Driver::clear

Sqlite3Driver::clear(  ): bool

Return Value:


Sqlite3Driver::delete

Sqlite3Driver::delete( string key ): bool

Parameters:

Parameter Type Description
key string

Return Value:


Sqlite3Driver::getCacheEntry

Sqlite3Driver::getCacheEntry( string key ): \NGSOFT\Cache\CacheEntry

Parameters:

Parameter Type Description
key string

Return Value:


Sqlite3Driver::has

Sqlite3Driver::has( string key ): bool

Parameters:

Parameter Type Description
key string

Return Value:


Sqlite3Driver::__debugInfo

Sqlite3Driver::__debugInfo(  ): array

Return Value:



All versions of cache with dependencies

PHP Build Version
Package Version
Requires php Version >=8.1
psr/cache Version ^3
psr/simple-cache Version ^3
psr/log Version ^1|^2|^3
symfony/var-exporter Version ^6.4
ngsoft/container Version ^1.0
ngsoft/filesystem Version ^1.0
psr/event-dispatcher Version ^1
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package ngsoft/cache contains the following files

Loading the files please wait ....