diff --git a/reference/dba/functions/dba-close.xml b/reference/dba/functions/dba-close.xml index 645f57ef03..7721aec59b 100644 --- a/reference/dba/functions/dba-close.xml +++ b/reference/dba/functions/dba-close.xml @@ -1,34 +1,51 @@ - - + dba_close Close a DBA database - - Description + + &reftitle.description; voiddba_close resourcehandle - dba_close closes the established database - and frees all resources specified by - handle. + dba_close closes the established database and frees + all resources of the specified database handle. + + + &reftitle.parameters; - handle is a database handle returned by - dba_open. + + + handle + + + The database handler, returned by dba_open or + dba_popen. + + + + + + + &reftitle.returnvalues; - dba_close does not return any value. + &return.void; + + + &reftitle.seealso; - See also - dba_open, and - dba_popen - + + dba_open + dba_popen + + diff --git a/reference/dba/functions/dba-delete.xml b/reference/dba/functions/dba-delete.xml index dc6938595f..933a76e1df 100644 --- a/reference/dba/functions/dba-delete.xml +++ b/reference/dba/functions/dba-delete.xml @@ -1,40 +1,60 @@ - - + dba_delete Delete DBA entry specified by key - - Description + + &reftitle.description; booldba_delete stringkey resourcehandle - dba_delete deletes the entry specified by - key from the database specified with - handle. + dba_delete deletes the specified entry from the database. + + + &reftitle.parameters; - key is the key of the entry which is - deleted. + + + key + + + The key of the entry which is deleted. + + + + + handle + + + The database handler, returned by dba_open or + dba_popen. + + + + + + + &reftitle.returnvalues; - handle is a database handle returned by - dba_open. + &return.success; + + + &reftitle.seealso; - dba_delete returns &true; or &false;, if the entry is - deleted or not deleted, respectively. - - - See also - dba_exists, - dba_fetch, dba_insert, - and dba_replace. + + dba_exists + dba_fetch + dba_insert + dba_replace + diff --git a/reference/dba/functions/dba-exists.xml b/reference/dba/functions/dba-exists.xml index 15d4a7ab3a..f74def22fc 100644 --- a/reference/dba/functions/dba-exists.xml +++ b/reference/dba/functions/dba-exists.xml @@ -1,13 +1,12 @@ - - + dba_exists Check whether key exists - - Description + + &reftitle.description; booldba_exists stringkey @@ -15,24 +14,48 @@ dba_exists checks whether the specified - key exists in the database specified by - handle. + key exists in the database. + + + &reftitle.parameters; - Key is the key the check is performed for. + + + key + + + The key the check is performed for. + + + + + handle + + + The database handler, returned by dba_open or + dba_popen. + + + + + + + &reftitle.returnvalues; - Handle is a database handle returned by - dba_open. + Returns &true; if the key exists, &false; otherwise. + + + &reftitle.seealso; - dba_exists returns &true; or &false;, if the key is found - or not found, respectively. - - - See also: dba_fetch, - dba_delete, dba_insert, - and dba_replace. + + dba_delete + dba_fetch + dba_insert + dba_replace + diff --git a/reference/dba/functions/dba-firstkey.xml b/reference/dba/functions/dba-firstkey.xml index aa768112bb..003c7a1a25 100644 --- a/reference/dba/functions/dba-firstkey.xml +++ b/reference/dba/functions/dba-firstkey.xml @@ -1,35 +1,52 @@ - - + dba_firstkey Fetch first key - - Description + + &reftitle.description; stringdba_firstkey resourcehandle - dba_firstkey returns the first key of the - database specified by handle and resets - the internal key pointer. This permits a linear search through + dba_firstkey returns the first key of the database + and resets the internal key pointer. This permits a linear search through the whole database. + + + &reftitle.parameters; - Handle is a database handle returned by - dba_open. + + + handle + + + The database handler, returned by dba_open or + dba_popen. + + + + + + + &reftitle.returnvalues; - dba_firstkey returns the key or &false; - depending on whether it succeeds or fails, respectively. + Returns the key on success, or &false; on failure. + + + &reftitle.seealso; - See also - dba_nextkey, dba_key_split - and example 2 in the DBA examples + + dba_nextkey + dba_key_split + Example 2 in the DBA examples + diff --git a/reference/dba/functions/dba-handlers.xml b/reference/dba/functions/dba-handlers.xml index 9eb0b91ab2..905bc955ab 100644 --- a/reference/dba/functions/dba-handlers.xml +++ b/reference/dba/functions/dba-handlers.xml @@ -1,26 +1,84 @@ - - + dba_handlers - List handlers available + List all the handlers available - - Description + + &reftitle.description; arraydba_handlers boolfull_info - dba_handlers returns an array with all handlers - supported by this extension. + dba_handlers list all the handlers supported by this + extension. + + + &reftitle.parameters; - When the internal cdb library is used you will see - 'cdb' and 'cdb_make'. + + + full_info + + + Turns on/off full information display in the result. The default is + &false;. + + + + + + + &reftitle.returnvalues; + + Returns an array of database handlers. If full_info + is set to &true;, the array will be associative with the handlers names as + keys, and their version information as value. Otherwise, the result will be + an indexed array of handlers names. + + + + When the internal cdb library is used you will see + cdb and cdb_make. + + + + + &reftitle.examples; + + + <function>dba_handlers</function> Example + + $handler_version) { + // clean the versions + $handler_version = str_replace('$', '', $handler_version); + echo " - $handler_name: $handler_version\n"; +} + +?> +]]> + + &example.outputs.similar; + + + + + diff --git a/reference/dba/functions/dba-insert.xml b/reference/dba/functions/dba-insert.xml index f661aa76d7..a8c0cc866c 100644 --- a/reference/dba/functions/dba-insert.xml +++ b/reference/dba/functions/dba-insert.xml @@ -1,13 +1,12 @@ - - + dba_insert Insert entry - - Description + + &reftitle.description; booldba_insert stringkey @@ -17,29 +16,58 @@ dba_insert inserts the entry described with key and value into the - database specified by handle. It fails, if an entry - with the same key already exists. + database. + + + &reftitle.parameters; - key is the key of the entry to be inserted. + + + key + + + The key of the entry to be inserted. If this key already exist in the + database, this function will fail. Use dba_replace + if you need to replace an existent key. + + + + + value + + + The value to be inserted. + + + + + handle + + + The database handler, returned by dba_open or + dba_popen. + + + + + + + &reftitle.returnvalues; - value is the value to be inserted. + &return.success; + + + &reftitle.seealso; - handle is a database handle returned by - dba_open. - - - dba_insert returns &true; or &false;, depending on - whether it succeeds of fails, respectively. - - - See also - dba_exists - dba_delete - dba_fetch - dba_replace + + dba_exists + dba_delete + dba_fetch + dba_replace + diff --git a/reference/dba/functions/dba-nextkey.xml b/reference/dba/functions/dba-nextkey.xml index 4c11dbec76..1b6586657e 100644 --- a/reference/dba/functions/dba-nextkey.xml +++ b/reference/dba/functions/dba-nextkey.xml @@ -1,34 +1,51 @@ - - + dba_nextkey Fetch next key - - Description + + &reftitle.description; stringdba_nextkey resourcehandle dba_nextkey returns the next key of the database - specified by handle and advances the internal - key pointer. + and advances the internal key pointer. + + + &reftitle.parameters; - handle is a database handle returned by - dba_open. + + + handle + + + The database handler, returned by dba_open or + dba_popen. + + + + + + + &reftitle.returnvalues; - dba_nextkey returns the key or &false; depending on - whether it succeeds or fails, respectively. + Returns the key on success, or &false; on failure. + + + &reftitle.seealso; - See also - dba_firstkey, dba_key_split - and example 2 in the DBA examples + + dba_firstkey + dba_key_split + Example 2 in the DBA examples + diff --git a/reference/dba/functions/dba-optimize.xml b/reference/dba/functions/dba-optimize.xml index deda5a730f..7d7cd6ad02 100644 --- a/reference/dba/functions/dba-optimize.xml +++ b/reference/dba/functions/dba-optimize.xml @@ -1,32 +1,48 @@ - - + dba_optimize Optimize database - - Description + + &reftitle.description; booldba_optimize resourcehandle - dba_optimize optimizes the underlying database - specified by handle. + dba_optimize optimizes the underlying database. + + + &reftitle.parameters; - handle is a database handle returned by - dba_open. + + + handle + + + The database handler, returned by dba_open or + dba_popen. + + + + + + + &reftitle.returnvalues; - dba_optimize returns &true; or &false;, if the - optimization succeeds or fails, respectively. + &return.success; + + + &reftitle.seealso; - See also: - dba_sync + + dba_sync + diff --git a/reference/dba/functions/dba-replace.xml b/reference/dba/functions/dba-replace.xml index 5f3c47294b..17f192a897 100644 --- a/reference/dba/functions/dba-replace.xml +++ b/reference/dba/functions/dba-replace.xml @@ -1,13 +1,12 @@ - - + dba_replace Replace or insert entry - - Description + + &reftitle.description; booldba_replace stringkey @@ -19,24 +18,54 @@ with key and value into the database specified by handle. + + + &reftitle.parameters; - key is the key of the entry to be inserted. + + + key + + + The key of the entry to be replaced. + + + + + value + + + The value to be replaced. + + + + + handle + + + The database handler, returned by dba_open or + dba_popen. + + + + + + + &reftitle.returnvalues; - value is the value to be inserted. + &return.success; + + + &reftitle.seealso; - handle is a database handle returned by - dba_open. - - - dba_replace returns &true; or &false;, depending on - whether it succeeds of fails, respectively. - - - See also: dba_exists, - dba_delete, dba_fetch, - and dba_insert. + + dba_exists + dba_delete + dba_fetch + dba_insert + diff --git a/reference/dba/functions/dba-sync.xml b/reference/dba/functions/dba-sync.xml index 9c15d3f446..dbeec945d9 100644 --- a/reference/dba/functions/dba-sync.xml +++ b/reference/dba/functions/dba-sync.xml @@ -1,32 +1,49 @@ - - + dba_sync Synchronize database - - Description + + &reftitle.description; booldba_sync resourcehandle - dba_sync synchronizes the database specified by - handle. This will probably trigger a physical write - to disk, if supported. + dba_sync synchronizes the database. This will probably + trigger a physical write to the disk, if supported. + + + &reftitle.parameters; - handle is a database handle returned by - dba_open. + + + handle + + + The database handler, returned by dba_open or + dba_popen. + + + + + + + &reftitle.returnvalues; - dba_sync returns &true; or &false;, if the - synchronization succeeds or fails, respectively. + &return.success; + + + &reftitle.seealso; - See also: dba_optimize + + dba_optimize +