phing-tasks-ext

# Class: XmlLintTask Source Location: /tasks/ext/XmlLintTask.php
### Class Overview
    ProjectComponent
       |
       --Task
          |
          --XmlLintTask
A XML lint task. Checking syntax of one or more XML files against an XML Schema using the DOM extension. #### Author(s): Knut Urdalen <knut.urdalen@telio.no> #### Version: $Id: XmlLintTask.php 552 2009-08-29 12:18:13Z mrook $ #### Copyright: � 2001,2002 THYRELL. All rights reserved | ### Variables $file $filesets $schema | ### Methods createFileSet errorHandler lint main setFile setSchema
### 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 31] A XML lint task. Checking syntax of one or more XML files against an XML Schema using the DOM extension. #### Tags:
author: | Knut Urdalen <knut.urdalen@telio.no>
version: | $Id: XmlLintTask.php 552 2009-08-29 12:18:13Z mrook $
copyright: | � 2001,2002 THYRELL. All rights reserved
[ Top ] ### Class Variables #### $file = [line 33] #### Tags:
access: | protected
Type: | mixed
[ Top ] #### $filesets = array() [line 35] #### Tags:
access: | protected
Type: | mixed
[ Top ] #### $schema = [line 34] #### Tags:
access: | protected
Type: | mixed
[ Top ] ### Class Methods ### method createFileSet [line 60]
`FileSet createFileSet( )`
Nested creator, creates a FileSet for this task #### Tags:
return: | The created fileset object
[ Top ] ### method errorHandler [line 129]
`void errorHandler( int $level, string $message, string $file, int $line, $context)`
Local error handler to catch validation errors and log them through Phing #### Tags:
access: | public
#### Parameters:
int | $level |
string | $message |
string | $file |
int | $line |
| $context |
[ Top ] ### method lint [line 103]
`void lint( string $file)`
Performs validation #### Tags:
access: | protected
#### Parameters:
string | $file |
[ Top ] ### method main [line 68]
`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 setFile [line 42]
`void setFile( $file)`
File to be performed syntax check on #### Tags:
access: | public
#### Parameters:
PhingFile | $file |
[ Top ] ### method setSchema [line 51]
`void setSchema( $schema)`
XML Schema Description file to validate against #### Tags:
access: | public
#### Parameters:
PhingFile | $schema |
[ Top ] Documentation generated on Mon, 19 Oct 2009 10:52:24 +0200 by phpDocumentor 1.4.3