includes/exception/FatalError.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 /**
  22  * Abort the web request with a custom HTML string that will represent
  23  * the entire response.
  24  *
  25  * This is not caught anywhere in MediaWiki code. It is handled through PHP's
  26  * exception handler, which calls MWExceptionHandler::report.
  27  *
  28  * Unlike MWException, this will not provide error IDs or stack traces.
  29  * It is intended for early installation and configuration problems where
  30  * the exception is all the site administrator needs to know.
  31  *
  32  * @newable
  33  * @stable to extend
  34  * @since 1.7
  35  * @ingroup Exception
  36  */
  37 class FatalError extends MWException {
  38
  39         /**
  40          * Replace our usual detailed HTML response for uncaught exceptions,
  41          * with just the bare message as HTML.
  42          *
  43          * @return string
  44          */
  45         public function getHTML() {
  46                 return $this->getMessage();
  47         }
  48
  49         /**
  50          * @return string
  51          */
  52         public function getText() {
  53                 return $this->getMessage();
  54         }
  55 }