Memory/Container/Movable.php

Show: PublicProtectedPrivateinherited
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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Memory  
Version
$Id$  

\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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

>VConstant  LOADED = 1
Value states
>VConstant  SWAPPED = 2
>VConstant  LOCKED = 4

Properties

>VPropertyprotectedinteger $_id
Internal object Id
Details
Type
integer
>VPropertyprivate\Zend_Memory_Manager $_memManager
Memory manager reference
>VPropertyprivateinteger $_state
Value state (LOADED/SWAPPED/LOCKED)
Details
Type
integer
>VPropertyprivate\Zend_Memory_Value $_value
Value object

Methods

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

Object constructor

Parameters
NameTypeDescription
$memoryManager\Zend_Memory_Manager
$idinteger
$valuestring
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
NameTypeDescription
$propertystring
Returns
TypeDescription
string
Throws
ExceptionDescription
\Zend_Memory_Exception
methodpublic__set(string $property, string $value) : void

Set handler

Parameters
NameTypeDescription
$propertystring
$valuestring
Throws
ExceptionDescription
\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
TypeDescription
\&string
methodpublicisLocked() : boolean

Return true if object is locked

Returns
TypeDescription
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 phpDocumentor 2.2.0 .