dolibarr 20.0.0
memory.lib.php File Reference

Set of function for memory/cache management. More...

Go to the source code of this file.

Functions

 dol_setcache ($memoryid, $data, $expire=0)
 Save data into a memory area shared by all users, all sessions on server.
 
 dol_getcache ($memoryid)
 Read a memory area shared by all users, all sessions on server.
 
 dol_getshmopaddress ($memoryid)
 Return shared memory address used to store dataset with key memoryid.
 
 dol_listshmop ()
 Return list of contents of all memory area shared.
 
 dol_setshmop ($memoryid, $data, $expire)
 Save data into a memory area shared by all users, all sessions on server.
 
 dol_getshmop ($memoryid)
 Read a memory area shared by all users, all sessions on server.
 

Detailed Description

Set of function for memory/cache management.

Definition in file memory.lib.php.

Function Documentation

◆ dol_getcache()

dol_getcache ( $memoryid)

Read a memory area shared by all users, all sessions on server.

Parameters
string$memoryidMemory id of shared area
Returns
int|mixed Return integer <0 if KO, data if OK, null if not found into cache or no caching feature enabled
See also
dol_setcache()

Definition at line 143 of file memory.lib.php.

References dol_getshmop(), getDolGlobalInt(), and getDolGlobalString().

Referenced by commande_prepare_head(), conferenceorboothProjectPrepareHead(), contact_prepare_head(), contract_prepare_head(), facture_prepare_head(), fichinter_prepare_head(), invoice_rec_prepare_head(), Translate\load(), Translate\loadFromDatabase(), member_prepare_head(), project_prepare_head(), propal_prepare_head(), societe_prepare_head(), and user_prepare_head().

◆ dol_getshmop()

dol_getshmop ( $memoryid)

Read a memory area shared by all users, all sessions on server.

Parameters
string$memoryidMemory id of shared area ('main', 'agenda', ...)
Returns
int|null Return integer <0 if KO, data if OK, null if no cache enabled or not found

Definition at line 298 of file memory.lib.php.

References dol_getshmopaddress().

Referenced by dol_getcache(), and dol_listshmop().

◆ dol_getshmopaddress()

dol_getshmopaddress ( $memoryid)

Return shared memory address used to store dataset with key memoryid.

Parameters
string$memoryidMemory id of shared area ('main', 'agenda', ...)
Returns
int Return integer <0 if KO, Memoy address of shared memory for key

Definition at line 224 of file memory.lib.php.

Referenced by dol_getshmop(), and dol_setshmop().

◆ dol_listshmop()

dol_listshmop ( )

Return list of contents of all memory area shared.

Returns
array

Definition at line 238 of file memory.lib.php.

References dol_getshmop().

◆ dol_setcache()

dol_setcache ( $memoryid,
$data,
$expire = 0 )

Save data into a memory area shared by all users, all sessions on server.

Note: MAIN_CACHE_COUNT must be set.

Parameters
string$memoryidMemory id of shared area
mixed$dataData to save. It must not be a null value.
int$expirettl in seconds, 0 never expire
Returns
int Return integer <0 if KO, 0 if nothing is done, Nb of bytes written if OK
See also
dol_getcache()

Definition at line 69 of file memory.lib.php.

References dol_setshmop(), getDolGlobalInt(), and getDolGlobalString().

Referenced by commande_prepare_head(), conferenceorboothProjectPrepareHead(), contact_prepare_head(), contract_prepare_head(), facture_prepare_head(), fichinter_prepare_head(), invoice_rec_prepare_head(), Translate\load(), Translate\loadFromDatabase(), member_prepare_head(), project_prepare_head(), propal_prepare_head(), societe_prepare_head(), and user_prepare_head().

◆ dol_setshmop()

dol_setshmop ( $memoryid,
$data,
$expire )

Save data into a memory area shared by all users, all sessions on server.

Parameters
int$memoryidMemory id of shared area ('main', 'agenda', ...)
string$dataData to save. Must be a not null value.
int$expirettl in seconds, 0 never expire
Returns
int Return integer <0 if KO, 0=Caching not available, Nb of bytes written if OK

Definition at line 260 of file memory.lib.php.

References dol_getshmopaddress(), and dol_strlen().

Referenced by dol_setcache().