* It is r for read access, w for * read/write access to an already existing database, c * for read/write access and database creation if it doesn't currently exist, * and n for create, truncate and read/write access. * The database is created in BTree mode, other modes (like Hash or Queue) * are not supported. *
** Additionally you can set the database lock method with the next char. * Use l to lock the database with a .lck * file or d to lock the databasefile itself. It is * important that all of your applications do this consistently. *
** If you want to test the access and do not want to wait for the lock * you can add t as third character. When you are * absolutely sure that you do not require database locking you can do * so by using - instead of l or * d. When none of d, * l or - is used, dba will lock * on the database file as it would with d. *
** There can only be one writer for one database file. When you use dba on * a web server and more than one request requires write operations they can * only be done one after another. Also read during write is not allowed. * The dba extension uses locks to prevent this. See the following table: *
| already open | *mode = "rl" | *mode = "rlt" | *mode = "wl" | *mode = "wlt" | *mode = "rd" | *mode = "rdt" | *mode = "wd" | *mode = "wdt" | *
| not open | *ok | *ok | *ok | *ok | *ok | *ok | *ok | *ok | *
| mode = "rl" | *ok | *ok | *wait | *false | *illegal | *illegal | *illegal | *illegal | *
| mode = "wl" | *wait | *false | *wait | *false | *illegal | *illegal | *illegal | *illegal | *
| mode = "rd" | *illegal | *illegal | *illegal | *illegal | *ok | *ok | *wait | *false | *
| mode = "wd" | *illegal | *illegal | *illegal | *illegal | *wait | *false | *wait | *false | *
* The name of the handler which * shall be used for accessing path. It is passed * all optional parameters given to dba_open and * can act on behalf of them. *
* @param mixed ...$handler_params [optional] * @return resource|false a positive handle on success or FALSE on failure. */ #[PhpStormStubsElementAvailable(from: '5.3', to: '8.1')] function dba_open($path, $mode, $handler, ...$handler_params) {} #[PhpStormStubsElementAvailable(from: '8.2')] function dba_open(string $path, string $mode, ?string $handler = null, int $permission = 0o644, int $map_size = 0, ?int $flags = null) {} /** * Open database persistently * @link https://php.net/manual/en/function.dba-popen.php * @param string $path* Commonly a regular path in your filesystem. *
* @param string $mode* It is r for read access, w for * read/write access to an already existing database, c * for read/write access and database creation if it doesn't currently exist, * and n for create, truncate and read/write access. *
* @param string $handler [optional]* The name of the handler which * shall be used for accessing path. It is passed * all optional parameters given to dba_popen and * can act on behalf of them. *
* @param mixed ...$handler_params [optional] * @return resource|false a positive handle on success or FALSE on failure. */ #[PhpStormStubsElementAvailable(from: '5.3', to: '8.1')] function dba_popen($path, $mode, $handler, ...$handler_params) {} #[PhpStormStubsElementAvailable(from: '8.2')] function dba_popen(string $path, string $mode, ?string $handler = null, int $permission = 0o644, int $map_size = 0, ?int $flags = null) {} /** * Close a DBA database * @link https://php.net/manual/en/function.dba-close.php * @param resource $dba* The database handler, returned by dba_open or * dba_popen. *
* @return void No value is returned. */ function dba_close($dba): void {} /** * Delete DBA entry specified by key * @link https://php.net/manual/en/function.dba-delete.php * @param string $key* The key of the entry which is deleted. *
* @param resource $dba* The database handler, returned by dba_open or * dba_popen. *
* @return bool TRUE on success or FALSE on failure. */ function dba_delete(#[LanguageLevelTypeAware(['8.2' => 'array|string'], default: '')] $key, $dba): bool {} /** * Check whether key exists * @link https://php.net/manual/en/function.dba-exists.php * @param string $key* The key the check is performed for. *
* @param resource $dba* The database handler, returned by dba_open or * dba_popen. *
* @return bool TRUE if the key exists, FALSE otherwise. */ function dba_exists(#[LanguageLevelTypeAware(['8.2' => 'array|string'], default: '')] $key, $dba): bool {} /** * Fetch data specified by key * @link https://php.net/manual/en/function.dba-fetch.php * @param string $key* The key the data is specified by. *
** When working with inifiles this function accepts arrays as keys * where index 0 is the group and index 1 is the value name. See: * dba_key_split. *
* @param resource $handle* The database handler, returned by dba_open or * dba_popen. *
* @return string|false the associated string if the key/data pair is found, FALSE * otherwise. */ function dba_fetch($key, $handle): string|false {} /** * Fetch data specified by key * @link https://php.net/manual/en/function.dba-fetch.php * @param string $key* The key the data is specified by. *
** When working with inifiles this function accepts arrays as keys * where index 0 is the group and index 1 is the value name. See: * dba_key_split. *
* @param int $skip The number of key-value pairs to ignore when using cdb databases. This value is ignored for all other databases which do not support multiple keys with the same name. * @param resource $dba* The database handler, returned by dba_open or * dba_popen. *
* @return string|false the associated string if the key/data pair is found, FALSE * otherwise. */ function dba_fetch($key, $skip, $dba): string|false {} /** * Insert entry * @link https://php.net/manual/en/function.dba-insert.php * @param string $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. *
* @param string $value* The value to be inserted. *
* @param resource $dba* The database handler, returned by dba_open or * dba_popen. *
* @return bool TRUE on success or FALSE on failure. */ function dba_insert(#[LanguageLevelTypeAware(['8.2' => 'array|string'], default: '')] $key, string $value, $dba): bool {} /** * Replace or insert entry * @link https://php.net/manual/en/function.dba-replace.php * @param string $key* The key of the entry to be replaced. *
* @param string $value* The value to be replaced. *
* @param resource $dba* The database handler, returned by dba_open or * dba_popen. *
* @return bool TRUE on success or FALSE on failure. */ function dba_replace(#[LanguageLevelTypeAware(['8.2' => 'array|string'], default: '')] $key, string $value, $dba): bool {} /** * Fetch first key * @link https://php.net/manual/en/function.dba-firstkey.php * @param resource $dba* The database handler, returned by dba_open or * dba_popen. *
* @return string|false the key on success or FALSE on failure. */ function dba_firstkey($dba): string|false {} /** * Fetch next key * @link https://php.net/manual/en/function.dba-nextkey.php * @param resource $dba* The database handler, returned by dba_open or * dba_popen. *
* @return string|false the key on success or FALSE on failure. */ function dba_nextkey($dba): string|false {} /** * Optimize database * @link https://php.net/manual/en/function.dba-optimize.php * @param resource $dba* The database handler, returned by dba_open or * dba_popen. *
* @return bool TRUE on success or FALSE on failure. */ function dba_optimize($dba): bool {} /** * Synchronize database * @link https://php.net/manual/en/function.dba-sync.php * @param resource $dba* The database handler, returned by dba_open or * dba_popen. *
* @return bool TRUE on success or FALSE on failure. */ function dba_sync($dba): bool {} /** * List all the handlers available * @link https://php.net/manual/en/function.dba-handlers.php * @param bool $full_info [optional]* Turns on/off full information display in the result. *
* @return array 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. */ function dba_handlers(bool $full_info = false): array {} /** * List all open database files * @link https://php.net/manual/en/function.dba-list.php * @return array An associative array, in the form resourceid => filename. */ function dba_list(): array {} /** * Splits a key in string representation into array representation * @link https://php.net/manual/en/function.dba-key-split.php * @param string|false|null $key
* The key in string representation. *
* @return array|false an array of the form array(0 => group, 1 => * value_name). This function will return FALSE if * key is NULL or FALSE. */ function dba_key_split(string|false|null $key): array|false {} // End of dba v.