phing-tasks-ext

# Class: PhpLintTask Source Location: /tasks/ext/PhpLintTask.php
### Class Overview
    ProjectComponent
       |
       --Task
          |
          --PhpLintTask
A PHP lint task. Checking syntax of one or more PHP source file. #### Author(s): Stefan Priebsch <stefan.priebsch@e-novative.de> Knut Urdalen <knut.urdalen@telio.no> #### Version: $Id: PhpLintTask.php 552 2009-08-29 12:18:13Z mrook $ #### Copyright: � 2001,2002 THYRELL. All rights reserved | ### Variables $errorProperty $file $filesets $haltOnFailure $hasErrors $interpreter | ### Methods __construct createFileSet lint main setCacheFile setErrorproperty setFile setHaltOnFailure setInterpreter
### Inherited Variables #### Class: Task Task::$description Task::$location Task::$target Task::$taskName Task::$taskType Task::$wrapper #### Class: ProjectComponent ProjectComponent::$project | ### Inherited Methods #### Class: Task Task::getDescription() Returns the textual description of the task Task::getLocation() Returns the location within the buildfile this task occurs. Used by BuildException to give detailed error messages. Task::getOwningTarget() Returns the owning target of this task. Task::getRegisterSlot() Returns a name Task::getRuntimeConfigurableWrapper() Returns the wrapper object for runtime configuration Task::getTaskName() Returns the name of task, used only for log messages Task::getTaskType() Returns the name of the task under which it was invoked, usually the XML tagname Task::init() Called by the parser to let the task initialize properly. Task::log() Provides a project level log event to the task. Task::main() Called by the project to let the task do it's work. This method may be called more than once, if the task is invoked more than once. For example, if target1 and target2 both depend on target3, then running <em>phing target1 target2</em> will run all tasks in target3 twice. Task::maybeConfigure() Configure this task if it hasn't been done already. Task::perform() Perfrom this task Task::setDescription() Sets a textual description of the task Task::setLocation() Sets the location within the buildfile this task occurs. Called by the parser to set location information. Task::setOwningTarget() Sets the owning target this task belongs to. Task::setRuntimeConfigurableWrapper() Sets the wrapper object this task should use for runtime configurable elements. Task::setTaskName() Sets the name of this task for log messages Task::setTaskType() Sets the type of the task. Usually this is the name of the XML tag #### Class: ProjectComponent ProjectComponent::getProject() Returns a reference to current project ProjectComponent::log() Logs a message with the given priority. ProjectComponent::setProject() References the project to the current component.
### Class Details [line 33] A PHP lint task. Checking syntax of one or more PHP source file. #### Tags:
author: | Stefan Priebsch <stefan.priebsch@e-novative.de>
author: | Knut Urdalen <knut.urdalen@telio.no>
version: | $Id: PhpLintTask.php 552 2009-08-29 12:18:13Z mrook $
copyright: | � 2001,2002 THYRELL. All rights reserved
[ Top ] ### Class Variables #### $errorProperty = [line 38] #### Tags:
access: | protected
Type: | mixed
[ Top ] #### $file = [line 35] #### Tags:
access: | protected
Type: | mixed
[ Top ] #### $filesets = array() [line 36] #### Tags:
access: | protected
Type: | mixed
[ Top ] #### $haltOnFailure = false [line 39] #### Tags:
access: | protected
Type: | mixed
[ Top ] #### $hasErrors = false [line 40] #### Tags:
access: | protected
Type: | mixed
[ Top ] #### $interpreter = '' [line 42] #### Tags:
access: | protected
Type: | mixed
[ Top ] ### Class Methods ### constructor __construct [line 49]
`PhpLintTask __construct( )`
Initialize the interpreter with the Phing property #### Tags:
access: | public
[ Top ] ### method createFileSet [line 103]
`FileSet createFileSet( )`
Nested creator, creates a FileSet for this task #### Tags:
return: | The created fileset object
[ Top ] ### method lint [line 139]
`void lint( string $file)`
Performs the actual syntax check #### Tags:
access: | protected
#### Parameters:
string | $file |
[ Top ] ### method main [line 111]
`void main( )`
Execute lint check against PhingFile or a FileSet #### Tags:
access: | public
Overrides Task::main() (Called by the project to let the task do it's work. This method may be called more than once, if the task is invoked more than once. For example, if target1 and target2 both depend on target3, then running <em>phing target1 target2</em> will run all tasks in target3 twice.) [ Top ] ### method setCacheFile [line 93]
`void setCacheFile( $file)`
Whether to store last-modified times in cache #### Tags:
access: | public
#### Parameters:
PhingFile | $file |
[ Top ] ### method setErrorproperty [line 83]
`void setErrorproperty( string $propname)`
Set an property name in which to put any errors. #### Tags:
access: | public
#### Parameters:
string | $propname |
[ Top ] ### method setFile [line 75]
`void setFile( $file)`
File to be performed syntax check on #### Tags:
access: | public
#### Parameters:
PhingFile | $file |
[ Top ] ### method setHaltOnFailure [line 67]
`void setHaltOnFailure( boolean $aValue)`
The haltonfailure property #### Tags:
access: | public
#### Parameters:
boolean | $aValue |
[ Top ] ### method setInterpreter [line 59]
`void setInterpreter( string $sPhp)`
Override default php interpreter #### Tags:
todo: | Do some sort of checking if the path is correct but would require traversing the systems executeable path too
access: | public
#### Parameters:
string | $sPhp |
[ Top ] Documentation generated on Mon, 19 Oct 2009 10:51:41 +0200 by phpDocumentor 1.4.3