API Documentation

Memory/Container/Movable.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Memory
version
$Id: Movable.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Memory_Container_Movable

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Memory_Container_Movable
jump to top

Extends from
Zend_Memory_Container
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Memory
Constants
LOADED
SWAPPED
LOCKED
Properties
$_id
$_memManager
$_value
$_state
Methods
__construct
lock
unlock
isLocked
__get
__set
getRef
touch
processUpdate
startTrace
setValue
unloadValue
markAsSwapped
isSwapped
getId
destroy

Description

Memory value container

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

Constants

LOADED
jump to class

 LOADED = '1'

Value states

Details

value
1

SWAPPED
jump to class

 SWAPPED = '2'

Details

value
2

LOCKED
jump to class

 LOCKED = '4'

Details

value
4

Properties

$_id
jump to class

integer $_id = ''

Internal object Id

Details

$_id
integer
visibility
protected
default
final
false
static
false

$_memManager
jump to class

Zend_Memory_Manager $_memManager = ''

Memory manager reference

Details

$_memManager
Zend_Memory_Manager
visibility
private
default
final
false
static
false

$_state
jump to class

integer $_state = ''

Value state (LOADED/SWAPPED/LOCKED)

Details

$_state
integer
visibility
private
default
final
false
static
false

$_value
jump to class

Zend_Memory_Value $_value = ''

Value object

Details

$_value
Zend_Memory_Value
visibility
private
default
final
false
static
false

Methods

__construct
jump to class

__construct( Zend_Memory_Manager $memoryManager, integer $id, string $value ) :

Object constructor

Arguments
$memoryManager
Zend_Memory_Manager
$id
integer
$value
string
Details
visibility
public
final
false
static
false

__get
jump to class

__get( string $property ) : string

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.

Arguments
$property
string
Output
string
Details
visibility
public
final
false
static
false
throws

__set
jump to class

__set( string $property, string $value ) :

Set handler

Arguments
$property
string
$value
string
Details
visibility
public
final
false
static
false
throws

destroy
jump to class

destroy( ) :

Destroy memory container and remove it from memory manager list

Details
visibility
public
final
false
static
false
internal

getId
jump to class

getId( ) : integer

Get object id

Output
integer
Details
visibility
public
final
false
static
false
internal

getRef
jump to class

getRef( ) : string

Get string value reference

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

Output
string
Details
visibility
public
final
false
static
false

isLocked
jump to class

isLocked( ) : boolean

Return true if object is locked

Output
boolean
Details
visibility
public
final
false
static
false

isSwapped
jump to class

isSwapped( ) : boolean

Check if object is marked as swapped

Output
boolean
Details
visibility
public
final
false
static
false
internal

lock
jump to class

lock( ) :

Lock object in memory.

Details
visibility
public
final
false
static
false

markAsSwapped
jump to class

markAsSwapped( ) :

Mark, that object is swapped

Details
visibility
public
final
false
static
false
internal

processUpdate
jump to class

processUpdate( ) :

Process container value update.

Must be called only by value object

Details
visibility
public
final
false
static
false
internal

setValue
jump to class

setValue(  $value ) :

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

Arguments
$value
Details
visibility
public
final
false
static
false
internal

startTrace
jump to class

startTrace( ) :

Start modifications trace

Details
visibility
public
final
false
static
false
internal

touch
jump to class

touch( ) :

Signal, that value is updated by external code.

Should be used together with getRef()

Details
visibility
public
final
false
static
false

unloadValue
jump to class

unloadValue( ) :

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

Details
visibility
public
final
false
static
false
internal

unlock
jump to class

unlock( ) :

Unlock object

Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.