API Documentation

Zend/Memory/Container/Movable.php

Show: inherited
Table of Contents

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.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Memory  
Version
$Id: Movable.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Memory_Container_Movable

Package: Zend\Memory

Memory value container

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

Parent(s)
\Zend_Memory_Container
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

Constant  LOADED = 1

Value states

Constant  SWAPPED = 2
Constant  LOCKED = 4

Properties

Propertyprotectedinteger  $_id= ''

Internal object Id

Details
Type
integer
Propertyprivate\Zend_Memory_Manager  $_memManager= ''

Memory manager reference

Details
Type
\Zend_Memory_Manager
Propertyprivateinteger  $_state= ''

Value state (LOADED/SWAPPED/LOCKED)

Details
Type
integer
Propertyprivate\Zend_Memory_Value  $_value= ''

Value object

Details
Type
\Zend_Memory_Value

Methods

methodpublic__construct( \Zend_Memory_Manager $memoryManager, integer $id, string $value ) : void

Object constructor

Parameters
Name Type Description
$memoryManager \Zend_Memory_Manager
$id integer
$value string
methodpublic__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.

Parameters
Name Type Description
$property string
Returns
Type Description
string
Throws
Exception Description
\Zend_Memory_Exception
methodpublic__set( string $property, string $value ) : void

Set handler

Parameters
Name Type Description
$property string
$value string
Throws
Exception Description
\Zend_Exception
methodpublicgetRef( ) : \string

Get string value reference

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

Returns
Type Description
\string
methodpublicisLocked( ) : boolean

Return true if object is locked

Returns
Type Description
boolean
methodpubliclock( ) : void

Lock object in memory.

methodpublictouch( ) : void

Signal, that value is updated by external code.

Should be used together with getRef()

methodpublicunlock( ) : void

Unlock object

Documentation was generated by DocBlox 0.15.1.