JsHintTask

Extends \Task

JsHintTask

Checks the JavaScript code using JSHint See http://www.jshint.com/

author

Martin Hujer [email protected]

package

phing.tasks.ext

version

$Id: 114e339d1e6e3aad65dfa1dc87272fbfc20125b4 $

since 2.6.2

Methods

__construct

__construct() 
inherited

Checks, wheter the JSHint can be executed

_checkJsHintIsInstalled() 
Throws
\BuildException

_getProjectBasedir

_getProjectBasedir() : string
Throws
\BuildException

Response

string

Path to the project basedir

addFileSet

addFileSet(\FileSet $fileSet) 
inherited

Arguments

$fileSet

\FileSet

Returns the description of the current action.

getDescription() : string
inherited

Response

string

the description of the current action, or null if no description is available.

getFileSets

getFileSets() 
inherited

Returns the file/location where this task was defined.

getLocation() : \Location
inherited

Response

\Location

the file/location where this task was defined. Should not return null.

Returns the owning target of this task.

getOwningTarget() : \Target
inherited

Response

\Target

The target object that owns this task

Returns a reference to current project

getProject() : \Project
inherited

Response

\Project

Reference to current porject object

Returns a name

getRegisterSlot(string $slotName) : \RegisterSlot
inherited

Arguments

$slotName

string

Response

\RegisterSlot

Returns the wrapper object for runtime configuration

getRuntimeConfigurableWrapper() : \RuntimeConfigurable
inherited

Response

\RuntimeConfigurable

The wrapper object used by this task

Returns the name of task, used only for log messages

getTaskName() : string
inherited

Response

string

Name of this task

Returns the name of the task under which it was invoked, usually the XML tagname

getTaskType() : string
inherited

Response

string

The type of this task (XML Tag)

Called by the parser to let the task initialize properly.

init() 
inherited

Should throw a BuildException if something goes wrong with the build

This is abstract here, but may not be overloaded by subclasses.

Throws
\BuildException

Logs a message with the given priority.

log(string $msg, integer $level = \Project::MSG_INFO) : void
inherited

Arguments

$msg

string

The message to be logged.

$level

integer

The message's priority at this message should have

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.

main() 
inherited abstract

Should throw a BuildException if someting goes wrong with the build

This is abstract here. Must be overloaded by real tasks.

Configure this task if it hasn't been done already.

maybeConfigure() 
inherited

Perfrom this task

perform() : void
inherited
Throws
\BuildException
\Error

setCheckstyleReportPath

setCheckstyleReportPath( $checkstyleReportPath) 

Arguments

$checkstyleReportPath

setConfig

setConfig(string $config) 

Arguments

$config

string

Sets a description of the current action. This may be used for logging purposes.

setDescription(string $desc) 
inherited

Arguments

$desc

string

Description of the current action. May be null, indicating that no description is available.

File to be performed syntax check on

setFile(\PhingFile $file) 

Arguments

$file

\PhingFile

setHaltOnError

setHaltOnError( $haltOnError) 

Arguments

$haltOnError

setHaltOnWarning

setHaltOnWarning( $haltOnWarning) 

Arguments

$haltOnWarning

Sets the file/location where this task was defined.

setLocation(\Location $location) 
inherited

Arguments

$location

\Location

The file/location where this task was defined. Should not be null

Sets the owning target this task belongs to.

setOwningTarget(\Target $target) 
inherited

Arguments

$target

\Target

References the project to the current component.

setProject(\Project $project) : void
inherited

Arguments

$project

\Project

The reference to the current project

setReporter

setReporter(string $reporter) 

Arguments

$reporter

string

Sets the wrapper object this task should use for runtime configurable elements.

setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper) 
inherited

Arguments

$wrapper

\RuntimeConfigurable

The wrapper object this task should use

Sets the name of this task for log messages

setTaskName(string $name) 
inherited

Arguments

$name

string

Sets the type of the task. Usually this is the name of the XML tag

setTaskType(string $name) 
inherited

Arguments

$name

string

The type of this task (XML Tag)

Properties

The source file (from xml attribute)

file : string
var

Type(s)

string

Should the build fail on JSHint errors

haltOnError : boolean
var

Type(s)

boolean

Should the build fail on JSHint warnings

haltOnWarning : boolean
var

Type(s)

boolean

reporter

reporter : string
var

Type(s)

string

xmlAttributes

xmlAttributes : array
var

Type(s)

array

Path where the the report in Checkstyle format should be saved

checkstyleReportPath : string
var

Type(s)

string

config

config : string
var

Type(s)

string

filesets

filesets : array<mixed,\FileSet>
inherited
var

Type(s)

array<mixed,\FileSet>

Owning Target object

target : \Target
inherited
var

Type(s)

\Target

Internal taskname (req)

taskType : string
inherited
var

Type(s)

string

Taskname for logger

taskName : string
inherited
var

Type(s)

string

Wrapper of the task

wrapper : \RuntimeConfigurable
inherited
var

Type(s)

\RuntimeConfigurable

Holds a reference to the project that a project component (a task, a target, etc.) belongs to

project : \Project
inherited
var

A reference to the current project instance

Type(s)

\Project

location

location : \Location
inherited
var

Type(s)

\Location

description

description : string
inherited
var

Type(s)

string