Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
ADODB_Cache_File Class Reference

Class ADODB_Cache_File. More...

Public Member Functions

 _dirFlush ($dir, $kill_top_level=false)
 Private function to erase all of the files and subdirectories in a directory.
 
 createdir ($hash, $debug)
 Create temp directories.
 
 flushall ($debug=false)
 Flush all items in cache.
 
 flushcache ($f, $debug=false)
 Flush one file in cache.
 
 getdirname ($hash)
 
readcache ($filename, &$err, $secs2cache, $rsClass)
 load serialised RecordSet and unserialise it
 
 writecache ($filename, $contents, $debug, $secs2cache)
 Write serialised RecordSet to cache item/file.
 

Public Attributes

 $createdir = true
 

Detailed Description

Member Function Documentation

◆ _dirFlush()

ADODB_Cache_File::_dirFlush ( $dir,
$kill_top_level = false )

Private function to erase all of the files and subdirectories in a directory.

Just specify the directory, and tell it if you want to delete the directory or just clear it out. Note: $kill_top_level is used internally in the function to flush subdirectories.

◆ createdir()

ADODB_Cache_File::createdir ( $hash,
$debug )

Create temp directories.

Parameters
string$hash
bool$debug
Return values
string

◆ flushall()

ADODB_Cache_File::flushall ( $debug = false)

Flush all items in cache.

Parameters
bool$debug
Return values
bool|void

◆ flushcache()

ADODB_Cache_File::flushcache ( $f,
$debug = false )

Flush one file in cache.

Parameters
string$f
bool$debug

◆ getdirname()

ADODB_Cache_File::getdirname ( $hash)
Parameters
string$hash
Return values
string

◆ readcache()

& ADODB_Cache_File::readcache ( $filename,
& $err,
$secs2cache,
$rsClass )

load serialised RecordSet and unserialise it

Parameters
$filename
$err
$secs2cache
$rsClass
Return values
ADORecordSet

◆ writecache()

ADODB_Cache_File::writecache ( $filename,
$contents,
$debug,
$secs2cache )

Write serialised RecordSet to cache item/file.

Parameters
$filename
$contents
$debug
$secs2cache
Return values
bool|int

The documentation for this class was generated from the following file: