reStructuredText rendering task for Phing, the PHP build tool.
PHP version 5
category |
Tasks |
---|---|
package |
phing.tasks.ext |
author |
Christian Weiske cweiske@cweiske.de |
license |
LGPL v3 or later http://www.gnu.org/licenses/lgpl.html |
link |
__construct() : object
access |
public |
---|---|
object
The rSTTask instance
addFileset(\FileSet $fileset) : void
createFilterChain() : \FilterChain
createMapper() : \Mapper
getDescription() : string
string
The text description of the task
getLocation() : \Location
getOwningTarget() : \Target
getProject() : \Project
getRegisterSlot(string $slotName)
string
getRuntimeConfigurableWrapper() : \RuntimeConfigurable
getTargetFile(string $file, string $destination = null) : string
uses |
---|
string
Input file
string
Destination file or directory name,
may be null
string
Target file name
getTaskName() : string
string
Name of this task
getTaskType() : string
string
The type of this task (XML Tag)
getToolPath(string $format) : string
throws |
When the tool cannot be found |
---|
string
Output format
string
Full path to rst2$format
init()
Should throw a BuildException if something goes wrong with the build
This is abstract here, but may not be overloaded by subclasses.
throws | |
---|---|
log(string $msg, integer $level = \Project::MSG_INFO)
string
The message to be logged.
integer
The message's priority at this message should have
main()
Should throw a BuildException if someting goes wrong with the build
This is abstract here. Must be overloaded by real tasks.
maybeConfigure()
perform()
render(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
throws |
When the conversion fails |
---|
string
conversion tool to use
string
rST source file
string
target file name
setDescription(string $desc)
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
throws |
When the format is not supported |
---|
string
Output format
setLocation(\Location $location)
setOwningTarget(\Target $target)
setProject(\Project $project)
setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper)
setTaskName(string $name) : string
string
string
A string representing the name of this task for log
setTaskType( $name)
setToolparam(string $param) : void
string
Additional rst2* tool parameters
setToolpath( $path) : void
throws |
When the tool does not exist or is not executable |
---|
setUptodate(string $uptodate) : void
string
True/false
taskName : string
var |
---|
string
format : string
see |
for all possible options |
---|---|
var |
string
supportedFormats : array
var | |
---|---|
see |
array
targetExt : array
var |
---|
array
file : string
Required
var |
---|
string
toolParam : string
var |
---|
string
toolPath : string
var |
---|
string
destination : string
When it ends with a slash, it is considered to be a directory
var |
---|
string
filesets :
mapperElement :
filterChains : array
var |
---|
array
mode : integer
var |
---|
integer
uptodate : boolean
var |
---|
boolean
description : string
var |
---|
string
taskType : string
var |
---|
string
project : \Project