Viewing file: DBIExtension.int.php (6.2 KB) -rw-rw-rw- Select action/file-type: (+) | (+) | (+) | Code (+) | Session (+) | (+) | SDB (+) | (+) | (+) | (+) | (+) | (+) |
<?php /** * Contract for every database extension supported by phpMyAdmin * * @package PhpMyAdmin-DBI */ if (! defined('PHPMYADMIN')) { exit; }
/** * Contract for every database extension supported by phpMyAdmin * * @package PhpMyAdmin-DBI */ interface PMA_DBI_Extension { /** * connects to the database server * * @param string $user user name * @param string $password user password * @param bool $is_controluser whether this is a control user connection * @param array $server host/port/socket/persistent * @param bool $auxiliary_connection (when true, don't go back to login if * connection fails) * * @return mixed false on error or a connection object on success */ public function connect( $user, $password, $is_controluser = false, $server = null, $auxiliary_connection = false );
/** * selects given database * * @param string $dbname database name to select * @param object $link connection object * * @return boolean */ public function selectDb($dbname, $link = null);
/** * runs a query and returns the result * * @param string $query query to execute * @param object $link connection object * @param int $options query options * * @return object|bool result */ public function realQuery($query, $link, $options);
/** * Run the multi query and output the results * * @param object $link connection object * @param string $query multi query statement to execute * * @return result collection | boolean(false) */ public function realMultiQuery($link, $query);
/** * returns array of rows with associative and numeric keys from $result * * @param object $result result set identifier * * @return array */ public function fetchArray($result);
/** * returns array of rows with associative keys from $result * * @param object $result result set identifier * * @return array */ public function fetchAssoc($result);
/** * returns array of rows with numeric keys from $result * * @param object $result result set identifier * * @return array */ public function fetchRow($result);
/** * Adjusts the result pointer to an arbitrary row in the result * * @param object $result database result * @param integer $offset offset to seek * * @return bool true on success, false on failure */ public function dataSeek($result, $offset);
/** * Frees memory associated with the result * * @param object $result database result * * @return void */ public function freeResult($result);
/** * Check if there are any more query results from a multi query * * @param object $link the connection object * * @return bool true or false */ public function moreResults($link = null);
/** * Prepare next result from multi_query * * @param object $link the connection object * * @return bool true or false */ public function nextResult($link = null);
/** * Store the result returned from multi query * * @return mixed false when empty results / result set when not empty */ public function storeResult();
/** * Returns a string representing the type of connection used * * @param object $link mysql link * * @return string type of connection used */ public function getHostInfo($link = null);
/** * Returns the version of the MySQL protocol used * * @param object $link mysql link * * @return integer version of the MySQL protocol used */ public function getProtoInfo($link = null);
/** * returns a string that represents the client library version * * @return string MySQL client library version */ public function getClientInfo();
/** * returns last error message or false if no errors occurred * * @param object $link connection link * * @return string|bool $error or false */ public function getError($link = null);
/** * returns the number of rows returned by last query * * @param object $result result set identifier * * @return string|int */ public function numRows($result);
/** * returns last inserted auto_increment id for given $link * or $GLOBALS['userlink'] * * @param object $link the connection object * * @return string|int */ public function insertId($link = null);
/** * returns the number of rows affected by last query * * @param object $link the connection object * @param bool $get_from_cache whether to retrieve from cache * * @return string|int */ public function affectedRows($link = null, $get_from_cache = true);
/** * returns metainfo for fields in $result * * @param object $result result set identifier * * @return array meta info for fields in $result */ public function getFieldsMeta($result);
/** * return number of fields in given $result * * @param object $result result set identifier * * @return int field count */ public function numFields($result);
/** * returns the length of the given field $i in $result * * @param object $result result set identifier * @param int $i field * * @return int length of field */ public function fieldLen($result, $i);
/** * returns name of $i. field in $result * * @param object $result result set identifier * @param int $i field * * @return string name of $i. field in $result */ public function fieldName($result, $i);
/** * returns concatenated string of human readable field flags * * @param object $result result set identifier * @param int $i field * * @return string field flags */ public function fieldFlags($result, $i); } ?>
|