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  * @version # $Id$
   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 ) {
  51         global $wgLoadBalancer;
  52         return $wgLoadBalancer->getConnection( $db );
  53 }
  54
  55 /**
  56  * Turns buffering of SQL result
  57  * Sets on (true) or off (false). Default is "on" and it should not be changed
  58  * without good reasons.
  59  *
  60  * @param $newstate
  61  * @param $dbi
  62  * @return mixed|NULL Returns the previous state.
  63 */
  64 function wfBufferSQLResults( $newstate, $dbi = DB_LAST ) {
  65         $db =& wfGetDB( $dbi );
  66         if ( $db !== false ) {
  67                 return $db->setBufferResults( $newstate );
  68         } else {
  69                 return NULL;
  70         }
  71 }
  72
  73 /**
  74  * Turns on (false) or off (true) the automatic generation and sending
  75  * of a "we're sorry, but there has been a database error" page on
  76  * database errors. Default is on (false). When turned off, the
  77  * code should use wfLastErrno() and wfLastError() to handle the
  78  * situation as appropriate.
  79  *
  80  * @param $newstate
  81  * @param $dbi
  82  * @return Returns the previous state.
  83  */
  84 function wfIgnoreSQLErrors( $newstate, $dbi = DB_LAST ) {
  85         $db =& wfGetDB( $dbi );
  86         if ( $db !== false ) {
  87                 return $db->ignoreErrors( $newstate );
  88         } else {
  89                 return NULL;
  90         }
  91 }
  92
  93 /**@#+
  94  * @param $res database result handler
  95  * @param $dbi
  96 */
  97
  98 /**
  99  * Free a database result
 100  * @return bool whether result is sucessful or not
 101  */
 102 function wfFreeResult( $res, $dbi = DB_LAST )
 103 {
 104         $db =& wfGetDB( $dbi );
 105         if ( $db !== false ) {
 106                 $db->freeResult( $res );
 107                 return true;
 108         } else {
 109                 return false;
 110         }
 111 }
 112
 113 /**
 114  * Get an object from a database result
 115  * @return object|false object we requested
 116  */
 117 function wfFetchObject( $res, $dbi = DB_LAST ) {
 118         $db =& wfGetDB( $dbi );
 119         if ( $db !== false ) {
 120                 return $db->fetchObject( $res, $dbi = DB_LAST );
 121         } else {
 122                 return false;
 123         }
 124 }
 125
 126 /**
 127  * Get a row from a database result
 128  * @return object|false row we requested
 129  */
 130 function wfFetchRow( $res, $dbi = DB_LAST ) {
 131         $db =& wfGetDB( $dbi );
 132         if ( $db !== false ) {
 133                 return $db->fetchRow ( $res, $dbi = DB_LAST );
 134         } else {
 135                 return false;
 136         }
 137 }
 138
 139 /**
 140  * Get a number of rows from a database result
 141  * @return integer|false number of rows
 142  */
 143 function wfNumRows( $res, $dbi = DB_LAST ) {
 144         $db =& wfGetDB( $dbi );
 145         if ( $db !== false ) {
 146                 return $db->numRows( $res, $dbi = DB_LAST );
 147         } else {
 148                 return false;
 149         }
 150 }
 151
 152 /**
 153  * Get the number of fields from a database result
 154  * @return integer|false number of fields
 155  */
 156 function wfNumFields( $res, $dbi = DB_LAST ) {
 157         $db =& wfGetDB( $dbi );
 158         if ( $db !== false ) {
 159                 return $db->numFields( $res );
 160         } else {
 161                 return false;
 162         }
 163 }
 164
 165 /**
 166  * Return name of a field in a result
 167  * @param integer $n id of the field
 168  * @return string|false name of field
 169  */
 170 function wfFieldName( $res, $n, $dbi = DB_LAST )
 171 {
 172         $db =& wfGetDB( $dbi );
 173         if ( $db !== false ) {
 174                 return $db->fieldName( $res, $n, $dbi = DB_LAST );
 175         } else {
 176                 return false;
 177         }
 178 }
 179 /**@#-*/
 180
 181 /**
 182  * @todo document function
 183  */
 184 function wfInsertId( $dbi = DB_LAST ) {
 185         $db =& wfGetDB( $dbi );
 186         if ( $db !== false ) {
 187                 return $db->insertId();
 188         } else {
 189                 return false;
 190         }
 191 }
 192
 193 /**
 194  * @todo document function
 195  */
 196 function wfDataSeek( $res, $row, $dbi = DB_LAST ) {
 197         $db =& wfGetDB( $dbi );
 198         if ( $db !== false ) {
 199                 return $db->dataSeek( $res, $row );
 200         } else {
 201                 return false;
 202         }
 203 }
 204
 205 /**
 206  * @todo document function
 207  */
 208 function wfLastErrno( $dbi = DB_LAST ) {
 209         $db =& wfGetDB( $dbi );
 210         if ( $db !== false ) {
 211                 return $db->lastErrno();
 212         } else {
 213                 return false;
 214         }
 215 }
 216
 217 /**
 218  * @todo document function
 219  */
 220 function wfLastError( $dbi = DB_LAST ) {
 221         $db =& wfGetDB( $dbi );
 222         if ( $db !== false ) {
 223                 return $db->lastError();
 224         } else {
 225                 return false;
 226         }
 227 }
 228
 229 /**
 230  * @todo document function
 231  */
 232 function wfAffectedRows( $dbi = DB_LAST ) {
 233         $db =& wfGetDB( $dbi );
 234         if ( $db !== false ) {
 235                 return $db->affectedRows();
 236         } else {
 237                 return false;
 238         }
 239 }
 240
 241 /**
 242  * @todo document function
 243  */
 244 function wfLastDBquery( $dbi = DB_LAST ) {
 245         $db =& wfGetDB( $dbi );
 246         if ( $db !== false ) {
 247                 return $db->lastQuery();
 248         } else {
 249                 return false;
 250         }
 251 }
 252
 253 /**
 254  * @todo document function
 255  */
 256 function wfSetSQL( $table, $var, $value, $cond, $dbi = DB_MASTER )
 257 {
 258         $db =& wfGetDB( $dbi );
 259         if ( $db !== false ) {
 260                 return $db->set( $table, $var, $value, $cond );
 261         } else {
 262                 return false;
 263         }
 264 }
 265
 266
 267 /**
 268  * @todo document function
 269  */
 270 function wfGetSQL( $table, $var, $cond='', $dbi = DB_LAST )
 271 {
 272         $db =& wfGetDB( $dbi );
 273         if ( $db !== false ) {
 274                 return $db->getField( $table, $var, $cond );
 275         } else {
 276                 return false;
 277         }
 278 }
 279
 280 /**
 281  * @todo document function
 282  */
 283 function wfFieldExists( $table, $field, $dbi = DB_LAST ) {
 284         $db =& wfGetDB( $dbi );
 285         if ( $db !== false ) {
 286                 return $db->fieldExists( $table, $field );
 287         } else {
 288                 return false;
 289         }
 290 }
 291
 292 /**
 293  * @todo document function
 294  */
 295 function wfIndexExists( $table, $index, $dbi = DB_LAST ) {
 296         $db =& wfGetDB( $dbi );
 297         if ( $db !== false ) {
 298                 return $db->indexExists( $table, $index );
 299         } else {
 300                 return false;
 301         }
 302 }
 303
 304 /**
 305  * @todo document function
 306  */
 307 function wfInsertArray( $table, $array, $fname = 'wfInsertArray', $dbi = DB_MASTER ) {
 308         $db =& wfGetDB( $dbi );
 309         if ( $db !== false ) {
 310                 return $db->insertArray( $table, $array, $fname );
 311         } else {
 312                 return false;
 313         }
 314 }
 315
 316 /**
 317  * @todo document function
 318  */
 319 function wfGetArray( $table, $vars, $conds, $fname = 'wfGetArray', $dbi = DB_LAST ) {
 320         $db =& wfGetDB( $dbi );
 321         if ( $db !== false ) {
 322                 return $db->getArray( $table, $vars, $conds, $fname );
 323         } else {
 324                 return false;
 325         }
 326 }
 327
 328 /**
 329  * @todo document function
 330  */
 331 function wfUpdateArray( $table, $values, $conds, $fname = 'wfUpdateArray', $dbi = DB_MASTER ) {
 332         $db =& wfGetDB( $dbi );
 333         if ( $db !== false ) {
 334                 $db->updateArray( $table, $values, $conds, $fname );
 335                 return true;
 336         } else {
 337                 return false;
 338         }
 339 }
 340
 341 /**
 342  * @todo document function
 343  */
 344 function wfTableName( $name, $dbi = DB_LAST ) {
 345         $db =& wfGetDB( $dbi );
 346         if ( $db !== false ) {
 347                 return $db->tableName( $name );
 348         } else {
 349                 return false;
 350         }
 351 }
 352
 353 /**
 354  * @todo document function
 355  */
 356 function wfStrencode( $s, $dbi = DB_LAST ) {
 357         $db =& wfGetDB( $dbi );
 358         if ( $db !== false ) {
 359                 return $db->strencode( $s );
 360         } else {
 361                 return false;
 362         }
 363 }
 364
 365 /**
 366  * @todo document function
 367  */
 368 function wfNextSequenceValue( $seqName, $dbi = DB_MASTER ) {
 369         $db =& wfGetDB( $dbi );
 370         if ( $db !== false ) {
 371                 return $db->nextSequenceValue( $seqName );
 372         } else {
 373                 return false;
 374         }
 375 }
 376
 377 /**
 378  * @todo document function
 379  */
 380 function wfUseIndexClause( $index, $dbi = DB_SLAVE ) {
 381         $db =& wfGetDB( $dbi );
 382         if ( $db !== false ) {
 383                 return $db->useIndexClause( $index );
 384         } else {
 385                 return false;
 386         }
 387 }
 388 ?>