CodeIgniter v4.5 API

CacheInterface
in

Cache interface

Table of Contents

Methods

clean()  : bool
Will delete all items in the entire cache.
decrement()  : bool|int
Performs atomic decrementation of a raw stored value.
delete()  : bool
Deletes a specific item from the cache store.
get()  : array<string|int, mixed>|bool|float|int|object|string|null
Attempts to fetch an item from the cache store.
getCacheInfo()  : array<string|int, mixed>|false|object|null
Returns information on the entire cache.
getMetaData()  : array<string|int, mixed>|false|null
Returns detailed information about the specific item in the cache.
increment()  : bool|int
Performs atomic incrementation of a raw stored value.
initialize()  : void
Takes care of any handler-specific setup that must be done.
isSupported()  : bool
Determines if the driver is supported on this system.
save()  : bool
Saves an item to the cache store.

Methods

clean()

Will delete all items in the entire cache.

public clean() : bool
Return values
bool —

Success or failure

decrement()

Performs atomic decrementation of a raw stored value.

public decrement(string $key[, int $offset = 1 ]) : bool|int
Parameters
$key : string

Cache ID

$offset : int = 1

Step/value to increase by

Return values
bool|int

delete()

Deletes a specific item from the cache store.

public delete(string $key) : bool
Parameters
$key : string

Cache item name

Return values
bool —

Success or failure

get()

Attempts to fetch an item from the cache store.

public get(string $key) : array<string|int, mixed>|bool|float|int|object|string|null
Parameters
$key : string

Cache item name

Return values
array<string|int, mixed>|bool|float|int|object|string|null

getCacheInfo()

Returns information on the entire cache.

public getCacheInfo() : array<string|int, mixed>|false|object|null

The information returned and the structure of the data varies depending on the handler.

Return values
array<string|int, mixed>|false|object|null

getMetaData()

Returns detailed information about the specific item in the cache.

public getMetaData(string $key) : array<string|int, mixed>|false|null
Parameters
$key : string

Cache item name.

Return values
array<string|int, mixed>|false|null —

Returns null if the item does not exist, otherwise array<string, mixed> with at least the 'expire' key for absolute epoch expiry (or null). Some handlers may return false when an item does not exist, which is deprecated.

increment()

Performs atomic incrementation of a raw stored value.

public increment(string $key[, int $offset = 1 ]) : bool|int
Parameters
$key : string

Cache ID

$offset : int = 1

Step/value to increase by

Return values
bool|int

initialize()

Takes care of any handler-specific setup that must be done.

public initialize() : void

isSupported()

Determines if the driver is supported on this system.

public isSupported() : bool
Return values
bool

save()

Saves an item to the cache store.

public save(string $key, array<string|int, mixed>|bool|float|int|object|string|null $value[, int $ttl = 60 ]) : bool
Parameters
$key : string

Cache item name

$value : array<string|int, mixed>|bool|float|int|object|string|null

The data to save

$ttl : int = 60

Time To Live, in seconds (default 60)

Return values
bool —

Success or failure


        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results