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. More...
	dol_getcache ($memoryid)
	Read a memory area shared by all users, all sessions on server. More...
	dol_getshmopaddress ($memoryid)
	Return shared memory address used to store dataset with key memoryid. More...
	dol_listshmop ()
	Return list of contents of all memory area shared. More...
	dol_setshmop ($memoryid, $data, $expire)
	Save data into a memory area shared by all users, all sessions on server. More...
	dol_getshmop ($memoryid)
	Read a memory area shared by all users, all sessions on server. More...

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

$memoryid

Memory id of shared area

Returns

int|mixed <0 if KO, data if OK, null if not found into cache or no caching feature enabled

See also

dol_setcache()

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

dol_getshmop()

dol_getshmop

(

$memoryid

)

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

Parameters

string

$memoryid

Memory id of shared area ('main', 'agenda', ...)

Returns

int <0 if KO, data if OK, Null if no cache enabled or not found

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

dol_getshmopaddress()

dol_getshmopaddress

(

$memoryid

)

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

Parameters

string

$memoryid

Memory id of shared area ('main', 'agenda', ...)

Returns

int <0 if KO, Memoy address of shared memory for key

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

dol_listshmop()

dol_listshmop

(

)

Return list of contents of all memory area shared.

Returns

array

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

dol_setcache()

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

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

Parameters

string	$memoryid	Memory id of shared area
mixed	$data	Data to save. It must not be a null value.
int	$expire	ttl in seconds, 0 never expire

Returns

int <0 if KO, 0 if nothing is done, Nb of bytes written if OK

See also

dol_getcache()

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

dol_setshmop()

dol_setshmop	(		$memoryid,
			$data,
			$expire
	)

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

Parameters

int	$memoryid	Memory id of shared area ('main', 'agenda', ...)
string	$data	Data to save. Must be a not null value.
int	$expire	ttl in seconds, 0 never expire

Returns

int <0 if KO, 0=Caching not available, Nb of bytes written if OK

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