includes/installer/InstallException.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
  21 namespace MediaWiki\Installer;
  22
  23 use MediaWiki\Status\Status;
  24 use Throwable;
  25
  26 /**
  27  * Exception thrown if an error occurs during installation
  28  * @ingroup Exception
  29  */
  30 class InstallException extends \MWException {
  31         /**
  32          * @var Status The state when an exception occurs
  33          */
  34         private $status;
  35
  36         /**
  37          * @param Status $status The state when an exception occurs
  38          * @param string $message The Exception message to throw
  39          * @param int $code The Exception code
  40          * @param Throwable|null $previous The previous throwable used for the exception chaining
  41          */
  42         public function __construct( Status $status, $message = '', $code = 0,
  43                 ?Throwable $previous = null ) {
  44                 parent::__construct( $message, $code, $previous );
  45                 $this->status = $status;
  46         }
  47
  48         public function getStatus(): Status {
  49                 return $this->status;
  50         }
  51 }