Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
Google_Cache_File Class Reference
Inheritance diagram for Google_Cache_File:
Google_Cache_Abstract

Public Member Functions

 __construct (Google_Client $client)
 
 delete ($key)
 Removes the key/data pair for the given $key.
 
 get ($key, $expiration=false)
 Retrieves the data for the given key, or false if they key is unknown or expired.
 
 set ($key, $value)
 Store the key => $value set.
 
 unlock ($storageFile)
 

Public Attributes

const MAX_LOCK_RETRIES = 10
 

Constructor & Destructor Documentation

◆ __construct()

Google_Cache_File::__construct ( Google_Client $client)

Reimplemented from Google_Cache_Abstract.

Member Function Documentation

◆ delete()

Google_Cache_File::delete ( $key)

Removes the key/data pair for the given $key.

Parameters
String$key

Reimplemented from Google_Cache_Abstract.

◆ get()

Google_Cache_File::get ( $key,
$expiration = false )

Retrieves the data for the given key, or false if they key is unknown or expired.

Parameters
String$keyThe key who's data to retrieve
boolean | int$expirationExpiration time in seconds

Reimplemented from Google_Cache_Abstract.

◆ set()

Google_Cache_File::set ( $key,
$value )

Store the key => $value set.

The $value is serialized by this function so can be of any type

Parameters
string$keyKey of the data
string$valuedata

Reimplemented from Google_Cache_Abstract.


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