Documentation

File extends AbstractAdapter
in package

File adapter cache class

Tags
category

Pop

author

Nick Sagona, III dev@nolainteractive.com

copyright

Copyright (c) 2009-2024 NOLA Interactive, LLC. (http://www.nolainteractive.com)

license

http://www.popphp.org/license New BSD License

version
4.0.0

Table of Contents

Properties

$dir  : string|null
Cache dir
$ttl  : int
Global time-to-live

Methods

__construct()  : mixed
Constructor
clear()  : File
Clear all stored values from cache
deleteItem()  : File
Delete a value in cache
destroy()  : File
Destroy cache resource
getDir()  : string|null
Get the current cache dir
getItem()  : mixed
Get an item from cache
getItemTtl()  : int
Get the time-to-live for an item in cache
getTtl()  : int
Get the global time-to-live for the cache object
hasItem()  : bool
Determine if the item exist in cache
saveItem()  : File
Save an item to cache
setDir()  : File
Set the current cache dir
setTtl()  : AbstractAdapter
Set the global time-to-live for the cache adapter

Properties

$dir

Cache dir

protected string|null $dir = null

Methods

__construct()

Constructor

public __construct(string $dir[, int $ttl = 0 ]) : mixed

Instantiate the cache file object

Parameters
$dir : string
$ttl : int = 0

clear()

Clear all stored values from cache

public clear() : File
Return values
File

deleteItem()

Delete a value in cache

public deleteItem(string $id) : File
Parameters
$id : string
Return values
File

destroy()

Destroy cache resource

public destroy() : File
Return values
File

getDir()

Get the current cache dir

public getDir() : string|null
Return values
string|null

getItem()

Get an item from cache

public getItem(string $id) : mixed
Parameters
$id : string

getItemTtl()

Get the time-to-live for an item in cache

public getItemTtl(string $id) : int
Parameters
$id : string
Return values
int

getTtl()

Get the global time-to-live for the cache object

public getTtl() : int
Return values
int

hasItem()

Determine if the item exist in cache

public hasItem(string $id) : bool
Parameters
$id : string
Return values
bool

saveItem()

Save an item to cache

public saveItem(string $id, mixed $value[, int|null $ttl = null ]) : File
Parameters
$id : string
$value : mixed
$ttl : int|null = null
Return values
File

setDir()

Set the current cache dir

public setDir(string $dir) : File
Parameters
$dir : string
Tags
throws
Exception
Return values
File

        
On this page

Search results