includes/installer/WebInstallerDocument.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  * @ingroup Installer
  20  */
  21
  22 namespace MediaWiki\Installer;
  23
  24 abstract class WebInstallerDocument extends WebInstallerPage {
  25
  26         /**
  27          * @return string
  28          */
  29         abstract protected function getFileName();
  30
  31         public function execute() {
  32                 $text = $this->getFileContents();
  33                 $text = InstallDocFormatter::format( $text );
  34                 $this->parent->output->addWikiTextAsInterface( $text );
  35                 $this->startForm();
  36                 $this->endForm( false );
  37                 return '';
  38         }
  39
  40         /**
  41          * @return string
  42          */
  43         public function getFileContents() {
  44                 $file = __DIR__ . '/../../' . $this->getFileName();
  45                 if ( !file_exists( $file ) ) {
  46                         return wfMessage( 'config-nofile', $file )->plain();
  47                 }
  48
  49                 return file_get_contents( $file );
  50         }
  51
  52 }