includes/db/DatabaseType.php

   1 <?php
   2 /**
   3  * Base interface for all DBMS-specific code.
   4  *
   5  * @file
   6  * @ingroup Database
   7  */
   8
   9 /**
  10  * Base interface for all DBMS-specific code. At a bare minimum, all of the
  11  * following must be implemented to support MediaWiki
  12  *
  13  * @ingroup Database
  14  */
  15 interface DatabaseType {
  16
  17         /**
  18          * Get the type of the DBMS, as it appears in $wgDBtype.
  19          *
  20          * @return string
  21          */
  22         public function getType();
  23
  24         /**
  25          * Open a connection to the database. Usually aborts on failure
  26          * If the failFunction is set to a non-zero integer, returns success
  27          *
  28          * @param $server String: database server host
  29          * @param $user String: database user name
  30          * @param $password String: database user password
  31          * @param $dbName String: database name
  32          * @return bool
  33          * @throws DBConnectionError
  34          */
  35         public function open( $server, $user, $password, $dbName );
  36
  37         /**
  38          * The DBMS-dependent part of query()
  39          * @todo @fixme Make this private someday
  40          *
  41          * @param  $sql String: SQL query.
  42          * @return Result object to feed to fetchObject, fetchRow, ...; or false on failure
  43          * @private
  44          */
  45         /*private*/ function doQuery( $sql );
  46
  47         /**
  48          * Fetch the next row from the given result object, in object form.
  49          * Fields can be retrieved with $row->fieldname, with fields acting like
  50          * member variables.
  51          *
  52          * @param $res SQL result object as returned from DatabaseBase::query(), etc.
  53          * @return Row object
  54          * @throws DBUnexpectedError Thrown if the database returns an error
  55          */
  56         public function fetchObject( $res );
  57
  58         /**
  59          * Fetch the next row from the given result object, in associative array
  60          * form.  Fields are retrieved with $row['fieldname'].
  61          *
  62          * @param $res SQL result object as returned from DatabaseBase::query(), etc.
  63          * @return Row object
  64          * @throws DBUnexpectedError Thrown if the database returns an error
  65          */
  66         public function fetchRow( $res );
  67
  68         /**
  69          * Get the number of rows in a result object
  70          *
  71          * @param $res Mixed: A SQL result
  72          * @return int
  73          */
  74         public function numRows( $res );
  75
  76         /**
  77          * Get the number of fields in a result object
  78          * @see http://www.php.net/mysql_num_fields
  79          *
  80          * @param $res Mixed: A SQL result
  81          * @return int
  82          */
  83         public function numFields( $res );
  84
  85         /**
  86          * Get a field name in a result object
  87          * @see http://www.php.net/mysql_field_name
  88          *
  89          * @param $res Mixed: A SQL result
  90          * @param $n Integer
  91          * @return string
  92          */
  93         public function fieldName( $res, $n );
  94
  95         /**
  96          * Get the inserted value of an auto-increment row
  97          *
  98          * The value inserted should be fetched from nextSequenceValue()
  99          *
 100          * Example:
 101          * $id = $dbw->nextSequenceValue('page_page_id_seq');
 102          * $dbw->insert('page',array('page_id' => $id));
 103          * $id = $dbw->insertId();
 104          *
 105          * @return int
 106          */
 107         public function insertId();
 108
 109         /**
 110          * Change the position of the cursor in a result object
 111          * @see http://www.php.net/mysql_data_seek
 112          *
 113          * @param $res Mixed: A SQL result
 114          * @param $row Mixed: Either MySQL row or ResultWrapper
 115          */
 116         public function dataSeek( $res, $row );
 117
 118         /**
 119          * Get the last error number
 120          * @see http://www.php.net/mysql_errno
 121          *
 122          * @return int
 123          */
 124         public function lastErrno();
 125
 126         /**
 127          * Get a description of the last error
 128          * @see http://www.php.net/mysql_error
 129          *
 130          * @return string
 131          */
 132         public function lastError();
 133
 134         /**
 135          * mysql_fetch_field() wrapper
 136          * Returns false if the field doesn't exist
 137          *
 138          * @param $table string: table name
 139          * @param $field string: field name
 140          */
 141         public function fieldInfo( $table, $field );
 142
 143         /**
 144          * Get the number of rows affected by the last write query
 145          * @see http://www.php.net/mysql_affected_rows
 146          *
 147          * @return int
 148          */
 149         public function affectedRows();
 150
 151         /**
 152          * Wrapper for addslashes()
 153          *
 154          * @param $s string: to be slashed.
 155          * @return string: slashed string.
 156          */
 157         public function strencode( $s );
 158
 159         /**
 160          * Returns a wikitext link to the DB's website, e.g.,
 161          *     return "[http://www.mysql.com/ MySQL]";
 162          * Should at least contain plain text, if for some reason
 163          * your database has no website.
 164          *
 165          * @return string: wikitext of a link to the server software's web site
 166          */
 167         public static function getSoftwareLink();
 168
 169         /**
 170          * A string describing the current software version, like from
 171          * mysql_get_server_info().  Will be listed on Special:Version, etc.
 172          *
 173          * @return string: Version information from the database
 174          */
 175         public function getServerVersion();
 176 }