dba_fetch

Fetch data specified by key

Description

stringfalse dba_fetch(stringarray $key, Dba\Connection $dba, int $skip = 0)

Overloaded signature deprecated as of 8.3.0:

stringfalse dba_fetch(stringarray $key, int $skip, Dba\Connection $dba)

dba_fetch fetches the data specified by key from the database specified with dba.

Parameters

key
The key the data is specified by.

Note: 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.

dba
A Dba\Connection instance, returned by dba_open or dba_popen.
skip
The number of entries with the same key to skip before the one that is returned. Only the cdb and inifile handlers support it. With any other handler, a non-zero value is ignored and an E_NOTICE is raised. With cdb, a negative value is treated as 0. With inifile, a value below -1 is treated as 0. In both cases, an E_NOTICE is raised.

Return Values

Returns the associated string if the key/data pair is found, false otherwise.

Changelog

Version Description
8.4.0 The dba parameter expects a Dba\Connection instance now; previously, a valid dba resource was expected.
8.3.0 Calling dba_fetch with dba as the 3rd argument is now deprecated.
8.2.0 dba_fetch's optional skip argument is now at the end in line with PHP userland semantics. The previously overloaded signature is still accepted but discouraged.

See Also

  • dba_exists
  • dba_delete
  • dba_insert
  • dba_replace
  • dba_key_split