libraries/dbi/DBIExtension.int.php

   1 <?php
   2 /**
   3  * Contract for every database extension supported by phpMyAdmin
   4  *
   5  * @package PhpMyAdmin-DBI
   6  */
   7 if (! defined('PHPMYADMIN')) {
   8     exit;
   9 }
  10
  11 /**
  12  * Contract for every database extension supported by phpMyAdmin
  13  *
  14  * @package PhpMyAdmin-DBI
  15  */
  16 interface PMA_DBI_Extension
  17 {
  18     /**
  19      * connects to the database server
  20      *
  21      * @param string $user                 user name
  22      * @param string $password             user password
  23      * @param bool   $is_controluser       whether this is a control user connection
  24      * @param array  $server               host/port/socket/persistent
  25      * @param bool   $auxiliary_connection (when true, don't go back to login if
  26      *                                     connection fails)
  27      *
  28      * @return mixed false on error or a connection object on success
  29      */
  30     public function connect(
  31         $user, $password, $is_controluser = false, $server = null,
  32         $auxiliary_connection = false
  33     );
  34
  35     /**
  36      * selects given database
  37      *
  38      * @param string $dbname database name to select
  39      * @param object $link   connection object
  40      *
  41      * @return boolean
  42      */
  43     public function selectDb($dbname, $link = null);
  44
  45     /**
  46      * runs a query and returns the result
  47      *
  48      * @param string $query   query to execute
  49      * @param object $link    connection object
  50      * @param int    $options query options
  51      *
  52      * @return result object|bool
  53      */
  54     public function realQuery($query, $link, $options);
  55
  56     /**
  57      * Run the multi query and output the results
  58      *
  59      * @param object $link  connection object
  60      * @param string $query multi query statement to execute
  61      *
  62      * @return result collection | boolean(false)
  63      */
  64     public function realMultiQuery($link, $query);
  65
  66     /**
  67      * returns array of rows with associative and numeric keys from $result
  68      *
  69      * @param object $result result set identifier
  70      *
  71      * @return array
  72      */
  73     public function fetchArray($result);
  74
  75     /**
  76      * returns array of rows with associative keys from $result
  77      *
  78      * @param object $result result set identifier
  79      *
  80      * @return array
  81      */
  82     public function fetchAssoc($result);
  83
  84     /**
  85      * returns array of rows with numeric keys from $result
  86      *
  87      * @param object $result result set identifier
  88      *
  89      * @return array
  90      */
  91     public function fetchRow($result);
  92
  93     /**
  94      * Adjusts the result pointer to an arbitrary row in the result
  95      *
  96      * @param object  $result database result
  97      * @param integer $offset offset to seek
  98      *
  99      * @return bool true on success, false on failure
 100      */
 101     public function dataSeek($result, $offset);
 102
 103     /**
 104      * Frees memory associated with the result
 105      *
 106      * @param object $result database result
 107      *
 108      * @return void
 109      */
 110     public function freeResult($result);
 111
 112     /**
 113      * Check if there are any more query results from a multi query
 114      *
 115      * @param object $link the connection object
 116      *
 117      * @return bool true or false
 118      */
 119     public function moreResults($link = null);
 120
 121     /**
 122      * Prepare next result from multi_query
 123      *
 124      * @param objecy $link the connection object
 125      *
 126      * @return bool true or false
 127      */
 128     public function nextResult($link = null);
 129
 130     /**
 131      * Store the result returned from multi query
 132      *
 133      * @return mixed false when empty results / result set when not empty
 134      */
 135     public function storeResult();
 136
 137     /**
 138      * Returns a string representing the type of connection used
 139      *
 140      * @param object $link mysql link
 141      *
 142      * @return string type of connection used
 143      */
 144     public function getHostInfo($link = null);
 145
 146     /**
 147      * Returns the version of the MySQL protocol used
 148      *
 149      * @param object $link mysql link
 150      *
 151      * @return integer version of the MySQL protocol used
 152      */
 153     public function getProtoInfo($link = null);
 154
 155     /**
 156      * returns a string that represents the client library version
 157      *
 158      * @return string MySQL client library version
 159      */
 160     public function getClientInfo();
 161
 162     /**
 163      * returns last error message or false if no errors occured
 164      *
 165      * @param object $link connection link
 166      *
 167      * @return string|bool $error or false
 168      */
 169     public function getError($link = null);
 170
 171     /**
 172      * returns the number of rows returned by last query
 173      *
 174      * @param object $result result set identifier
 175      *
 176      * @return string|int
 177      */
 178     public function numRows($result);
 179
 180     /**
 181      * returns last inserted auto_increment id for given $link
 182      * or $GLOBALS['userlink']
 183      *
 184      * @param object $link the connection object
 185      *
 186      * @return string|int
 187      */
 188     public function insertId($link = null);
 189
 190     /**
 191      * returns the number of rows affected by last query
 192      *
 193      * @param object $link           the connection object
 194      * @param bool   $get_from_cache whether to retrieve from cache
 195      *
 196      * @return string|int
 197      */
 198     public function affectedRows($link = null, $get_from_cache = true);
 199
 200     /**
 201      * returns metainfo for fields in $result
 202      *
 203      * @param object $result result set identifier
 204      *
 205      * @return array meta info for fields in $result
 206      */
 207     public function getFieldsMeta($result);
 208
 209     /**
 210      * return number of fields in given $result
 211      *
 212      * @param object $result result set identifier
 213      *
 214      * @return int field count
 215      */
 216     public function numFields($result);
 217
 218     /**
 219      * returns the length of the given field $i in $result
 220      *
 221      * @param object $result result set identifier
 222      * @param int    $i      field
 223      *
 224      * @return int length of field
 225      */
 226     public function fieldLen($result, $i);
 227
 228     /**
 229      * returns name of $i. field in $result
 230      *
 231      * @param object $result result set identifier
 232      * @param int    $i      field
 233      *
 234      * @return string name of $i. field in $result
 235      */
 236     public function fieldName($result, $i);
 237
 238     /**
 239      * returns concatenated string of human readable field flags
 240      *
 241      * @param object $result result set identifier
 242      * @param int    $i      field
 243      *
 244      * @return string field flags
 245      */
 246     public function fieldFlags($result, $i);
 247 }
 248 ?>