reStructuredText rendering task for Phing, the PHP build tool.
PHP version 5
category | Tasks |
---|---|
package | phing.tasks.ext |
author | Christian Weiske |
license | LGPL v3 or later http://www.gnu.org/licenses/lgpl.html |
link | http://www.phing.info/ |
copyright | 2001,2002 THYRELL. All rights reserved |
version | $Id$ |
__construct() : object
i.e. the default mode
access | public |
---|
object
The rSTTask instanceaddFileset(\FileSet $fileset) : void
createFilterChain() : \FilterChain
\FilterChain
The created filterchain objectgetDescription() : string
inherited_from | \Task::getDescription() |
---|
string
The text description of the taskgetLocation() : \Location
Used by BuildException to give detailed error messages.
inherited_from | \Task::getLocation() |
---|
\Location
The location object describing the position of this
task within the buildfile.getProject() : \Project
inherited_from | \ProjectComponent::getProject() |
---|---|
inherited_from | \Task::getProject() |
\Project
Reference to current porject objectgetRuntimeConfigurableWrapper() : \RuntimeConfigurable
inherited_from | \Task::getRuntimeConfigurableWrapper() |
---|
\RuntimeConfigurable
The wrapper object used by this taskgetTargetFile(string $file, string $destination) : string
uses | \global\$format |
---|---|
uses | \global\$targetExt |
string
Input file
string
Destination file or directory name, may be null
string
Target file namegetTaskName() : string
inherited_from | \Task::getTaskName() |
---|
string
Name of this taskgetTaskType() : string
inherited_from | \Task::getTaskType() |
---|
string
The type of this task (XML Tag)init()
Should throw a BuildException if something goes wrong with the build
This is abstract here, but may not be overloaded by subclasses.
\BuildException |
---|
log(string $msg, integer $level)
see | \global\BuildEvent |
---|---|
see | \global\BuildListener |
inherited_from | \Task::log() |
string
The message to log
integer
The priority of the message
main() : void
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 phing target1 target2 will run all tasks in target3 twice.
Should throw a BuildException if someting goes wrong with the build
This is abstract here. Must be overloaded by real tasks.
maybeConfigure()
inherited_from | \Task::maybeConfigure() |
---|
perform()
inherited_from | \Task::perform() |
---|
setDescription(string $desc)
inherited_from | \Task::setDescription() |
---|
string
The text describing the task
setDestination(string $destination) : void
string
Output file or directory. When it ends with a slash, it is taken as directory.
setFile(string $file) : void
string
Path of file to render
setFormat(string $format) : void
setLocation(\Location $location)
Called by the parser to set location information.
inherited_from | \Task::setLocation() |
---|
setOwningTarget(\Target $target)
setProject(\Project $project)
inherited_from | \ProjectComponent::setProject() |
---|---|
inherited_from | \Task::setProject() |
setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper)
inherited_from | \Task::setRuntimeConfigurableWrapper() |
---|
setTaskName(string $name) : string
inherited_from | \Task::setTaskName() |
---|
string
string
A string representing the name of this task for logsetTaskType(string $name)
Usually this is the name of the XML tag
inherited_from | \Task::setTaskType() |
---|
string
The type of this task (XML Tag)
setToolparam(string $param) : void
string
Additional rst2* tool parameters
setToolpath($path) : void
setUptodate(string $uptodate) : void
string
True/false
getRegisterSlot(string $slotName)
inherited_from | \Task::getRegisterSlot() |
---|
string
getToolPath(string $format) : string
string
Output format
\BuildException |
When the tool cannot be found |
---|
string
Full path to rst2$formatrender(string $tool, string $source, string $targetFile) : void
string
conversion tool to use
string
rST source file
string
target file name
renderFile(string $tool, string $source, string $targetFile) : void
string
conversion tool to use
string
rST source file
string
target file name
\BuildException |
When the conversion fails |
---|
$description : string
inherited_from | \Task::$$description |
---|
$destination : string
May be omitted. When it ends with a slash, it is considered to be a directory
$file : string
Required
$filesets
$filterChains : array
$format : string
$mapperElement
$mode : integer
$project : \Project
inherited_from | \ProjectComponent::$$project |
---|---|
inherited_from | \Task::$$project |
$supportedFormats : array
see | \global\$format |
---|---|
see | \global\$targetExt |
$targetExt : array
$taskName : string
$taskType : string
inherited_from | \Task::$$taskType |
---|
$toolParam : string
$toolPath : string
/usr/local/bin/rst2html
$uptodate : boolean