PHP Class Flitch\Cli\Cli

Show file Open project: dasprid/flitch

Protected Properties

Property Type Description
$checkstyleReportFilename string Path to checkstyle report output file
$paths array Paths to scan.
$quiet boolean Run silently w/o any console output
$reports array Reports
$standard string Standard to use.
$workingDirectory string Working directory.

Public Methods

Method Description
__construct ( string $workingDirectory ) : void Create a new CLI object.
run ( array $arguments ) : void Run Flitch.

Protected Methods

Method Description
analyzeFile ( string $path, Tokenizer $tokenizer, Manager $manager ) : File Analyze single file for coding standard violations.
analyzeFiles ( ) : void Analyze files for coding standard violations.
printHelp ( ) : void Print help.

Method Details

__construct() public method

Create a new CLI object.
public __construct ( string $workingDirectory ) : void
$workingDirectory string
return void

analyzeFile() protected method

Analyze single file for coding standard violations.
protected analyzeFile ( string $path, Tokenizer $tokenizer, Manager $manager ) : File
$path string
$tokenizer Flitch\File\Tokenizer
$manager Flitch\Rule\Manager
return File

analyzeFiles() protected method

Analyze files for coding standard violations.
protected analyzeFiles ( ) : void
return void

printHelp() protected method

Print help.
protected printHelp ( ) : void
return void

run() public method

Run Flitch.
public run ( array $arguments ) : void
$arguments array
return void

Property Details

$checkstyleReportFilename protected property

Path to checkstyle report output file
protected string $checkstyleReportFilename
return string

$paths protected property

Paths to scan.
protected array $paths
return array

$quiet protected property

Run silently w/o any console output
protected bool $quiet
return boolean

$reports protected property

Reports
protected array $reports
return array

$standard protected property

Standard to use.
protected string $standard
return string

$workingDirectory protected property

Working directory.
protected string $workingDirectory
return string