includes/shell/CommandFactory.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 use Psr\Log\LoggerAwareTrait;
  24 use Psr\Log\NullLogger;
  25
  26 /**
  27  * Factory facilitating dependency injection for Command
  28  *
  29  * @since 1.30
  30  */
  31 class CommandFactory {
  32         use LoggerAwareTrait;
  33
  34         /** @var array */
  35         private $limits;
  36
  37         /** @var string|bool */
  38         private $cgroup;
  39
  40         /** @var bool */
  41         private $doLogStderr = false;
  42
  43         /**
  44          * Constructor
  45          *
  46          * @param array $limits See {@see Command::limits()}
  47          * @param string|bool $cgroup See {@see Command::cgroup()}
  48          */
  49         public function __construct( array $limits, $cgroup ) {
  50                 $this->limits = $limits;
  51                 $this->cgroup = $cgroup;
  52                 $this->setLogger( new NullLogger() );
  53         }
  54
  55         /**
  56          * When enabled, text sent to stderr will be logged with a level of 'error'.
  57          *
  58          * @param bool $yesno
  59          * @see Command::logStderr
  60          */
  61         public function logStderr( $yesno = true ) {
  62                 $this->doLogStderr = $yesno;
  63         }
  64
  65         /**
  66          * Instantiates a new Command
  67          *
  68          * @return Command
  69          */
  70         public function create() {
  71                 $command = new Command();
  72                 $command->setLogger( $this->logger );
  73
  74                 return $command
  75                         ->limits( $this->limits )
  76                         ->cgroup( $this->cgroup )
  77                         ->logStderr( $this->doLogStderr );
  78         }
  79 }