# tasks/ext/rSTTask.php

reStructuredText rendering task for Phing, the PHP build tool.

PHP version 5

Author
  Christian Weiske
Category
  Tasks
License
  LGPL v3 or later http://www.gnu.org/licenses/lgpl.html
Link
  https://gitorious.org/phing/rsttask
Package
  phing.tasks.ext
Version
  SVN: $Id: rSTTask.php 1401 2011-12-28 16:48:57Z mrook $

## \rSTTask
jump to top

Package: phing\tasks\ext

reStructuredText rendering task for Phing, the PHP build tool.

PHP version 5

Parent(s)
  \Task < \ProjectComponent
Author
  Christian Weiske
Category
  Tasks
License
  LGPL v3 or later http://www.gnu.org/licenses/lgpl.html
Link
  https://gitorious.org/phing/rsttask

### Properties

`string $destination= 'null'`

Output file or directory. May be omitted.

When it ends with a slash, it is considered to be a directory

Default value `null` Details

Type
  string

`string $file= 'null'`

Input file in rST format.

Required

Default value `null` Details

Type
  string

`$filesets= 'array()'`
Default value `array()`Details

Type
  n/a

`array $filterChains= 'array()'`

all filterchains objects assigned to this task

Default value `array()`Details

Type
  array

`string $format= ''html''`

Result format, defaults to "html".

Default value`'html'`Details

Type
  string
See
  \$supportedFormats

`$mapperElement= 'null'`
Default value `null` Details

Type
  n/a

`integer $mode= '0755'`

mode to create directories with

Default value `0755` Details

Type
  integer

`array $supportedFormats= 'array( 'html''`
static

Array of supported output formats

Default value `array( 'html'`Details

Type
  array
See
  \$format
See
  \$targetExt

`array $targetExt= 'array( 'html' => 'html''`
static

Maps formats to file extensions

Default value `array( 'html' => 'html'`Details

Type
  array

`string $taskName= ''rST''`

Taskname for logger
Default value`'rST'`Details

Type
  string

`string $toolParam= 'null'`

Additional rst2* tool parameters.

Default value `null` Details

Type
  string

`string $toolPath= 'null'`

Full path to the tool, i.e. /usr/local/bin/rst2html

Default value `null` Details

Type
  string

`boolean $uptodate= 'false'`

Only render files whole source files are newer than the target files

Default value `false` Details

Type
  boolean

### Methods

`createFileSet( ) : object`

Nested creator, creates a FileSet for this task

Returns

Type | Description
--- | ---
object | The created fileset object

`createFilterChain( ) : \FilterChain`

Creates a filterchain, stores and returns it

Returns

Type | Description
--- | ---
\FilterChain | The created filterchain object

`createMapper( ) : \Mapper`

Nested creator, creates one Mapper for this task

Returns

Type | Description
--- | ---
\Mapper | The created Mapper type object

Throws

Exception | Description
--- | ---
\BuildException |

`getDescription( ) : void`

`getLocation( ) : void`

`getOwningTarget( ) : void`

`getProject( ) : void`

`getRegisterSlot( ) : void`

`getRuntimeConfigurableWrapper( ) : void`

`getTargetFile( string $file, string $destination = null ) : string`

Determines and returns the target file name from the input file and the configured destination name.

Parameters

Name | Type | Description
--- | --- | ---
$file | string | Input file
$destination | string | Destination file or directory name, may be null

Returns

Type | Description
--- | ---
string | Target file name

Details

Uses
  \$format
Uses
  \$targetExt

`getTaskName( ) : void`

`getTaskType( ) : void`

`getToolPath( string $format ) : string`

Finds the rst2* binary path

Parameters

Name | Type | Description
--- | --- | ---
$format | string | Output format

Returns

Type | Description
--- | ---
string | Full path to rst2$format

Throws

Exception | Description
--- | ---
\BuildException | When the tool cannot be found

`init( ) : void`

Init method: requires the PEAR System class

`log( ) : void`

`main( ) : void`

The main entry point method.

`maybeConfigure( ) : void`

`perform( ) : void`

`render( string $tool, string $source, string $targetFile ) : void`

Renders a single file and applies filters on it

Parameters

Name | Type | Description
--- | --- | ---
$tool | string | conversion tool to use
$source | string | rST source file
$targetFile | string | target file name

`renderFile( string $tool, string $source, string $targetFile ) : void`

Renders a single file with the rST tool.

Parameters

Name | Type | Description
--- | --- | ---
$tool | string | conversion tool to use
$source | string | rST source file
$targetFile | string | target file name

Throws

Exception | Description
--- | ---
\BuildException | When the conversion fails

`setDescription( ) : void`

`setDestination( string $destination ) : void`

The setter for the attribute "destination"

Parameters

Name | Type | Description
--- | --- | ---
$destination | string | Output file or directory. When it ends with a slash, it is taken as directory.

`setFile( string $file ) : void`

The setter for the attribute "file"

Parameters

Name | Type | Description
--- | --- | ---
$file | string | Path of file to render

`setFormat( string $format ) : void`

The setter for the attribute "format"

Parameters

Name | Type | Description
--- | --- | ---
$format | string | Output format

Throws

Exception | Description
--- | ---
\BuildException | When the format is not supported

`setLocation( ) : void`

`setOwningTarget( ) : void`

`setProject( ) : void`

`setRuntimeConfigurableWrapper( ) : void`

`setTaskName( ) : void`

`setTaskType( ) : void`

`setToolparam( string $param ) : void`

The setter for the attribute "toolparam"

Parameters

Name | Type | Description
--- | --- | ---
$param | string | Additional rst2* tool parameters

`setToolpath( $path ) : void`

The setter for the attribute "toolpath"

Parameters

Name | Type | Description
--- | --- | ---
$path |  |

Throws

Exception | Description
--- | ---
\BuildException | When the tool does not exist or is not executable

`setUptodate( string $uptodate ) : void`

The setter for the attribute "uptodate"

Parameters

Name | Type | Description
--- | --- | ---
$uptodate | string | True/false

Documentation was generated by DocBlox 0.17.1.