MediaWiki\Shell\CommandFactory Class Reference

Factory facilitating dependency injection for Command. More...

Collaboration diagram for MediaWiki\Shell\CommandFactory:

Public Member Functions
	__construct (ShellboxClientFactory $shellboxClientFactory, array $limits, $cgroup, $restrictionMethod)
	create ()
	Instantiates a new Command.
	createBoxed (?string $service=null)
	Instantiates a new BoxedCommand.
	logStderr (bool $yesno=true)
	When enabled, text sent to stderr will be logged with a level of 'error'.

Protected Member Functions
	findFirejail ()

Private Member Functions
	getLocalShellboxOptions ()
	Get the options which will be used for local unboxed execution.

Private Attributes
string bool	$cgroup
bool	$doLogStderr = false
string bool null	$firejail
array	$limits
string bool	$restrictionMethod
ShellboxClientFactory	$shellboxClientFactory
bool	$useAllUsers

Detailed Description

Factory facilitating dependency injection for Command.

Since

1.30

Definition at line 35 of file CommandFactory.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\Shell\CommandFactory::__construct	(	ShellboxClientFactory	$shellboxClientFactory,
		array	$limits,
			$cgroup,
			$restrictionMethod
	)

Parameters

ShellboxClientFactory	$shellboxClientFactory
array	$limits	See {

See also

Command::limits()}

Parameters

string | bool

$cgroup

See {

See also

Command::cgroup()}

Parameters

string | bool

$restrictionMethod

Definition at line 69 of file CommandFactory.php.

References MediaWiki\Shell\CommandFactory\$cgroup, MediaWiki\Shell\CommandFactory\$limits, MediaWiki\Shell\CommandFactory\$restrictionMethod, MediaWiki\Shell\CommandFactory\$shellboxClientFactory, and MediaWiki\Shell\CommandFactory\findFirejail().

Member Function Documentation

create()

MediaWiki\Shell\CommandFactory::create

(

)

Instantiates a new Command.

Returns

Command

Definition at line 139 of file CommandFactory.php.

References $IP.

createBoxed()

MediaWiki\Shell\CommandFactory::createBoxed

(

?string

$service = null

)

Instantiates a new BoxedCommand.

Parameters

?string

$service Name of Shellbox (as configured in $wgShellboxUrls) that should be used

Returns

BoxedCommand

Definition at line 179 of file CommandFactory.php.

findFirejail()

MediaWiki\Shell\CommandFactory::findFirejail ( )

protected

Returns

bool|string

Definition at line 91 of file CommandFactory.php.

References MediaWiki\Shell\CommandFactory\$firejail, and ExecutableFinder\findInDefaultPaths().

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

getLocalShellboxOptions()

MediaWiki\Shell\CommandFactory::getLocalShellboxOptions ( )

private

Get the options which will be used for local unboxed execution.

Shellbox should be configured to act in an approximately backwards compatible way, equivalent to the pre-Shellbox MediaWiki shell classes.

Returns

array

Definition at line 116 of file CommandFactory.php.

References wfTempDir().

logStderr()

MediaWiki\Shell\CommandFactory::logStderr

(

bool

$yesno = true

)

When enabled, text sent to stderr will be logged with a level of 'error'.

Parameters

bool

$yesno

See also

Command::logStderr

Definition at line 105 of file CommandFactory.php.

Member Data Documentation

$cgroup

string bool MediaWiki\Shell\CommandFactory::$cgroup

private

Definition at line 42 of file CommandFactory.php.

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

$doLogStderr

bool MediaWiki\Shell\CommandFactory::$doLogStderr = false

private

Definition at line 45 of file CommandFactory.php.

$firejail

string bool null MediaWiki\Shell\CommandFactory::$firejail

private

Definition at line 55 of file CommandFactory.php.

Referenced by MediaWiki\Shell\CommandFactory\findFirejail().

$limits

array MediaWiki\Shell\CommandFactory::$limits

private

Definition at line 39 of file CommandFactory.php.

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

$restrictionMethod

string bool MediaWiki\Shell\CommandFactory::$restrictionMethod

private

Definition at line 50 of file CommandFactory.php.

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

$shellboxClientFactory

ShellboxClientFactory MediaWiki\Shell\CommandFactory::$shellboxClientFactory

private

Definition at line 61 of file CommandFactory.php.

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

$useAllUsers

bool MediaWiki\Shell\CommandFactory::$useAllUsers

private

Definition at line 58 of file CommandFactory.php.

---

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

• includes/shell/CommandFactory.php