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 |
|
|
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 |
|
|
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 |
|
|
|
|
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 |
|
|
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 |
|
|
|
|
Returns |
boolean TRUE on success, FALSE on error |
Required global variables |
|
$regStorage |
registry storage |
|
|
|
|
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 |
|
|
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 |
|
|
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 |
|
|
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 |
|
|
Returns |
string tag 's attributes string |
Required global variables |
|
object sqlStorage $regStorage |
registry storage |
|
|