tasks/ext/phpdoc/PhpDocumentorExternalTask.php
\PhpDocumentorExternalTask
Task to run phpDocumentor with an external process
This classes uses the commandline phpdoc script to build documentation. Use this task instead of the PhpDocumentorTask when you've a clash with the Smarty libraries.
- Parent(s)
- \PhpDocumentorTask < \Task < \ProjectComponent
- Author
- Michiel Rook
- Author
- Markus Fischer
- Copyright
- 2001,2002 THYRELL. All rights reserved
- Version
- $Id: 6a6c740651bb91c9854fcdf0cb1d7e768b84f805 $
Properties


\PhingFile
$configDir= ''
- Type
- \PhingFile
- Inherited_from
- \PhpDocumentorTask::$$configDir


string
$customtags= ''''
''
Details- Type
- string
- Inherited_from
- \PhpDocumentorTask::$$customtags


string
$defaultCategoryName= ''
- Type
- string
- Inherited_from
- \PhpDocumentorTask::$$defaultCategoryName


string
$defaultPackageName= ''
- Type
- string
- Inherited_from
- \PhpDocumentorTask::$$defaultPackageName


string
$description= ''
Description of the task
Inherited from: \Task::$$description\PhpDocumentorTask::$$description- Type
- string
- Inherited_from
- \Task::$$description
- Inherited_from
- \PhpDocumentorTask::$$description


\PhingFile
$destdir= ''
- Type
- \PhingFile
- Inherited_from
- \PhpDocumentorTask::$$destdir


\PhingFile
$examplesDir= ''
- Type
- \PhingFile
- Inherited_from
- \PhpDocumentorTask::$$examplesDir


array
$filesets= 'array()'
array()
Details- Type
- array
- Inherited_from
- \PhpDocumentorTask::$$filesets


string
$ignore= ''''
''
Details- Type
- string
- Inherited_from
- \PhpDocumentorTask::$$ignore


string
$ignoreTags= ''
- Type
- string
- Inherited_from
- \PhpDocumentorTask::$$ignoreTags


bool
$ignoresymlinks= 'false'
false
Details- Type
- bool


boolean
$javadocDesc= 'false'
false
Details- Type
- boolean
- Inherited_from
- \PhpDocumentorTask::$$javadocDesc


boolean
$linksource= 'false'
false
Details- Type
- boolean
- Inherited_from
- \PhpDocumentorTask::$$linksource


\Location
$location= ''
- Type
- \Location
- Inherited_from
- \Task::$$location
- Inherited_from
- \PhpDocumentorTask::$$location


string
$output= ''
- Type
- string
- Inherited_from
- \PhpDocumentorTask::$$output


string
$packages= ''
- Type
- string
- Inherited_from
- \PhpDocumentorTask::$$packages


boolean
$parsePrivate= 'false'
false
Details- Type
- boolean
- Inherited_from
- \PhpDocumentorTask::$$parsePrivate


boolean
$pear= 'false'
false
Details- Type
- boolean
- Inherited_from
- \PhpDocumentorTask::$$pear


$programPath= ''phpdoc''
The path to the executable for phpDocumentor
'phpdoc'
Details- Type
- n/a


array
$projDocFilesets= 'array()'
array()
Details- Type
- array
- Inherited_from
- \PhpDocumentorTask::$$projDocFilesets


\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::$$project\PhpDocumentorTask::$$projectnull
Details- Type
- \Project
- Inherited_from
- \ProjectComponent::$$project
- Inherited_from
- \Task::$$project
- Inherited_from
- \PhpDocumentorTask::$$project


boolean
$quiet= 'false'
false
Details- Type
- boolean
- Inherited_from
- \PhpDocumentorTask::$$quiet


\Target
$target= ''
- Type
- \Target
- Inherited_from
- \Task::$$target
- Inherited_from
- \PhpDocumentorTask::$$target


string
$taskName= ''
- Type
- string
- Inherited_from
- \Task::$$taskName
- Inherited_from
- \PhpDocumentorTask::$$taskName


string
$taskType= ''
- Type
- string
- Inherited_from
- \Task::$$taskType
- Inherited_from
- \PhpDocumentorTask::$$taskType


\PhingFile
$templateBase= ''
- Type
- \PhingFile
- Inherited_from
- \PhpDocumentorTask::$$templateBase


string
$title= ''
- Type
- string
- Inherited_from
- \PhpDocumentorTask::$$title


boolean
$undocumentedelements= 'false'
false
Details- Type
- boolean
- Inherited_from
- \PhpDocumentorTask::$$undocumentedelements


\RuntimeConfigurable
$wrapper= ''
- Type
- \RuntimeConfigurable
- Inherited_from
- \Task::$$wrapper
- Inherited_from
- \PhpDocumentorTask::$$wrapper
Methods


constructArguments(
)
:
array
Constructs an argument string for phpDocumentor
Type | Description |
---|---|
array |


createProjdocfileset(
)
:
\FileSet
Creates a readme/install/changelog fileset.
Inherited from: \PhpDocumentorTask::createProjdocfileset()Type | Description |
---|---|
\FileSet |


findPhpDocumentorInstall(
)
:
void
Searches include_path for PhpDocumentor install and adjusts include_path appropriately.
Inherited from: \PhpDocumentorTask::findPhpDocumentorInstall()Exception | Description |
---|---|
\BuildException | - if unable to find PhpDocumentor on include_path |


getDescription(
)
:
string
Returns the textual description of the task
Inherited from: \Task::getDescription()\PhpDocumentorTask::getDescription()Type | Description |
---|---|
string | The text description of the task |


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


getOwningTarget(
)
:
\Target
Returns the owning target of this task.
Inherited from: \Task::getOwningTarget()\PhpDocumentorTask::getOwningTarget()Type | Description |
---|---|
\Target | The target object that owns this task |


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


getRegisterSlot(
string $slotName
)
:
void
Returns a name
Inherited from: \Task::getRegisterSlot()\PhpDocumentorTask::getRegisterSlot()Name | Type | Description |
---|---|---|
$slotName | string |


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


getTaskName(
)
:
string
Returns the name of task, used only for log messages
Inherited from: \Task::getTaskName()\PhpDocumentorTask::getTaskName()Type | Description |
---|---|
string | Name of this task |


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


init(
)
:
void
Override PhpDocumentorTask::init() because they're specific to the phpdoc API which we don't use.
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
Provides a project level log event to the task.
Inherited from: \Task::log()\PhpDocumentorTask::log()Name | Type | Description |
---|---|---|
$msg | string | The message to log |
$level | integer | The priority of the message |
- See
- \BuildEvent
- See
- \BuildListener


main(
)
:
void
Main entrypoint of the task
Should throw a BuildException if someting goes wrong with the build
This is abstract here. Must be overloaded by real tasks.
Exception | Description |
---|---|
\BuildException | - if the phpdoc classes can't be loaded. |


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

setConfigdir(
\PhingFile $d
)
:
void
Set a directory to search for configuration files in.
Inherited from: \PhpDocumentorTask::setConfigdir()Name | Type | Description |
---|---|---|
$d | \PhingFile |


setCustomtags(
string $sCustomtags
)
:
void
custom tags, will be recognized and put in tags[] instead of unknowntags[].
Inherited from: \PhpDocumentorTask::setCustomtags()Name | Type | Description |
---|---|---|
$sCustomtags | string |


setDefaultcategoryname(
string $name
)
:
void
Sets the default category name.
Inherited from: \PhpDocumentorTask::setDefaultcategoryname()Name | Type | Description |
---|---|---|
$name | string |


setDescription(
string $desc
)
:
void
Sets a textual description of the task
Inherited from: \Task::setDescription()\PhpDocumentorTask::setDescription()Name | Type | Description |
---|---|---|
$desc | string | The text describing the task |


setDestdir(
$destdir
)
:
void
Set the destination directory for the generated documentation
Inherited from: \PhpDocumentorTask::setDestdir()Name | Type | Description |
---|---|---|
$destdir |


setExamplesdir(
\PhingFile $d
)
:
void
Set a directory to search for examples in.
Inherited from: \PhpDocumentorTask::setExamplesdir()Name | Type | Description |
---|---|---|
$d | \PhingFile |


setIgnoresymlinks(
bool $bSet
)
:
void
Ignore symlinks to other files or directories.
Name | Type | Description |
---|---|---|
$bSet | bool |


setIgnoretags(
string $tags
)
:
void
Set (comma-separated) list of tags to ignore.
Inherited from: \PhpDocumentorTask::setIgnoretags()Name | Type | Description |
---|---|---|
$tags | string |


setJavadocdesc(
$javadoc
)
:
void
Whether to use javadoc descriptions (more primitive).
Inherited from: \PhpDocumentorTask::setJavadocdesc()Name | Type | Description |
---|---|---|
$javadoc | boolean |


setLinksource(
$b
)
:
void
Set whether to generate sourcecode for each file parsed
Inherited from: \PhpDocumentorTask::setLinksource()Name | Type | Description |
---|---|---|
$b | boolean |


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()\PhpDocumentorTask::setLocation()Name | Type | Description |
---|---|---|
$location | \Location | The location object describing the position of this task within the buildfile. |


setOutput(
string $output
)
:
void
Set the output format (e.g. HTML:Smarty:PHP).
Inherited from: \PhpDocumentorTask::setOutput()Name | Type | Description |
---|---|---|
$output | string |


setOwningTarget(
\Target $target
)
:
void
Sets the owning target this task belongs to.
Inherited from: \Task::setOwningTarget()\PhpDocumentorTask::setOwningTarget()Name | Type | Description |
---|---|---|
$target | \Target | Reference to owning target |


setPackageoutput(
string $packages
)
:
void
Set (comma-separated) list of packages to output.
Inherited from: \PhpDocumentorTask::setPackageoutput()Name | Type | Description |
---|---|---|
$packages | string |


setParseprivate(
$parseprivate
)
:
void
Should private members/classes be documented
Inherited from: \PhpDocumentorTask::setParseprivate()Name | Type | Description |
---|---|---|
$parseprivate | boolean |


setPhpDocumentorOptions(
\PhingPhpDocumentorSetup $phpdoc
)
:
void
Sets the options on the passed-in phpdoc setup object.
Inherited from: \PhpDocumentorTask::setPhpDocumentorOptions()Name | Type | Description |
---|---|---|
$phpdoc | \PhingPhpDocumentorSetup |


setProgramPath(
$programPath
)
:
void
Sets the path to the phpDocumentor executable
Name | Type | Description |
---|---|---|
$programPath |


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


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


setSourcecode(
$b
)
:
void
Set whether to generate sourcecode for each file parsed
Inherited from: \PhpDocumentorTask::setSourcecode()Name | Type | Description |
---|---|---|
$b | boolean |


setSourcepath(
$sourcepath
)
:
void
Set the source path. A directory or a comma separate list of directories.
Name | Type | Description |
---|---|---|
$sourcepath |


setTaskName(
string $name
)
:
string
Sets the name of this task for log messages
Inherited from: \Task::setTaskName()\PhpDocumentorTask::setTaskName()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()\PhpDocumentorTask::setTaskType()Name | Type | Description |
---|---|---|
$name | string | The type of this task (XML Tag) |


setTemplateBase(
$oTemplateBase
)
:
void
Set base location of all templates for this parse.
Inherited from: \PhpDocumentorTask::setTemplateBase()Name | Type | Description |
---|---|---|
$oTemplateBase |


setTitle(
$title
)
:
void
Set the title for the generated documentation
Inherited from: \PhpDocumentorTask::setTitle()Name | Type | Description |
---|---|---|
$title |


setUndocumentedelements(
boolean $b
)
:
void
Control whether or not warnings will be shown for undocumented elements.
Inherited from: \PhpDocumentorTask::setUndocumentedelements()Useful for identifying classes and methods that haven't yet been documented.
Name | Type | Description |
---|---|---|
$b | boolean |


validate(
)
:
void
Validates that necessary minimum options have been set. Based on PhpDocumentorTask::validate().
Exception | Description |
---|---|
\BuildException | if validation doesn't pass |