tasks/ext/PhpLintTask.php
A PHP lint task. Checking syntax of one or more PHP source file.
- Author
- Knut Urdalen
- Author
- Stefan Priebsch
- Package
- phing.tasks.ext
- Version
- $Id: 524bae55e1007bc9778c232dd7b437964a66c5a4 $
\PhpLintTask
A PHP lint task. Checking syntax of one or more PHP source file.
Use {@link Project#createTask} to register a new Task.
- Parent(s)
- \Task < \ProjectComponent
- Author
- Knut Urdalen
- Author
- Stefan Priebsch
- Copyright
- 2001,2002 THYRELL. All rights reserved
- Version
- $Id: 524bae55e1007bc9778c232dd7b437964a66c5a4 $
Properties


\Project
$project= 'null'
Holds a reference to the project that a project component (a task, a target, etc.) belongs to
A reference to the current project instanceInherited from: \ProjectComponent::$$project\Task::$$projectnull
Details- Type
- \Project
- Inherited_from
- \ProjectComponent::$$project
- Inherited_from
- \Task::$$project
Methods


createFileSet(
)
:
\FileSet
Nested creator, creates a FileSet for this task
Type | Description |
---|---|
\FileSet | The created fileset object |


getLocation(
)
:
\Location
Returns the location within the buildfile this task occurs. Used by {@link BuildException} to give detailed error messages.
Inherited from: \Task::getLocation()Type | Description |
---|---|
\Location | The location object describing the position of this task within the buildfile. |


getProject(
)
:
\Project
Returns a reference to current project
Inherited from: \ProjectComponent::getProject()\Task::getProject()Type | Description |
---|---|
\Project | Reference to current porject object |


getRuntimeConfigurableWrapper(
)
:
\RuntimeConfigurable
Returns the wrapper object for runtime configuration
Inherited from: \Task::getRuntimeConfigurableWrapper()Type | Description |
---|---|
\RuntimeConfigurable | The wrapper object used by this task |


getTaskType(
)
:
string
Returns the name of the task under which it was invoked, usually the XML tagname
Inherited from: \Task::getTaskType()Type | Description |
---|---|
string | The type of this task (XML Tag) |


init(
)
:
void
Should throw a BuildException if something goes wrong with the build
This is abstract here, but may not be overloaded by subclasses.
Exception | Description |
---|---|
\BuildException |


lint(
string $file
)
:
void
Performs the actual syntax check
Name | Type | Description |
---|---|---|
$file | string |


log(
string $msg, integer $level
=
Project::MSG_INFO
)
:
void
Name | Type | Description |
---|---|---|
$msg | string | The message to log |
$level | integer | The priority of the message |
- See
- \BuildEvent
- See
- \BuildListener


main(
)
:
void
Execute lint check against PhingFile or a FileSet
Should throw a BuildException if someting goes wrong with the build
This is abstract here. Must be overloaded by real tasks.


maybeConfigure(
)
:
void
Configure this task if it hasn't been done already.
Inherited from: \Task::maybeConfigure()

setCacheFile(
\PhingFile $file
)
:
void
Whether to store last-modified times in cache
Name | Type | Description |
---|---|---|
$file | \PhingFile |


setDeprecatedAsError(
boolean $deprecatedAsError
)
:
void
Sets whether to treat deprecated warnings (introduced in PHP 5.3) as errors
Name | Type | Description |
---|---|---|
$deprecatedAsError | boolean |


setDescription(
string $desc
)
:
void
Name | Type | Description |
---|---|---|
$desc | string | The text describing the task |


setErrorproperty(
string $propname
)
:
void
Set an property name in which to put any errors.
Name | Type | Description |
---|---|---|
$propname | string |


setFile(
\PhingFile $file
)
:
void
File to be performed syntax check on
Name | Type | Description |
---|---|---|
$file | \PhingFile |


setHaltOnFailure(
boolean $aValue
)
:
void
The haltonfailure property
Name | Type | Description |
---|---|---|
$aValue | boolean |


setInterpreter(
string $sPhp
)
:
void
Override default php interpreter
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
)
:
void
Set level of log messages generated (default = info)
Name | Type | Description |
---|---|---|
$level | string |


setLocation(
\Location $location
)
:
void
Sets the location within the buildfile this task occurs. Called by the parser to set location information.
Inherited from: \Task::setLocation()Name | Type | Description |
---|---|---|
$location | \Location | The location object describing the position of this task within the buildfile. |


setOwningTarget(
\Target $target
)
:
void
Name | Type | Description |
---|---|---|
$target | \Target | Reference to owning target |


setProject(
\Project $project
)
:
void
References the project to the current component.
Inherited from: \ProjectComponent::setProject()\Task::setProject()Name | Type | Description |
---|---|---|
$project | \Project | The reference to the current project |


setRuntimeConfigurableWrapper(
\RuntimeConfigurable $wrapper
)
:
void
Sets the wrapper object this task should use for runtime configurable elements.
Inherited from: \Task::setRuntimeConfigurableWrapper()Name | Type | Description |
---|---|---|
$wrapper | \RuntimeConfigurable | The wrapper object this task should use |


setTaskName(
string $name
)
:
string
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
string | A string representing the name of this task for log |


setTaskType(
string $name
)
:
void
Sets the type of the task. Usually this is the name of the XML tag
Inherited from: \Task::setTaskType()Name | Type | Description |
---|---|---|
$name | string | The type of this task (XML Tag) |