PhpIndex
[ class tree: PhpIndex ] [ index: PhpIndex ] [ all elements ]

Class: PhpIndex_Registry

Source Location: /Registry.php

Class Overview

ArrayObject
   |
   --PhpIndex_Registry

Generic storage class helps to manage global data.


Variables

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 22]
Generic storage class helps to manage global data.



[ Top ]


Class Variables

static $_registry =  null

[line 29]

Registry object provides storage for shared objects.



Tags:

access:  protected

Type:   PhpIndex_Registry


[ Top ]



Class Methods


static method get [line 84]

static mixed get( string $index)

getter method, basically same as offsetGet().

This method can be called from an object of type PhpIndex_Registry, or it can be called statically. In the latter case, it uses the default static instance stored in the class.




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 47]

static PhpIndex_Registry getInstance( )

Retrieves the default registry instance.



Tags:

access:  public


[ Top ]

static method isRegistered [line 120]

static boolean isRegistered( string $index)

Returns TRUE if the $index is a named value in the registry, or FALSE if $index was not found in the registry.



Tags:

access:  public


Parameters:

string   $index  

[ Top ]

static method set [line 107]

static void set( string $index, mixed $value)

setter method, basically same as offsetSet().

This method can be called from an object of type PhpIndex_Registry, or it can be called statically. In the latter case, it uses the default static instance stored in the class.




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 64]

static void setInstance( PhpIndex_Registry $registry)

Set the default registry instance to a specified instance.



Tags:

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


Parameters:

PhpIndex_Registry   $registry   An object instance of type PhpIndex_Registry, or a subclass.

[ Top ]

static method _init [line 144]

static void _init( )

Initialize the default registry instance.



Tags:

access:  protected


[ Top ]

constructor __construct [line 37]

PhpIndex_Registry __construct( [array $array = array()])

Constructs a parent ArrayObject with default ARRAY_AS_PROPS to allow acces as an object



Tags:

access:  public


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

Parameters:

array   $array   data array

[ Top ]

method offsetExists [line 134]

mixed 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