includes/DatabaseFunctions.php

   1 <?php
   2 /**
   3  * Backwards compatibility wrapper for Database.php
   4  *
   5  * Note: $wgDatabase has ceased to exist. Destroy all references.
   6  *
   7  * @package MediaWiki
   8  */
   9
  10 /**
  11  * Usually aborts on failure
  12  * If errors are explicitly ignored, returns success
  13  * @param string $sql SQL query
  14  * @param mixed $db database handler
  15  * @param string $fname name of the php function calling
  16  */
  17 function wfQuery( $sql, $db, $fname = '' ) {
  18         global $wgOut;
  19         if ( !is_numeric( $db ) ) {
  20                 # Someone has tried to call this the old way
  21                 $wgOut->fatalError( wfMsgNoDB( 'wrong_wfQuery_params', $db, $sql ) );
  22         }
  23         $c =& wfGetDB( $db );
  24         if ( $c !== false ) {
  25                 return $c->query( $sql, $fname );
  26         } else {
  27                 return false;
  28         }
  29 }
  30
  31 /**
  32  *
  33  * @param string $sql SQL query
  34  * @param $dbi
  35  * @param string $fname name of the php function calling
  36  * @return array first row from the database
  37  */
  38 function wfSingleQuery( $sql, $dbi, $fname = '' ) {
  39         $db =& wfGetDB( $dbi );
  40         $res = $db->query($sql, $fname );
  41         $row = $db->fetchRow( $res );
  42         $ret = $row[0];
  43         $db->freeResult( $res );
  44         return $ret;
  45 }
  46
  47 /*
  48  * @todo document function
  49  */
  50 function &wfGetDB( $db = DB_LAST, $groups = array() ) {
  51         global $wgLoadBalancer;
  52         return $wgLoadBalancer->getConnection( $db, true, $groups );
  53 }
  54
  55 /**
  56  * Turns on (false) or off (true) the automatic generation and sending
  57  * of a "we're sorry, but there has been a database error" page on
  58  * database errors. Default is on (false). When turned off, the
  59  * code should use wfLastErrno() and wfLastError() to handle the
  60  * situation as appropriate.
  61  *
  62  * @param $newstate
  63  * @param $dbi
  64  * @return Returns the previous state.
  65  */
  66 function wfIgnoreSQLErrors( $newstate, $dbi = DB_LAST ) {
  67         $db =& wfGetDB( $dbi );
  68         if ( $db !== false ) {
  69                 return $db->ignoreErrors( $newstate );
  70         } else {
  71                 return NULL;
  72         }
  73 }
  74
  75 /**#@+
  76  * @param $res database result handler
  77  * @param $dbi
  78 */
  79
  80 /**
  81  * Free a database result
  82  * @return bool whether result is sucessful or not
  83  */
  84 function wfFreeResult( $res, $dbi = DB_LAST )
  85 {
  86         $db =& wfGetDB( $dbi );
  87         if ( $db !== false ) {
  88                 $db->freeResult( $res );
  89                 return true;
  90         } else {
  91                 return false;
  92         }
  93 }
  94
  95 /**
  96  * Get an object from a database result
  97  * @return object|false object we requested
  98  */
  99 function wfFetchObject( $res, $dbi = DB_LAST ) {
 100         $db =& wfGetDB( $dbi );
 101         if ( $db !== false ) {
 102                 return $db->fetchObject( $res, $dbi = DB_LAST );
 103         } else {
 104                 return false;
 105         }
 106 }
 107
 108 /**
 109  * Get a row from a database result
 110  * @return object|false row we requested
 111  */
 112 function wfFetchRow( $res, $dbi = DB_LAST ) {
 113         $db =& wfGetDB( $dbi );
 114         if ( $db !== false ) {
 115                 return $db->fetchRow ( $res, $dbi = DB_LAST );
 116         } else {
 117                 return false;
 118         }
 119 }
 120
 121 /**
 122  * Get a number of rows from a database result
 123  * @return integer|false number of rows
 124  */
 125 function wfNumRows( $res, $dbi = DB_LAST ) {
 126         $db =& wfGetDB( $dbi );
 127         if ( $db !== false ) {
 128                 return $db->numRows( $res, $dbi = DB_LAST );
 129         } else {
 130                 return false;
 131         }
 132 }
 133
 134 /**
 135  * Get the number of fields from a database result
 136  * @return integer|false number of fields
 137  */
 138 function wfNumFields( $res, $dbi = DB_LAST ) {
 139         $db =& wfGetDB( $dbi );
 140         if ( $db !== false ) {
 141                 return $db->numFields( $res );
 142         } else {
 143                 return false;
 144         }
 145 }
 146
 147 /**
 148  * Return name of a field in a result
 149  * @param integer $n id of the field
 150  * @return string|false name of field
 151  */
 152 function wfFieldName( $res, $n, $dbi = DB_LAST )
 153 {
 154         $db =& wfGetDB( $dbi );
 155         if ( $db !== false ) {
 156                 return $db->fieldName( $res, $n, $dbi = DB_LAST );
 157         } else {
 158                 return false;
 159         }
 160 }
 161 /**#@-*/
 162
 163 /**
 164  * @todo document function
 165  */
 166 function wfInsertId( $dbi = DB_LAST ) {
 167         $db =& wfGetDB( $dbi );
 168         if ( $db !== false ) {
 169                 return $db->insertId();
 170         } else {
 171                 return false;
 172         }
 173 }
 174
 175 /**
 176  * @todo document function
 177  */
 178 function wfDataSeek( $res, $row, $dbi = DB_LAST ) {
 179         $db =& wfGetDB( $dbi );
 180         if ( $db !== false ) {
 181                 return $db->dataSeek( $res, $row );
 182         } else {
 183                 return false;
 184         }
 185 }
 186
 187 /**
 188  * @todo document function
 189  */
 190 function wfLastErrno( $dbi = DB_LAST ) {
 191         $db =& wfGetDB( $dbi );
 192         if ( $db !== false ) {
 193                 return $db->lastErrno();
 194         } else {
 195                 return false;
 196         }
 197 }
 198
 199 /**
 200  * @todo document function
 201  */
 202 function wfLastError( $dbi = DB_LAST ) {
 203         $db =& wfGetDB( $dbi );
 204         if ( $db !== false ) {
 205                 return $db->lastError();
 206         } else {
 207                 return false;
 208         }
 209 }
 210
 211 /**
 212  * @todo document function
 213  */
 214 function wfAffectedRows( $dbi = DB_LAST ) {
 215         $db =& wfGetDB( $dbi );
 216         if ( $db !== false ) {
 217                 return $db->affectedRows();
 218         } else {
 219                 return false;
 220         }
 221 }
 222
 223 /**
 224  * @todo document function
 225  */
 226 function wfLastDBquery( $dbi = DB_LAST ) {
 227         $db =& wfGetDB( $dbi );
 228         if ( $db !== false ) {
 229                 return $db->lastQuery();
 230         } else {
 231                 return false;
 232         }
 233 }
 234
 235 /**
 236  * @todo document function
 237  */
 238 function wfSetSQL( $table, $var, $value, $cond, $dbi = DB_MASTER )
 239 {
 240         $db =& wfGetDB( $dbi );
 241         if ( $db !== false ) {
 242                 return $db->set( $table, $var, $value, $cond );
 243         } else {
 244                 return false;
 245         }
 246 }
 247
 248
 249 /**
 250  * @todo document function
 251  */
 252 function wfGetSQL( $table, $var, $cond='', $dbi = DB_LAST )
 253 {
 254         $db =& wfGetDB( $dbi );
 255         if ( $db !== false ) {
 256                 return $db->selectField( $table, $var, $cond );
 257         } else {
 258                 return false;
 259         }
 260 }
 261
 262 /**
 263  * @todo document function
 264  */
 265 function wfFieldExists( $table, $field, $dbi = DB_LAST ) {
 266         $db =& wfGetDB( $dbi );
 267         if ( $db !== false ) {
 268                 return $db->fieldExists( $table, $field );
 269         } else {
 270                 return false;
 271         }
 272 }
 273
 274 /**
 275  * @todo document function
 276  */
 277 function wfIndexExists( $table, $index, $dbi = DB_LAST ) {
 278         $db =& wfGetDB( $dbi );
 279         if ( $db !== false ) {
 280                 return $db->indexExists( $table, $index );
 281         } else {
 282                 return false;
 283         }
 284 }
 285
 286 /**
 287  * @todo document function
 288  */
 289 function wfInsertArray( $table, $array, $fname = 'wfInsertArray', $dbi = DB_MASTER ) {
 290         $db =& wfGetDB( $dbi );
 291         if ( $db !== false ) {
 292                 return $db->insert( $table, $array, $fname );
 293         } else {
 294                 return false;
 295         }
 296 }
 297
 298 /**
 299  * @todo document function
 300  */
 301 function wfGetArray( $table, $vars, $conds, $fname = 'wfGetArray', $dbi = DB_LAST ) {
 302         $db =& wfGetDB( $dbi );
 303         if ( $db !== false ) {
 304                 return $db->getArray( $table, $vars, $conds, $fname );
 305         } else {
 306                 return false;
 307         }
 308 }
 309
 310 /**
 311  * @todo document function
 312  */
 313 function wfUpdateArray( $table, $values, $conds, $fname = 'wfUpdateArray', $dbi = DB_MASTER ) {
 314         $db =& wfGetDB( $dbi );
 315         if ( $db !== false ) {
 316                 $db->update( $table, $values, $conds, $fname );
 317                 return true;
 318         } else {
 319                 return false;
 320         }
 321 }
 322
 323 /**
 324  * @todo document function
 325  */
 326 function wfTableName( $name, $dbi = DB_LAST ) {
 327         $db =& wfGetDB( $dbi );
 328         if ( $db !== false ) {
 329                 return $db->tableName( $name );
 330         } else {
 331                 return false;
 332         }
 333 }
 334
 335 /**
 336  * @todo document function
 337  */
 338 function wfStrencode( $s, $dbi = DB_LAST ) {
 339         $db =& wfGetDB( $dbi );
 340         if ( $db !== false ) {
 341                 return $db->strencode( $s );
 342         } else {
 343                 return false;
 344         }
 345 }
 346
 347 /**
 348  * @todo document function
 349  */
 350 function wfNextSequenceValue( $seqName, $dbi = DB_MASTER ) {
 351         $db =& wfGetDB( $dbi );
 352         if ( $db !== false ) {
 353                 return $db->nextSequenceValue( $seqName );
 354         } else {
 355                 return false;
 356         }
 357 }
 358
 359 /**
 360  * @todo document function
 361  */
 362 function wfUseIndexClause( $index, $dbi = DB_SLAVE ) {
 363         $db =& wfGetDB( $dbi );
 364         if ( $db !== false ) {
 365                 return $db->useIndexClause( $index );
 366         } else {
 367                 return false;
 368         }
 369 }
 370 ?>