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 |
|---|
objectThe rSTTask instanceaddFileset(\FileSet $fileset) : void
createFilterChain() : \FilterChain
\FilterChainThe created filterchain objectgetDescription() : string
| inherited_from | \Task::getDescription() |
|---|
stringThe text description of the taskgetLocation() : \Location
Used by BuildException to give detailed error messages.
| inherited_from | \Task::getLocation() |
|---|
\LocationThe location object describing the position of this
task within the buildfile.getProject() : \Project
| inherited_from | \ProjectComponent::getProject() |
|---|---|
| inherited_from | \Task::getProject() |
\ProjectReference to current porject objectgetRuntimeConfigurableWrapper() : \RuntimeConfigurable
| inherited_from | \Task::getRuntimeConfigurableWrapper() |
|---|
\RuntimeConfigurableThe wrapper object used by this taskgetTargetFile(string $file, string $destination) : string
| uses | \$format |
|---|---|
| uses | \$targetExt |
stringInput file
stringDestination file or directory name, may be null
stringTarget file namegetTaskName() : string
| inherited_from | \Task::getTaskName() |
|---|
stringName of this taskgetTaskType() : string
| inherited_from | \Task::getTaskType() |
|---|
stringThe 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 | \BuildEvent |
|---|---|
| see | \BuildListener |
| inherited_from | \Task::log() |
stringThe message to log
integerThe 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() |
|---|
stringThe text describing the task
setDestination(string $destination) : void
stringOutput file or directory. When it ends with a slash, it is taken as directory.
setFile(string $file) : void
stringPath 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
stringA string representing the name of this task for logsetTaskType(string $name)
Usually this is the name of the XML tag
| inherited_from | \Task::setTaskType() |
|---|
stringThe type of this task (XML Tag)
setToolparam(string $param) : void
stringAdditional rst2* tool parameters
setToolpath($path) : void
setUptodate(string $uptodate) : void
stringTrue/false
getRegisterSlot(string $slotName)
| inherited_from | \Task::getRegisterSlot() |
|---|
string
getToolPath(string $format) : string
stringOutput format
\BuildException |
When the tool cannot be found |
|---|
stringFull path to rst2$formatrender(string $tool, string $source, string $targetFile) : void
stringconversion tool to use
stringrST source file
stringtarget file name
renderFile(string $tool, string $source, string $targetFile) : void
stringconversion tool to use
stringrST source file
stringtarget 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 | \$format |
|---|---|
| see | \$targetExt |
$targetExt : array
$taskName : string
$taskType : string
| inherited_from | \Task::$$taskType |
|---|
$toolParam : string
$toolPath : string
/usr/local/bin/rst2html
$uptodate : boolean