tasks/ext/phpdoc/PhpDocumentor2Task.php
PhpDocumentor2 Task (http://www.phpdoc.org) Based on the DocBlox Task
- Author
- Michiel Rook
- Package
- phing.tasks.ext.phpdoc
- Since
- 2.4.10
- Version
- $Id: eaa494390770adc752097a412d63fb863482fd5d $
\PhpDocumentor2Task
PhpDocumentor2 Task (http://www.phpdoc.org) Based on the DocBlox Task
Use {@link Project#createTask} to register a new Task.
- Parent(s)
- \Task < \ProjectComponent
- Author
- Michiel Rook
- Copyright
- 2001,2002 THYRELL. All rights reserved
- Since
- 2.4.10
- Version
- $Id: eaa494390770adc752097a412d63fb863482fd5d $
Properties


\Project
$project= 'null'
Holds a reference to the project that a project component (a task, a target, etc.) belongs to
A reference to the current project instanceInherited from: \ProjectComponent::$$project\Task::$$projectnull
Details- Type
- \Project
- Inherited_from
- \ProjectComponent::$$project
- Inherited_from
- \Task::$$project


string
$template= '"responsive"'
name of the template to use
"responsive"
Details- Type
- string
Methods


createFileSet(
)
:
\FileSet
Nested creator, adds a set of files (nested fileset attribute).
Type | Description |
---|---|
\FileSet |


getLocation(
)
:
\Location
Returns the location within the buildfile this task occurs. Used by {@link BuildException} to give detailed error messages.
Inherited from: \Task::getLocation()Type | Description |
---|---|
\Location | The location object describing the position of this task within the buildfile. |


getProject(
)
:
\Project
Returns a reference to current project
Inherited from: \ProjectComponent::getProject()\Task::getProject()Type | Description |
---|---|
\Project | Reference to current porject object |


getRuntimeConfigurableWrapper(
)
:
\RuntimeConfigurable
Returns the wrapper object for runtime configuration
Inherited from: \Task::getRuntimeConfigurableWrapper()Type | Description |
---|---|
\RuntimeConfigurable | The wrapper object used by this task |


getTaskType(
)
:
string
Returns the name of the task under which it was invoked, usually the XML tagname
Inherited from: \Task::getTaskType()Type | Description |
---|---|
string | The type of this task (XML Tag) |


init(
)
:
void
Should throw a BuildException if something goes wrong with the build
This is abstract here, but may not be overloaded by subclasses.
Exception | Description |
---|---|
\BuildException |


log(
string $msg, integer $level
=
Project::MSG_INFO
)
:
void
Name | Type | Description |
---|---|---|
$msg | string | The message to log |
$level | integer | The priority of the message |
- See
- \BuildEvent
- See
- \BuildListener


main(
)
:
void
Task entry point
Should throw a BuildException if someting goes wrong with the build
This is abstract here. Must be overloaded by real tasks.
- See
- \Task::main()


maybeConfigure(
)
:
void
Configure this task if it hasn't been done already.
Inherited from: \Task::maybeConfigure()

parseFiles(
)
:
string
Build a list of files (from the fileset elements) and call the phpDocumentor parser
Type | Description |
---|---|
string |


setDescription(
string $desc
)
:
void
Name | Type | Description |
---|---|---|
$desc | string | The text describing the task |


setDestDir(
\PhingFile $destDir
)
:
void
Sets destination/target directory
Name | Type | Description |
---|---|---|
$destDir | \PhingFile |


setLocation(
\Location $location
)
:
void
Sets the location within the buildfile this task occurs. Called by the parser to set location information.
Inherited from: \Task::setLocation()Name | Type | Description |
---|---|---|
$location | \Location | The location object describing the position of this task within the buildfile. |


setOutput(
\PhingFile $output
)
:
void
Convenience setter (@see setDestDir)
Name | Type | Description |
---|---|---|
$output | \PhingFile |


setOwningTarget(
\Target $target
)
:
void
Name | Type | Description |
---|---|---|
$target | \Target | Reference to owning target |


setProject(
\Project $project
)
:
void
References the project to the current component.
Inherited from: \ProjectComponent::setProject()\Task::setProject()Name | Type | Description |
---|---|---|
$project | \Project | The reference to the current project |


setQuiet(
boolean $quiet
)
:
void
Forces phpDocumentor to be quiet
Name | Type | Description |
---|---|---|
$quiet | boolean |


setRuntimeConfigurableWrapper(
\RuntimeConfigurable $wrapper
)
:
void
Sets the wrapper object this task should use for runtime configurable elements.
Inherited from: \Task::setRuntimeConfigurableWrapper()Name | Type | Description |
---|---|---|
$wrapper | \RuntimeConfigurable | The wrapper object this task should use |


setTaskName(
string $name
)
:
string
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
string | A string representing the name of this task for log |


setTaskType(
string $name
)
:
void
Sets the type of the task. Usually this is the name of the XML tag
Inherited from: \Task::setTaskType()Name | Type | Description |
---|---|---|
$name | string | The type of this task (XML Tag) |


setTemplate(
\strings $template
)
:
void
Sets the template to use
Name | Type | Description |
---|---|---|
$template | \strings |