ilShm Class Reference

Class ilShm. More...

Inheritance diagram for ilShm:

Collaboration diagram for ilShm:

Public Member Functions
	__construct ($service_id, $component)
	exists ($key)
	set ($key, $serialized_value, $ttl=null)
	get ($key)
	delete ($key)
	flush ($complete=false)
	serialize ($value)
	unserialize ($serialized_value)
Public Member Functions inherited from ilGlobalCacheService
	__construct ($service_id, $component)
	unserialize ($serialized_value)
	get ($key)
	set ($key, $serialized_value, $ttl=null)
	serialize ($value)
	getServiceId ()
	setServiceId ($service_id)
	getComponent ()
	setComponent ($component)
	isActive ()
	isInstallable ()
	returnKey ($key)
	getInfo ()
	getInstallationFailureReason ()
	exists ($key)
	delete ($key)
	flush ($complete=false)
	setServiceType ($service_type)
	getServiceType ()
	setValid ($key)
	Declare a key as valid. More...
	setInvalid ($key=null)
	Set the key as invalid. More...
	isValid ($key)
	Checks whether the cache key is valid or not. More...

Protected Member Functions
	getActive ()
	@description set self::$active More...
	getInstallable ()
	@description set self::$installable More...
Protected Member Functions inherited from ilGlobalCacheService
	getActive ()
	getInstallable ()
	getMemoryLimit ()
	getMinMemory ()
	checkMemory ()

Static Protected Attributes
static	$shm_id = null
static	$block_size = 0
Static Protected Attributes inherited from ilGlobalCacheService
static	$active = array()
static	$installable = array()

Additional Inherited Members
Protected Attributes inherited from ilGlobalCacheService
	$current_time = 0
	$valid_keys = array()
	$service_id = ''
	$component = ''
	$service_type = ilGlobalCache::TYPE_STATIC
	$valid_key_hash = ''

Detailed Description

Class ilShm.

@beta http://php.net/manual/en/shmop.examples-basic.php

Author

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Version

1.0.0

Definition at line 13 of file class.ilShm.php.

Constructor & Destructor Documentation

__construct()

ilShm::__construct	(		$service_id,
			$component
	)

Parameters

$service_id
$component

Reimplemented from ilGlobalCacheService.

Definition at line 49 of file class.ilShm.php.

    {
        parent::__construct($service_id, $component);
        self::$shm_id = shmop_open(0xff3, "c", 0644, 100);
        self::$block_size = shmop_size(self::$shm_id);
    }

References ilGlobalCacheService\$component, ilGlobalCacheService\$service_id, and ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

delete()

ilShm::delete

(

$key

)

Parameters

$key

Returns

bool

Reimplemented from ilGlobalCacheService.

Definition at line 97 of file class.ilShm.php.

    {
        return shm_remove_var(self::$shm_id, $key);
    }

exists()

ilShm::exists

(

$key

)

Parameters

$key

Returns

bool

Reimplemented from ilGlobalCacheService.

Definition at line 62 of file class.ilShm.php.

    {
        return shm_has_var(self::$shm_id, $key);
    }

flush()

ilShm::flush

(

$complete = false

)

Parameters

bool

$complete

Returns

bool

Reimplemented from ilGlobalCacheService.

Definition at line 108 of file class.ilShm.php.

    {
        // currently a partial flushing is missing
        shmop_delete(self::$shm_id);
 
        return true;
    }

get()

ilShm::get

(

$key

)

Parameters

$key

Returns

mixed

Reimplemented from ilGlobalCacheService.

Definition at line 86 of file class.ilShm.php.

    {
        return shmop_read(self::$shm_id, 0, self::$block_size);
    }

getActive()

ilShm::getActive ( )

protected

@description set self::$active

Reimplemented from ilGlobalCacheService.

Definition at line 29 of file class.ilShm.php.

    {
        self::$active = function_exists('shmop_open');
    }

getInstallable()

ilShm::getInstallable ( )

protected

@description set self::$installable

Reimplemented from ilGlobalCacheService.

Definition at line 38 of file class.ilShm.php.

    {
        return false;
        self::$active = function_exists('shmop_open');
    }

serialize()

ilShm::serialize

(

$value

)

Parameters

$value

Returns

mixed

Reimplemented from ilGlobalCacheService.

Definition at line 122 of file class.ilShm.php.

    {
        return serialize($value);
    }

References serialize().

Referenced by serialize().

Here is the call graph for this function:

Here is the caller graph for this function:

set()

ilShm::set	(		$key,
			$serialized_value,
			$ttl = null
	)

Parameters

	$key
	$serialized_value
null	$ttl

Returns

bool

Reimplemented from ilGlobalCacheService.

Definition at line 75 of file class.ilShm.php.

    {
        return shmop_write(self::$shm_id, $key, $serialized_value);
    }

unserialize()

ilShm::unserialize

(

$serialized_value

)

Parameters

$serialized_value

Returns

mixed

Reimplemented from ilGlobalCacheService.

Definition at line 133 of file class.ilShm.php.

    {
        return unserialize($serialized_value);
    }

References unserialize().

Referenced by unserialize().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$block_size

ilShm::$block_size = 0

staticprotected

Definition at line 23 of file class.ilShm.php.

$shm_id

ilShm::$shm_id = null

staticprotected

Definition at line 19 of file class.ilShm.php.

---

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

• Services/GlobalCache/classes/Shm/class.ilShm.php