Zend_Memory_Container_Movable Class Reference

Inheritance diagram for Zend_Memory_Container_Movable:

Public Member Functions
	__construct (Zend_Memory_Manager $memoryManager, $id, $value)
	lock ()
	unlock ()
	isLocked ()
	__get ($property)
	__set ($property, $value)
&	getRef ()
	touch ()
	processUpdate ()
	startTrace ()
	setValue ($value)
	unloadValue ()
	markAsSwapped ()
	isSwapped ()
	getId ()
	destroy ()

Data Fields
const	LOADED = 1
const	SWAPPED = 2
const	LOCKED = 4

Protected Attributes
	$_id

Detailed Description

Definition at line 38 of file Movable.php.

Constructor & Destructor Documentation

__construct()

__construct	(	Zend_Memory_Manager	$memoryManager,
			$id,
			$value
	)

Object constructor

Parameters

Zend_Memory_Manager	$memoryManager
integer	$id
string	$value

Definition at line 79 of file Movable.php.

    {
        $this->_memManager = $memoryManager;
        $this->_id    = $id;
        $this->_state = self::LOADED;
        $this->_value = new Zend_Memory_Value($value, $this);
    }

Member Function Documentation

__get()

__get

(

$property

)

Get handler

Loads object if necessary and moves it to the top of loaded objects list. Swaps objects from the bottom of loaded objects list, if necessary.

Parameters

string

$property

Returns

string

Exceptions

Zend_Memory_Exception

Definition at line 135 of file Movable.php.

    {
        if ($property != 'value') {
            #require_once 'Zend/Memory/Exception.php';
            throw new Zend_Memory_Exception('Unknown property: Zend_Memory_container::$' . $property);
        }

        if ( !($this->_state & self::LOADED) ) {
            $this->_memManager->load($this, $this->_id);
            $this->_state |= self::LOADED;
        }

        return $this->_value;
    }

__set()

__set	(		$property,
			$value
	)

Set handler

Parameters

string	$property
string	$value

Exceptions

Zend_Exception

Definition at line 157 of file Movable.php.

    {
        if ($property != 'value') {
            #require_once 'Zend/Memory/Exception.php';
            throw new Zend_Memory_Exception('Unknown property: Zend_Memory_container::$' . $property);
        }

        $this->_state = self::LOADED;
        $this->_value = new Zend_Memory_Value($value, $this);

        $this->_memManager->processUpdate($this, $this->_id);
    }

destroy()

destroy

(

)

Destroy memory container and remove it from memory manager list

We don't clean up swap because of performance considerations Cleaning is performed by Memory Manager destructor

Definition at line 288 of file Movable.php.

    {
        $this->_memManager->unlink($this, $this->_id);
    }

getId()

getId

(

)

Get object id

Definition at line 279 of file Movable.php.

    {
        return $this->_id;
    }

getRef()

& getRef

(

)

Get string value reference

Must be used for value access before PHP v 5.2 or may be used for performance considerations

Returns

&string

Implements Zend_Memory_Container_Interface.

Definition at line 179 of file Movable.php.

    {
        if ( !($this->_state & self::LOADED) ) {
            $this->_memManager->load($this, $this->_id);
            $this->_state |= self::LOADED;
        }

        return $this->_value->getRef();
    }

isLocked()

isLocked

(

)

Return true if object is locked

Returns

boolean

Implements Zend_Memory_Container_Interface.

Definition at line 120 of file Movable.php.

    {
        return $this->_state & self::LOCKED;
    }

isSwapped()

isSwapped

(

)

Check if object is marked as swapped

Definition at line 268 of file Movable.php.

    {
        return $this->_state & self::SWAPPED;
    }

lock()

lock

(

)

Lock object in memory.

Todo:

It's possible to set "value" container attribute to avoid modification tracing, while it's locked Check, if it's more effective

Implements Zend_Memory_Container_Interface.

Definition at line 90 of file Movable.php.

    {
        if ( !($this->_state & self::LOADED) ) {
            $this->_memManager->load($this, $this->_id);
            $this->_state |= self::LOADED;
        }

        $this->_state |= self::LOCKED;

    }

markAsSwapped()

markAsSwapped

(

)

Mark, that object is swapped

Definition at line 256 of file Movable.php.

    {
        // Clear LOADED state bit
        $this->_state |= self::LOADED;
    }

processUpdate()

processUpdate

(

)

Process container value update. Must be called only by value object

Definition at line 205 of file Movable.php.

    {
        // Clear SWAPPED state bit
        $this->_state &= ~self::SWAPPED;

        $this->_memManager->processUpdate($this, $this->_id);
    }

setValue()

setValue

(

$value

)

Set value (used by memory manager when value is loaded)

Definition at line 233 of file Movable.php.

    {
        $this->_value = new Zend_Memory_Value($value, $this);
    }

startTrace()

startTrace

(

)

Start modifications trace

Definition at line 218 of file Movable.php.

    {
        if ( !($this->_state & self::LOADED) ) {
            $this->_memManager->load($this, $this->_id);
            $this->_state |= self::LOADED;
        }

        $this->_value->startTrace();
    }

touch()

touch

(

)

Signal, that value is updated by external code.

Should be used together with getRef()

Implements Zend_Memory_Container_Interface.

Definition at line 194 of file Movable.php.

    {
        $this->_memManager->processUpdate($this, $this->_id);
    }

unloadValue()

unloadValue

(

)

Clear value (used by memory manager when value is swapped)

Definition at line 243 of file Movable.php.

    {
        // Clear LOADED state bit
        $this->_state &= ~self::LOADED;

        $this->_value = null;
    }

unlock()

unlock

(

)

Unlock object

Implements Zend_Memory_Container_Interface.

Definition at line 109 of file Movable.php.

    {
        // Clear LOCKED state bit
        $this->_state &= ~self::LOCKED;
    }

Field Documentation

$_id

$_id

protected

Definition at line 44 of file Movable.php.

LOADED

const LOADED = 1

Value states

Definition at line 61 of file Movable.php.

LOCKED

const LOCKED = 4

Definition at line 63 of file Movable.php.

SWAPPED

const SWAPPED = 2

Definition at line 62 of file Movable.php.

---

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

• vendor/magento/zendframework1/library/Zend/Memory/Container/Movable.php