YANA 4 PHP Framework
Docs For Class Registry
Registry
This class implements a registry. You can operate on it via keys, identifying scalar values or arrays inside the registry.
Example for usage of the $key parameter:
Array { ID1 => Array { ID2 => 'value' } }To get the string 'value' from the array above use $key = 'ID1.ID2'
The wildcard '*' may be used to refer to the array as a whole.
Located in /includes/class_registry.php
Object | --InputStream | --SecureInputStream | --VDrive | --Registry
Name | Type | Description |
---|---|---|
$key | string | (optional) |
This returns the var identified by $key.
Note that you may use the following magic keys FOR THIS FUNCTION ONLY:
Returns bool(false) on error;
Name | Type | Description |
---|---|---|
$key | string | |
$array | array |
Merges the element identified by $key with the array $value.
Returns bool(false) on error.
Name | Type | Description |
---|---|---|
$key | string | |
$type | string |
Set the data type of the element identified by $key to $type.
Returns bool(false) if the element is NULL or does not exist, or the $type parameter is invalid. Returns bool(true) otherwise.
Name | Type | Description |
---|---|---|
$key | string | |
$value | mixed |
Sets the element identified by $key to $value. If the value does not exist it gets inserted. If a previous value existed the value gets updated.
This function returns bool(false) if $key = '*' and $value is not an array - which is: trying overwrite the complete registry with a non-array value. It returns bool(true) otherwise.
Name | Type | Description |
---|---|---|
$key | string | |
&$value | mixed |
Sets the element identified by $key to $value by passing it's reference. If the value does not exist it gets inserted. If a previous value existed the value gets updated.
This function returns bool(false) if $key = '*' and $value is not an array - which is: trying overwrite the complete registry with a non-array value. It returns bool(true) otherwise.
Name | Type | Description |
---|---|---|
$key | string |
Unsets the element identified by $key in the registry. Returns bool(false) if the element does not exist or the key is invalid. Returns bool(true) otherwise.
Inherited From VDrive
Inherited From SecureInputStream
Inherited From InputStream
Inherited From Object
Documentation generated on Sun, 11 Mar 2007 15:02:39 +0100 by phpDocumentor 1.3.1