Docs For Class PhpIndex_Cache

Class: PhpIndex_Cache_Memory

Class Overview

ArrayObject
   |
   --PhpIndex_Cache_Memory

Cache class using memory

Author(s):

Indiana Jones

Version:

Copyright:

2010 PhpIndex

Methods

Inherited Constants

Class: ArrayObject (Internal Class)

ARRAY_AS_PROPS = 2
STD_PROP_LIST = 1

Inherited Methods

Class: ArrayObject (Internal Class)

constructor __construct ( $array )
append ( $value )
asort ( )
count ( )
exchangeArray ( $array )
getArrayCopy ( )
getFlags ( )
getIterator ( )
getIteratorClass ( )
ksort ( )
natcasesort ( )
natsort ( )
offsetExists ( $index )
offsetGet ( $index )
offsetSet ( $index, $newval )
offsetUnset ( $index )
serialize ( )
setFlags ( $flags )
setIteratorClass ( $iteratorClass )
uasort ( $cmp_function )
uksort ( $cmp_function )
unserialize ( $serialized )

Class Details

[line 19]
Cache class using memory

$Id: Memory.php 209 2011-02-21 19:05:38Z indy $

$LastChangedBy: indy $

$LastChangedDate: 2011-02-21 21:05:38 +0200 (Mon, 21 Feb 2011) $

$Rev: 209 $

Tags:

author:	Indiana Jones
version:	1.0
copyright:	2010 PhpIndex

Class Methods

static method get [line 78]

static mixed get(
string
$index)

Get an object from cache

Tags:

throws:	Exception if no entry is registerd for $index.
access:	public

Parameters:

string

$index

- get the value associated with $index

[ Top ]

static method getInstance [line 45]

static PhpIndex_Cache_Memory getInstance(
)

Retrieves the default cache instance.

Tags:

access:

public

[ Top ]

static method remove [line 109]

static void remove(
string
$index)

Unset a cache offset

Tags:

access:

public

Parameters:

string

$index

The location in the ArrayObject to unset.

[ Top ]

static method set [line 96]

static void set(
string
$index, [mixed
$value = null])

Set a cache offset

Tags:

access:

public

Parameters:

string	$index	The location in the ArrayObject in which to store the value.
mixed	$value	The object to store in the ArrayObject.

[ Top ]

static method setInstance [line 62]

static void setInstance(
PhpIndex_Cache_Memory
$instance)

Set the default registry instance to a specified instance.

Tags:

throws:	Exception if cache is already initialized.
access:	public

Parameters:

PhpIndex_Cache_Memory

$instance

An object instance of type PhpIndex_Cache_Memory, or a subclass.

[ Top ]

static method _init [line 132]

static void _init(
)

Initialize the default cache instance.

Tags:

access:

protected

[ Top ]

constructor __construct [line 35]

void __construct(
[array
$array = array()], [string
$flags = parent::ARRAY_AS_PROPS])

Constructor

Tags:

access:

public

Overrides ArrayObject::constructor __construct ( $array ) (parent method not documented)

Parameters:

array	$array	Array of items to store
string	$flags	Available flags

[ Top ]

method offsetExists [line 122]

boolean offsetExists(
string
$index)

Check if an offset exists

Tags:

access:

public

Overrides ArrayObject::offsetExists ( $index ) (parent method not documented)

Parameters:

string

$index

[ Top ]

Documentation generated on Mon, 21 Feb 2011 21:14:13 +0200 by phpDocumentor 1.4.3