Packageindex Classtrees Modulegroups Elementlist Report XML Files

Softerra

Registry::Registry

public module Registry

Registry Library.

Linkshttp://www.softerra.com/products/ - [Softerra PHP Developer Library Home Page]
AuthorsSofterra <phplib@softerra.com>
SincePHP 4.0.1pl2
Version1.3.3
Copyright(c) 1999-2002 Softerra, LLC

 

Public Method Summary

mixed REG_CONNECT([ string $host, string $user, string $password, string $database ])
Establishes connection to registry database.
integer regLastError()
Returns the last registry error code
string regKeyFromPathAndName(string $path, string $name)
Returns a registry key.
boolean regCreateKey(string $key)
Create a registry key.
boolean regDeleteKey(string $key)
Deletes a registry key.
boolean regRenameKey(string $key, string $name)
Rename a registry key.
boolean regCopySubTree(string $dest, string $source)
Creates a registry key and copies the subtree of the current key.
mixed regGetValue(string $key)
Returns a key value.
boolean regSetValue(string $key, mixed $value)
Sets a key value.
array regSubKeys(string $key)
Returns subkeys of the current key.
integer regSubKeysCount(string $key)
Returns the number of subkeys.
array regGetSubValues(string $key)
Returns an array of subkey values.
string regTagAttributes(string $key)
Returns tag's attributes as string.

Private Method Summary

mixed REG_EXIT(mixed $result, integer $error)
Sets the $registry_error and returns result
boolean regValidName(string $name)
Returns TRUE if $name is a valid registry key name, or FALSE.
boolean regValidKey(string $key)
Returns TRUE if $key is a valid registry key, or FALSE.
string regNameFromKey(string $key)
Returns a registry key name extracted from the $key.
string regPathFromKey(string $key)
Returns a registry path extracted from the $key.
array regExplodeKey(string $key)
Explodes and returns key names extracted from key.
boolean regKeyExists(string $key)
Returns TRUE if $key exists, or FALSE.

Private Constant Summary

REGISTRY_HOST >>DB_HOST<< Registry DB host.
REGISTRY_USER >>DB_USER<< Registry DB user name.
REGISTRY_PASSWORD >>DB_PASSWORD<< Registry DB user password.
REGISTRY_DATABASE >>DB_NAME<< Registry DB name.
TBL_REGISTRY >>REGISTRY<< Registry table.
FLD_KEY >>REGKEY<< Registry keys table field name.
FLD_VAL >>VALUE<< Registry values table field name.
REGKEY_SEPARATOR >>/<< Registry keys separator.
MAX_NAME_LENGTH >>32<< Max registry key name length.
MAX_KEY_LENGTH >>255<< Max registry full key name length.
REG_VALID_NAME >>[a-zA-Z0-9_]{1," . MAX_NAME_LENGTH . "}<< Registry valid name regular expression pattern.
E_SUCCESS >>0<< Success code.
E_BASE >>-100<< Error base offset.
E_BADKEY >>E_BASE-1<< "Bad key" error code.
E_BADNAME >>E_BASE-2<< "Bad name" error code.
E_KEYEXISTS >>E_BASE-3<< "Key already exists" error code
E_KEYNOTEXISTS >>E_BASE-4<< "Key does not exist" error code.
E_UNKNOWN >>E_BASE-100<< "Unknown error" error code.
TYPE_BOOLEAN >>boolean<< Boolean type
TYPE_INTEGER >>integer<< Integer type
TYPE_DOUBLE >>double<< Double type
TYPE_STRING >>string<< String type.
TYPE_ARRAY >>array<< Array type.
ROOTKEY >><< Root key.

Public Method Details

REG_CONNECT

public mixed REG_CONNECT( [ string $host, string $user, string $password, string $database ] )

  Establishes connection to registry database.

If $regDefaultConnection is false you need to initialize registry using REG_CONNECT ($host, $user, $password, $database). Otherwise the registry will initialize automatically. Returns MySQL link identifier on success, or FALSE on failure.

Parameter
string $host = >>"REGISTRY_HOST"<<
registry database host
string $user = >>"REGISTRY_USER"<<
registry database user name
string $password = >>"REGISTRY_PASSWORD"<<
registry database user password
string $database = >>"REGISTRY_DATABASE"<<
registry database name
Returns mixed

MySQL link identifier on success, or FALSE on failure

Required global variables
object sqlStorage $regStorage registry storage

regLastError

public integer regLastError( )

  Returns the last registry error code

Returns integer

Last registry error code

Required global variables
integer $registry_error Last registry error code

regKeyFromPathAndName

public string regKeyFromPathAndName( string $path, string $name )

  Returns a registry key.

Parameter
string $path
registry path
string $name
registry key name
Returns string

registry key


regCreateKey

public boolean regCreateKey( string $key )

  Create a registry key.

Creates a registry key with the $key name if it is a valid name and does not exist. Note: the default type is boolean and the value is FALSE.

Parameter
string $key
Returns boolean

TRUE on success, FALSE on error

Required global variables
object sqlStorage $regStorage registry storage

regDeleteKey

public boolean regDeleteKey( string $key )

  Deletes a registry key.

Deletes a registry key name $key if it is valid name and exist.

Parameter
string $key
Returns boolean

TRUE on success, FALSE on error

Required global variables
object sqlStorage $regStorage registry storage

regRenameKey

public boolean regRenameKey( string $key, string $name )

  Rename a registry key.

Rename a registry key name $key to $name if they both valid and $key exist.

Parameter
string $key
string $name
Returns boolean

TRUE on success, FALSE on error

Required global variables
object sqlStorage $regStorage registry storage

regCopySubTree

public boolean regCopySubTree( string $dest, string $source )

  Creates a registry key and copies the subtree of the current key.

Creates a registry key with the $dest name at the root entry and copies the subtree of the current key whose path is $source.

Parameter
string $dest
Created key name
string $source
Key path wich must be copied
Returns boolean

TRUE on success, FALSE on error

Required global variables
object sqlStorage $regStorage registry storage

regGetValue

public mixed regGetValue( string $key )

  Returns a key value.

Returns a key value with the $key name if that key already exists.

Parameter
string $key
Key name
Returns mixed

Key value on success, FALSE on error

Required global variables
object sqlStorage $regStorage registry storage

regSetValue

public boolean regSetValue( string $key, mixed $value )

  Sets a key value.

Sets a key value with the $key name as the $value value.

Parameter
string $key
Key name
mixed $value
Key value
Returns boolean

TRUE on success, FALSE on error

Required global variables
$regStorage registry storage
$sqlAddSlashes

regSubKeys

public array regSubKeys( string $key )

  Returns subkeys of the current key.

Returns an array of subkeys of the current key with the $key name.

Parameter
string $key
Key name
Returns array

contain array of subkeys

Required global variables
object sqlStorage $regStorage registry storage

regSubKeysCount

public integer regSubKeysCount( string $key )

  Returns the number of subkeys.

Returns the number of subkeys for the $key key.

Parameter
string $key
Key name
Returns integer

number of subkeys

Required global variables
object sqlStorage $regStorage registry storage

regGetSubValues

public array regGetSubValues( string $key )

  Returns an array of subkey values.

Returns an array of the $key's subkey values, where a subkey name is the array key and a subkey value is the array value.

Parameter
string $key
Key name
Returns array

array of subkey values

Required global variables
object sqlStorage $regStorage registry storage

regTagAttributes

public string regTagAttributes( string $key )

  Returns tag's attributes as string.

Returns the tag's attributes as a string, where the attributes are subkeys of $key and the attribute values are subkey values.

Parameter
string $key
Key name
Returns string

tag 's attributes string

Required global variables
object sqlStorage $regStorage registry storage

Private Method Details

REG_EXIT

private mixed REG_EXIT( mixed $result, integer $error )

  Sets the $registry_error and returns result

Sets the $registry_error to last error and returns the last operation result.

Parameter
mixed $result
integer $error
Returns mixed

Required global variables
integer $registry_error Last registry error code

regValidName

private boolean regValidName( string $name )

  Returns TRUE if $name is a valid registry key name, or FALSE.

Parameter
string $name
registry key name
Returns boolean

TRUE if $name is a valid registry key name, or FALSE


regValidKey

private boolean regValidKey( string $key )

  Returns TRUE if $key is a valid registry key, or FALSE.

Parameter
string $key
registry key
Returns boolean

TRUE if $key is a valid registry key, or FALSE


regNameFromKey

private string regNameFromKey( string $key )

  Returns a registry key name extracted from the $key.

Parameter
string $key
registry key
Returns string

registry key name


regPathFromKey

private string regPathFromKey( string $key )

  Returns a registry path extracted from the $key.

Parameter
string $key
registry key
Returns string

registry path


regExplodeKey

private array regExplodeKey( string $key )

  Explodes and returns key names extracted from key.

Parameter
string $key
Returns array

key names


regKeyExists

private boolean regKeyExists( string $key )

  Returns TRUE if $key exists, or FALSE.

Parameter
string $key
Returns boolean

TRUE if $key exist or FALSE

Required global variables
object sqlStorage $regStorage registry storage

Private Constant Details

REGISTRY_HOST

define( REGISTRY_HOST, >>DB_HOST<< )
Case: default: case sensitive

Registry DB host.


REGISTRY_USER

define( REGISTRY_USER, >>DB_USER<< )
Case: default: case sensitive

Registry DB user name.


REGISTRY_PASSWORD

define( REGISTRY_PASSWORD, >>DB_PASSWORD<< )
Case: default: case sensitive

Registry DB user password.


REGISTRY_DATABASE

define( REGISTRY_DATABASE, >>DB_NAME<< )
Case: default: case sensitive

Registry DB name.


TBL_REGISTRY

define( TBL_REGISTRY, >>REGISTRY<< )
Case: default: case sensitive

Registry table.


FLD_KEY

define( FLD_KEY, >>REGKEY<< )
Case: default: case sensitive

Registry keys table field name.


FLD_VAL

define( FLD_VAL, >>VALUE<< )
Case: default: case sensitive

Registry values table field name.


REGKEY_SEPARATOR

define( REGKEY_SEPARATOR, >>/<< )
Case: default: case sensitive

Registry keys separator.


MAX_NAME_LENGTH

define( MAX_NAME_LENGTH, >>32<< )
Case: default: case sensitive

Max registry key name length.


MAX_KEY_LENGTH

define( MAX_KEY_LENGTH, >>255<< )
Case: default: case sensitive

Max registry full key name length.


REG_VALID_NAME

define( REG_VALID_NAME, >>[a-zA-Z0-9_]{1," . MAX_NAME_LENGTH . "}<< )
Case: default: case sensitive

Registry valid name regular expression pattern.


E_SUCCESS

define( E_SUCCESS, >>0<< )
Case: default: case sensitive

Success code.


E_BASE

define( E_BASE, >>-100<< )
Case: default: case sensitive

Error base offset.


E_BADKEY

define( E_BADKEY, >>E_BASE-1<< )
Case: default: case sensitive

"Bad key" error code.


E_BADNAME

define( E_BADNAME, >>E_BASE-2<< )
Case: default: case sensitive

"Bad name" error code.


E_KEYEXISTS

define( E_KEYEXISTS, >>E_BASE-3<< )
Case: default: case sensitive

"Key already exists" error code


E_KEYNOTEXISTS

define( E_KEYNOTEXISTS, >>E_BASE-4<< )
Case: default: case sensitive

"Key does not exist" error code.


E_UNKNOWN

define( E_UNKNOWN, >>E_BASE-100<< )
Case: default: case sensitive

"Unknown error" error code.


TYPE_BOOLEAN

define( TYPE_BOOLEAN, >>boolean<< )
Case: default: case sensitive

Boolean type


TYPE_INTEGER

define( TYPE_INTEGER, >>integer<< )
Case: default: case sensitive

Integer type


TYPE_DOUBLE

define( TYPE_DOUBLE, >>double<< )
Case: default: case sensitive

Double type


TYPE_STRING

define( TYPE_STRING, >>string<< )
Case: default: case sensitive

String type.


TYPE_ARRAY

define( TYPE_ARRAY, >>array<< )
Case: default: case sensitive

Array type.


ROOTKEY

define( ROOTKEY, >><< )
Case: default: case sensitive

Root key.



Packageindex Classtrees Modulegroups Elementlist Report XML Files