Class Zend_Memory_Container_Movable

Description

Memory value container

Movable (may be swapped with specified backend and unloaded).

  • copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  • license: New BSD License

Located in /Memory/Container/Movable.php (line 38)

Zend_Memory_Container
   |
   --Zend_Memory_Container_Movable
Class Constant Summary
 LOADED = 1
 LOCKED = 4
 SWAPPED = 2
Variable Summary
 integer $_id
Method Summary
 Zend_Memory_Container_Movable __construct (Zend_Memory_Manager $memoryManager, integer $id, string $value)
 void destroy ()
 integer getId ()
 &string &getRef ()
 boolean isLocked ()
 boolean isSwapped ()
 void lock ()
 void markAsSwapped ()
 void processUpdate ()
 void setValue ( $value)
 void startTrace ()
 void touch ()
 void unloadValue ()
 void unlock ()
 string __get (string $property)
 void __set (string $property, string $value)
Variables
integer $_id (line 44)

Internal object Id

  • access: protected
Methods
Constructor __construct (line 79)

Object constructor

  • access: public
Zend_Memory_Container_Movable __construct (Zend_Memory_Manager $memoryManager, integer $id, string $value)
destroy (line 288)

Destroy memory container and remove it from memory manager list

  • access: public
void destroy ()
getId (line 279)

Get object id

  • access: public
integer getId ()
getRef (line 179)

Get string value reference

_Must_ be used for value access before PHP v 5.2 or _may_ be used for performance considerations

  • access: public
&string &getRef ()
isLocked (line 120)

Return true if object is locked

  • access: public
boolean isLocked ()
isSwapped (line 268)

Check if object is marked as swapped

  • access: public
boolean isSwapped ()
lock (line 90)

Lock object in memory.

  • access: public
void lock ()
markAsSwapped (line 256)

Mark, that object is swapped

  • access: public
void markAsSwapped ()
processUpdate (line 205)

Process container value update.

Must be called only by value object

  • access: public
void processUpdate ()
setValue (line 233)

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

  • access: public
void setValue ( $value)
  • $value
startTrace (line 218)

Start modifications trace

  • access: public
void startTrace ()
touch (line 194)

Signal, that value is updated by external code.

Should be used together with getRef()

  • access: public
void touch ()
unloadValue (line 243)

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

  • access: public
void unloadValue ()
unlock (line 109)

Unlock object

  • access: public
void unlock ()
__get (line 135)

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.

  • throws: Zend_Memory_Exception
  • access: public
string __get (string $property)
  • string $property
__set (line 157)

Set handler

  • throws: Zend_Exception
  • access: public
void __set (string $property, string $value)
  • string $property
  • string $value
Class Constants
LOADED = 1 (line 61)

Value states

LOCKED = 4 (line 63)
SWAPPED = 2 (line 62)

Documentation generated on Mon, 21 Jun 2010 15:34:12 -0400 by phpDocumentor 1.4.3