MediaWiki\Shell\Command Class Reference

Class used for executing shell commands. More...

Inheritance diagram for MediaWiki\Shell\Command:

Collaboration diagram for MediaWiki\Shell\Command:

Public Member Functions
	__construct (UnboxedExecutor $executor)
	Don't call directly, instead use Shell::command() More...
	__destruct ()
	Makes sure the programmer didn't forget to execute the command after all. More...
	__toString ()
	Returns the final command line before environment/limiting, etc are applied. More...
	execute ()
	Executes command. More...
	input (string $inputString)
	Sends the provided input to the command. More...
	limits (array $limits)
	Sets execution limits. More...
	profileMethod (string $method)
	Sets calling function for profiler. More...
	restrict (int $restrictions)
	Set restrictions for this request, overwriting any previously set restrictions. More...
	setLogger (LoggerInterface $logger)
	whitelistPaths (array $paths)
	If called, only the files/directories that are whitelisted will be available to the shell command. More...

Protected Attributes
LoggerInterface	$logger

Detailed Description

Class used for executing shell commands.

Since

1.30

Definition at line 39 of file Command.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\Shell\Command::__construct

(

UnboxedExecutor

$executor

)

Don't call directly, instead use Shell::command()

Parameters

UnboxedExecutor

$executor

Exceptions

ShellDisabledError

Definition at line 55 of file Command.php.

References MediaWiki\Shell\Shell\isDisabled(), and MediaWiki\Shell\Command\setLogger().

__destruct()

MediaWiki\Shell\Command::__destruct

(

)

Makes sure the programmer didn't forget to execute the command after all.

Definition at line 66 of file Command.php.

Member Function Documentation

__toString()

MediaWiki\Shell\Command::__toString

(

)

Returns the final command line before environment/limiting, etc are applied.

Use string conversion only for debugging, don't try to pass this to some other execution medium.

Returns

string

Definition at line 228 of file Command.php.

execute()

MediaWiki\Shell\Command::execute

(

)

Executes command.

Afterwards, getExitCode() and getOutput() can be used to access execution results.

Returns

UnboxedResult

Exceptions

Exception
ProcOpenError
ShellDisabledError

Definition at line 212 of file Command.php.

input()

MediaWiki\Shell\Command::input

(

string

$inputString

)

Sends the provided input to the command.

Defaults to an empty string. If you want to pass stdin through to the command instead, use passStdin().

Parameters

string

$inputString

Returns

$this

Definition at line 135 of file Command.php.

limits()

MediaWiki\Shell\Command::limits

(

array

$limits

)

Sets execution limits.

Parameters

array

$limits

Associative array of limits. Keys (all optional): filesize (for ulimit -f), memory, time, walltime.

Returns

$this

Definition at line 93 of file Command.php.

profileMethod()

MediaWiki\Shell\Command::profileMethod

(

string

$method

)

Sets calling function for profiler.

By default, the caller for execute() will be used.

Parameters

string

$method

Returns

$this

Definition at line 121 of file Command.php.

restrict()

MediaWiki\Shell\Command::restrict

(

int

$restrictions

)

Set restrictions for this request, overwriting any previously set restrictions.

Add the "no network" restriction:

$command->restrict( Shell::RESTRICT_DEFAULT | Shell::NO_NETWORK );

Allow LocalSettings.php access:

$command->restrict( Shell::RESTRICT_DEFAULT & ~Shell::NO_LOCALSETTINGS );

Disable all restrictions:

$command->restrict( Shell::RESTRICT_NONE );

Deprecated:

since 1.36 Set the options using their separate accessors

Since

1.31

Parameters

int

$restrictions

Returns

$this

Definition at line 163 of file Command.php.

setLogger()

MediaWiki\Shell\Command::setLogger

(

LoggerInterface

$logger

)

Definition at line 79 of file Command.php.

References MediaWiki\Shell\Command\$logger.

Referenced by MediaWiki\Shell\Command\__construct().

whitelistPaths()

MediaWiki\Shell\Command::whitelistPaths

(

array

$paths

)

If called, only the files/directories that are whitelisted will be available to the shell command.

limit.sh will always be whitelisted

Deprecated:

since 1.36 Use allowPath/disallowPath. Hard deprecated in 1.40 and to be removed in 1.41

Parameters

string[]

$paths

Returns

$this

Definition at line 197 of file Command.php.

Member Data Documentation

$logger

LoggerInterface MediaWiki\Shell\Command::$logger

protected

Definition at line 47 of file Command.php.

Referenced by MediaWiki\Shell\Command\setLogger().

---

The documentation for this class was generated from the following file:

• includes/shell/Command.php