API Documentation

Memory/Container/Locked.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: Locked.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Memory_Container_Locked

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_Locked

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
Properties
$value
Methods
__construct
lock
unlock
isLocked
getRef
touch
destroy

Description

Memory value container

Locked (always stored in memory).

Properties

$value

string $value = ''

Value object

Details

$value
string
visibility
public
default
final
false
static
false

Methods

__construct

__construct( string $value ) :

Object constructor

Arguments
$value
string
Details
visibility
public
final
false
static
false

destroy

destroy( ) :

Destroy memory container and remove it from memory manager list

Details
visibility
public
final
false
static
false

getRef

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

isLocked( ) : boolean

Return true if object is locked

Output
boolean
Details
visibility
public
final
false
static
false

lock

lock( ) :

Lock object in memory.

Details
visibility
public
final
false
static
false

touch

touch( ) :

Signal, that value is updated by external code.

Should be used together with getRef()

Details
visibility
public
final
false
static
false

unlock

unlock( ) :

Unlock object

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