tasks/ext/PhpLintTask.php
Show:
inherited
inherited
Classes
\PhpLintTask
Package: phing\tasks\ext
A PHP lint task. Checking syntax of one or more PHP source file.
- Parent(s)
- \Task < \ProjectComponent
- Author
- Knut Urdalen
- Author
- Stefan Priebsch
- Version
- $Id: PhpLintTask.php 1328 2011-10-20 09:40:21Z mrook $
Properties
$badFiles= 'array()'
Default value
array()Details- Type
- n/a
$cache= 'null'
Default value
nullDetails- Type
- n/a
$deprecatedAsError= 'false'
Default value
falseDetails- Type
- n/a
$errorProperty= ''
Details
- Type
- n/a
$file= ''
Details
- Type
- n/a
$filesets= 'array()'
Default value
array()Details- Type
- n/a
$haltOnFailure= 'false'
Default value
falseDetails- Type
- n/a
$hasErrors= 'false'
Default value
falseDetails- Type
- n/a
$interpreter= ''''
Default value
''Details- Type
- n/a
$logLevel= 'Project::MSG_INFO'
Default value
Project::MSG_INFODetails- Type
- n/a
$tofile= 'null'
Default value
nullDetails- Type
- n/a
Methods
__construct(
)
:
voidInitialize the interpreter with the Phing property
createFileSet(
)
:
\FileSetNested creator, creates a FileSet for this task
Returns
| Type | Description |
|---|---|
| \FileSet | The created fileset object |
getDescription(
)
:
voidgetLocation(
)
:
voidgetOwningTarget(
)
:
voidgetProject(
)
:
voidgetRegisterSlot(
)
:
voidgetRuntimeConfigurableWrapper(
)
:
voidgetTaskName(
)
:
voidgetTaskType(
)
:
voidinit(
)
:
voidlint(
string $file
)
:
voidPerforms the actual syntax check
Parameters
| Name | Type | Description |
|---|---|---|
| $file | string |
log(
)
:
voidmain(
)
:
voidExecute lint check against PhingFile or a FileSet
maybeConfigure(
)
:
voidperform(
)
:
voidsetCacheFile(
\PhingFile $file
)
:
voidWhether to store last-modified times in cache
Parameters
| Name | Type | Description |
|---|---|---|
| $file | \PhingFile |
setDeprecatedAsError(
boolean $deprecatedAsError
)
:
voidSets whether to treat deprecated warnings (introduced in PHP 5.3) as errors
Parameters
| Name | Type | Description |
|---|---|---|
| $deprecatedAsError | boolean |
setDescription(
)
:
voidsetErrorproperty(
string $propname
)
:
voidSet an property name in which to put any errors.
Parameters
| Name | Type | Description |
|---|---|---|
| $propname | string |
setFile(
\PhingFile $file
)
:
voidFile to be performed syntax check on
Parameters
| Name | Type | Description |
|---|---|---|
| $file | \PhingFile |
setHaltOnFailure(
boolean $aValue
)
:
voidThe haltonfailure property
Parameters
| Name | Type | Description |
|---|---|---|
| $aValue | boolean |
setInterpreter(
string $sPhp
)
:
voidOverride default php interpreter
Parameters
Details
| Name | Type | Description |
|---|---|---|
| $sPhp | string |
- Todo
- Do some sort of checking if the path is correct but would require traversing the systems executeable path too
setLevel(
string $level
)
:
voidSet level of log messages generated (default = info)
Parameters
| Name | Type | Description |
|---|---|---|
| $level | string |
setLocation(
)
:
voidsetOwningTarget(
)
:
voidsetProject(
)
:
voidsetRuntimeConfigurableWrapper(
)
:
voidsetTaskName(
)
:
voidsetTaskType(
)
:
voidsetToFile(
$tofile
)
:
voidFile to save error messages to
Parameters
| Name | Type | Description |
|---|---|---|
| $tofile |