C.57 PHPStanTask

C.57 PHPStanTask
Prev	Appendix C. Optional tasks	Next

The PHPStanTask executes PHPStan - a PHP static analysis tool - with given configuration.

Table C.71: Base attributes

Name	Type	Description	Default	Required
`command`	`String`	PHPStan command name	analyse	No
`executable`	`String`	Path to PHPStan executable	phpstan	No
`checkReturn`	Boolean	Whether to check the return code.	false	No
`passthru`	`Boolean`	Whether to echo PHPStan's output on the console.	`false`	No

Table C.72: Analyse command attributes

Name	Type	Description	Default	Required
`configuration`	`String`	Path to configuration		No
`level`	`String`	Analyse level		No
`noProgress`	`String`	NO progress flag	false	No
`debug`	`String`	Debug flag	false	No
`autoloadFile`	`String`	Path to autoload file		No
`errorFormat`	`String`	Error format		No
`memoryLimit`	`String`	Memory limit		No
`paths`	`String`	Paths (space separated)		No

Table C.73: List command attributes

Name	Type	Description	Default	Required
`format`	`String`	Help format		No
`raw`	`String`	Raw flag	false	No
`namespace`	`String`	Namespace		No

Table C.74: Help command attributes

Name	Type	Description	Default	Required
`format`	`String`	Help format		No
`raw`	`String`	Raw flag	false	No
`commandName`	`String`	Command name		No

Table C.75: Common attributes

Name	Type	Description	Default	Required
`help`	`String`	Help flag	false	No
`quiet`	`String`	Quiet flag	false	No
`version`	`String`	Version flag	false	No
`ansi`	`String`	ANSI flag	false	No
`noAnsi`	`String`	No ANSI flag	false	No
`noInteraction`	`String`	No interaction flag	false	No
`verbose`	`String`	Verbose flag	false	No

C.57.1 Supported Nested Tags

fileset

C.57.2 Example

                <phpstan
                command="analyse"
                configuration="anyConfiguration"
                level="anyLevel"
                noProgress="true"
                debug="true"
                autoloadFile="anyAutoloadFile"
                errorFormat="anyErrorFormat"
                memoryLimit="anyMemoryLimit"
                paths="path1 path2"
                />

                <phpstan command="analyse">
                <fileset refid="files-to-analyse"/>
                </phpstan>

Prev	Up	Next
C.56 PHPMDTask	Home	C.58 PHPUnitReport