includes/libs/rdbms/database/utils/QueryStatus.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @file
  19  */
  20 namespace Wikimedia\Rdbms;
  21
  22 /**
  23  * @since 1.39
  24  * @ingroup Database
  25  */
  26 class QueryStatus {
  27         /** @var ResultWrapper|bool|null Result set */
  28         public $res;
  29         /** @var int Returned row count */
  30         public $rowsReturned;
  31         /** @var int Affected row count */
  32         public $rowsAffected;
  33         /** @var string Error message or empty string */
  34         public $message;
  35         /** @var int|string Error code or zero */
  36         public $code;
  37         /** @var int Error flag bit field of Database::ERR_* constants */
  38         public $flags;
  39
  40         /**
  41          * @internal Should only be constructed by Database
  42          *
  43          * @param ResultWrapper|bool|null $res
  44          * @param int $affected
  45          * @param string $error
  46          * @param int|string $errno
  47          */
  48         public function __construct( $res, int $affected, string $error, $errno ) {
  49                 if ( !( $res instanceof IResultWrapper ) && !is_bool( $res ) && $res !== null ) {
  50                         throw new DBUnexpectedError(
  51                                 null,
  52                                 'Got ' . get_debug_type( $res ) . ' instead of IResultWrapper|bool'
  53                         );
  54                 }
  55
  56                 $this->res = $res;
  57                 $this->rowsReturned = ( $res instanceof IResultWrapper ) ? $res->numRows() : 0;
  58                 $this->rowsAffected = $affected;
  59                 $this->message = $error;
  60                 $this->code = $errno;
  61                 $this->flags = 0;
  62         }
  63 }