PHP Class PHP_CodeSniffer_CLI, PHP_CodeSniffer

See link: http://pear.php.net/package/PHP_CodeSniffer
Author: Greg Sherwood ([email protected])
Exibir arquivo Open project: squizlabs/php_codesniffer Class Usage Examples

Public Properties

Property Type Description
$dieOnUnknownArg boolean If FALSE, arguments that are not command line options or file/directory paths will be ignored and execution will continue.
$errorSeverity boolean The minimum severity level errors must have to be displayed.
$warningSeverity boolean The minimum severity level warnings must have to be displayed.

Protected Properties

Property Type Description
$values array An array of all values specified on the command line.

Public Methods

Method Description
checkRequirements ( ) : array Exits if the minimum requirements of PHP_CodSniffer are not met.
explainStandard ( string $standard ) : void Prints a report showing the sniffs contained in a standard.
getCommandLineValues ( ) : array Gets the processed command line values.
getDefaults ( ) : array Get a list of default values for all possible command line arguments.
printConfigData ( array $data ) : void Prints out the gathered config data.
printErrorReport ( PHP_CodeSniffer $phpcs, array $reports, boolean $showSources, string $reportFile, integer $reportWidth ) : integer Prints the error report for the run.
printInstalledStandards ( ) : void Prints out a list of installed coding standards.
printPHPCBFUsage ( ) : void Prints out the usage information for PHPCBF.
printPHPCSUsage ( ) : void Prints out the usage information for PHPCS.
printUsage ( ) : void Prints out the usage information for this script.
process ( array $values = [] ) : integer Runs PHP_CodeSniffer over files and directories.
processLongArgument ( string $arg, integer $pos ) : void Processes a long (--example) command line argument.
processShortArgument ( string $arg, integer $pos ) : void Processes a short (-e) command line argument.
processUnknownArgument ( string $arg, integer $pos ) : void Processes an unknown command line argument.
runphpcbf ( ) : array Run the PHPCBF script.
runphpcs ( ) : array Run the PHPCS script.
setCommandLineValues ( array $args ) : void Set the command line values.
validateStandard ( array $standards ) : array Convert the passed standards into valid standards.

Private Methods

Method Description
_validateReportWidth ( integer $width ) : integer Set report width based on terminal width.

Method Details

checkRequirements() public method

Exits if the minimum requirements of PHP_CodSniffer are not met.
public checkRequirements ( ) : array
return array

explainStandard() public method

Prints a report showing the sniffs contained in a standard.
public explainStandard ( string $standard ) : void
$standard string The standard to validate.
return void

getCommandLineValues() public method

If the values have not yet been set, the values will be sourced from the command line arguments.
public getCommandLineValues ( ) : array
return array

getDefaults() public method

Get a list of default values for all possible command line arguments.
public getDefaults ( ) : array
return array

printConfigData() public method

Prints out the gathered config data.
public printConfigData ( array $data ) : void
$data array The config data to print.
return void

printErrorReport() public method

Note that this function may actually print multiple reports as the user may have specified a number of output formats.
public printErrorReport ( PHP_CodeSniffer $phpcs, array $reports, boolean $showSources, string $reportFile, integer $reportWidth ) : integer
$phpcs PHP_CodeSniffer The PHP_CodeSniffer object containing the errors.
$reports array A list of reports to print.
$showSources boolean TRUE if report should show error sources (not used by all reports).
$reportFile string A default file to log report output to.
$reportWidth integer How wide the screen reports should be.
return integer The number of error and warning messages shown.

printInstalledStandards() public method

Prints out a list of installed coding standards.
public printInstalledStandards ( ) : void
return void

printPHPCBFUsage() public method

Prints out the usage information for PHPCBF.
public printPHPCBFUsage ( ) : void
return void

printPHPCSUsage() public method

Prints out the usage information for PHPCS.
public printPHPCSUsage ( ) : void
return void

printUsage() public method

Prints out the usage information for this script.
public printUsage ( ) : void
return void

process() public method

Runs PHP_CodeSniffer over files and directories.
See also: getCommandLineValues()
public process ( array $values = [] ) : integer
$values array An array of values determined from CLI args.
return integer The number of error and warning messages shown.

processLongArgument() public method

Processes a long (--example) command line argument.
public processLongArgument ( string $arg, integer $pos ) : void
$arg string The command line argument.
$pos integer The position of the argument on the command line.
return void

processShortArgument() public method

Processes a short (-e) command line argument.
public processShortArgument ( string $arg, integer $pos ) : void
$arg string The command line argument.
$pos integer The position of the argument on the command line.
return void

processUnknownArgument() public method

Assumes all unknown arguments are files and folders to check.
public processUnknownArgument ( string $arg, integer $pos ) : void
$arg string The command line argument.
$pos integer The position of the argument on the command line.
return void

runphpcbf() public method

Run the PHPCBF script.
public runphpcbf ( ) : array
return array

runphpcs() public method

Run the PHPCS script.
public runphpcs ( ) : array
return array

setCommandLineValues() public method

Set the command line values.
public setCommandLineValues ( array $args ) : void
$args array An array of command line arguments to process.
return void

validateStandard() public method

Checks things like default values and case.
public validateStandard ( array $standards ) : array
$standards array The standards to validate.
return array

Property Details

$dieOnUnknownArg public_oe property

If FALSE, arguments that are not command line options or file/directory paths will be ignored and execution will continue.
public bool $dieOnUnknownArg
return boolean

$errorSeverity public_oe property

The minimum severity level errors must have to be displayed.
public bool $errorSeverity
return boolean

$values protected_oe property

An array of all values specified on the command line.
protected array $values
return array

$warningSeverity public_oe property

The minimum severity level warnings must have to be displayed.
public bool $warningSeverity
return boolean