includes/shell/Result.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\Shell;
  22
  23 /**
  24  * Returned by MediaWiki\Shell\Command::execute()
  25  *
  26  * @since 1.30
  27  */
  28 class Result {
  29         /** @var int */
  30         private $exitCode;
  31
  32         /** @var string */
  33         private $stdout;
  34
  35         /** @var string|null */
  36         private $stderr;
  37
  38         /**
  39          * @param int $exitCode
  40          * @param string $stdout
  41          */
  42         public function __construct( $exitCode, $stdout, $stderr = null ) {
  43                 $this->exitCode = $exitCode;
  44                 $this->stdout = $stdout;
  45                 $this->stderr = $stderr;
  46         }
  47
  48         /**
  49          * Returns exit code of the process
  50          *
  51          * @return int
  52          */
  53         public function getExitCode() {
  54                 return $this->exitCode;
  55         }
  56
  57         /**
  58          * Returns stdout of the process
  59          *
  60          * @return string
  61          */
  62         public function getStdout() {
  63                 return $this->stdout;
  64         }
  65
  66         /**
  67          * Returns stderr of the process or null if the Command was configured to add stderr to stdout
  68          * with includeStderr( true )
  69          *
  70          * @return string|null
  71          */
  72         public function getStderr() {
  73                 return $this->stderr;
  74         }
  75 }