\seekquarry\yioop\libraryFileCache

__construct()

__construct(string  $dir_name,   $web_site = null) 

Creates the directory for the file cache, sets how frequently all items in the cache expire

Parameters

fileGetContents()

fileGetContents(string  $filename, boolean  $force_read = false) : string

Either a wrapper for file_get_contents, or if a WebSite object is being used to serve pages, it reads it in using blocking I/O file_get_contents() and caches it before return its string contents.

Note this function assumes that only the web server is performing I/O with this file. filemtime() can be used to see if a file on disk has been changed and then you can use $force_read = true below to force re- reading the file into the cache

Parameters

Returns

contents of the file given by $filename

filePutContents()

filePutContents(string  $filename, string  $data) 

Either a wrapper for file_put_contents, or if a WebSite object is being used to serve pages, writes $data to the persistent file with name $filename. Saves a copy in the RAM cache if there is a copy already there.

Parameters

get()

get(string  $key) : mixed

Retrieve data associated with a key that has been put in the cache

Parameters

Returns

the data associated with the key if it exists, false otherwise

set()

set(string  $key, mixed  $value) 

Stores in the file cache a key-value pair

Parameters

checksum()

checksum(string  $key) : integer

Makes a 0 - self::NUMBER_OF_BINS value out of the provided key

Parameters

Returns

value between 0 and self::NUMBER_OF_BINS

clear()

clear() 

Deletes cache key value files and ram copies of key values stored in the this file cache

updateCache()

updateCache(string  $key) 

Used to mark a cache item, and keep track of rounds according to the marker algorith. This function determine if the cache is too full and if so eject an item.

Parameters