MediaWiki\MinusX\CheckCommand Class Reference

Inheritance diagram for MediaWiki\MinusX\CheckCommand:

Public Member Functions
	filterDirs (SplFileInfo $current)
	Filter out ignored directories, split into a separate function for easier readability.

Protected Member Functions
	configure ()
	Initialize command.
	progress ( $marker)
	Output a progress marker.
	setup ()
	Do basic setup.
	loadConfig ( $path)
	Load configuration from .minus-x.json.
	execute (InputInterface $input, OutputInterface $output)
	Run!
	checkFile (SplFileInfo $file)

Protected Attributes
	$defaultIgnoredDirs
	$whitelist
	$ignoredFiles = []
	$ignoredDirs = []
	$input
	$output
	$progressCount = 0

Member Function Documentation

checkFile()

MediaWiki\MinusX\CheckCommand::checkFile ( SplFileInfo $file )

protected

Parameters

SplFileInfo

$file

File to check

Returns

bool If true, its OK to be executable

configure()

MediaWiki\MinusX\CheckCommand::configure ( )

protected

Initialize command.

Reimplemented in MediaWiki\MinusX\FixCommand.

execute()

MediaWiki\MinusX\CheckCommand::execute ( InputInterface $input, OutputInterface $output )

protected

Run!

Parameters

InputInterface	$input	Input
OutputInterface	$output	Output

Returns

int Status code

Reimplemented in MediaWiki\MinusX\FixCommand.

filterDirs()

MediaWiki\MinusX\CheckCommand::filterDirs

(

SplFileInfo

$current

)

Filter out ignored directories, split into a separate function for easier readability.

Used by RecursiveCallbackFilterIterator

Parameters

SplFileInfo

$current

File/directory to check

Returns

bool

loadConfig()

MediaWiki\MinusX\CheckCommand::loadConfig ( $path )

protected

Load configuration from .minus-x.json.

Parameters

string

$path

Root directory that JSON file should be in

Returns

int|null If an int, status code to exit with

progress()

MediaWiki\MinusX\CheckCommand::progress ( $marker )

protected

Output a progress marker.

Parameters

string

$marker

Either ".", "E" or "S"

setup()

MediaWiki\MinusX\CheckCommand::setup ( )

protected

Do basic setup.

Returns

int|string If an int, it should be the status code to exit with

Member Data Documentation

$defaultIgnoredDirs

MediaWiki\MinusX\CheckCommand::$defaultIgnoredDirs

protected

Initial value:

= [
        '.git',
        'vendor',
        'node_modules',
    ]

$whitelist

MediaWiki\MinusX\CheckCommand::$whitelist

protected

Initial value:

= [
        'application/x-executable',
        'application/x-sharedlib',
        'application/x-pie-executable',
        'application/x-mach-binary',
    ]

---

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

• src/CheckCommand.php