tasks/ext/phpdoc/PhpDocumentorTask.php
inherited
Classes
\PhpDocumentorTask
Task to run PhpDocumentor.
Use {@link Project#createTask} to register a new Task.
- Parent(s)
- \Task < \ProjectComponent
- Children
- \PhpDocumentorExternalTask
- Author
- Hans Lellelid
- Author
- Michiel Rook
- Copyright
- 2001,2002 THYRELL. All rights reserved
- Version
- $Id: 23a04ddae9cad46198e15081a0fb44354135b1c8 $
Properties
\PhingFile
$configDir= ''
- Type
- \PhingFile
string
$customtags= ''''
''Details- Type
- string
string
$defaultCategoryName= ''
- Type
- string
string
$defaultPackageName= ''
- Type
- string
array
$filesets= 'array()'
array()Details- Type
- array
string
$ignore= ''''
''Details- Type
- string
string
$ignoreTags= ''
- Type
- string
boolean
$javadocDesc= 'false'
falseDetails- Type
- boolean
boolean
$linksource= 'false'
falseDetails- Type
- boolean
string
$output= ''
- Type
- string
string
$packages= ''
- Type
- string
boolean
$parsePrivate= 'false'
falseDetails- Type
- boolean
boolean
$pear= 'false'
falseDetails- Type
- boolean
array
$projDocFilesets= 'array()'
array()Details- Type
- array
\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::$$projectnullDetails- Type
- \Project
- Inherited_from
- \ProjectComponent::$$project
- Inherited_from
- \Task::$$project
boolean
$quiet= 'false'
falseDetails- Type
- boolean
string
$title= ''
- Type
- string
boolean
$undocumentedelements= 'false'
falseDetails- Type
- boolean
Methods
createProjdocfileset(
)
:
\FileSetCreates a readme/install/changelog fileset.
| Type | Description |
|---|---|
| \FileSet |
findPhpDocumentorInstall(
)
:
voidSearches include_path for PhpDocumentor install and adjusts include_path appropriately.
| Exception | Description |
|---|---|
| \BuildException | - if unable to find PhpDocumentor on include_path |
getDescription(
)
:
string
| Type | Description |
|---|---|
| string | The text description of the task |
getLocation(
)
:
\LocationReturns 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(
)
:
\ProjectReturns a reference to current project
Inherited from: \ProjectComponent::getProject()\Task::getProject()| Type | Description |
|---|---|
| \Project | Reference to current porject object |
getRegisterSlot(
string $slotName
)
:
void
| Name | Type | Description |
|---|---|---|
| $slotName | string |
getRuntimeConfigurableWrapper(
)
:
\RuntimeConfigurableReturns the wrapper object for runtime configuration
Inherited from: \Task::getRuntimeConfigurableWrapper()| Type | Description |
|---|---|
| \RuntimeConfigurable | The wrapper object used by this task |
getTaskName(
)
:
string
| Type | Description |
|---|---|
| string | Name of this task |
getTaskType(
)
:
stringReturns 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(
)
:
voidMain entrypoint of the task Loads the necessary environment for running PhpDoc, then runs PhpDoc
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(
)
:
voidConfigure this task if it hasn't been done already.
Inherited from: \Task::maybeConfigure()setConfigdir(
\PhingFile $d
)
:
voidSet a directory to search for configuration files in.
| Name | Type | Description |
|---|---|---|
| $d | \PhingFile |
setCustomtags(
string $sCustomtags
)
:
voidcustom tags, will be recognized and put in tags[] instead of unknowntags[].
| Name | Type | Description |
|---|---|---|
| $sCustomtags | string |
setDefaultcategoryname(
string $name
)
:
voidSets the default category name.
| Name | Type | Description |
|---|---|---|
| $name | string |
setDefaultpackagename(
string $name
)
:
voidSets the default package name.
| Name | Type | Description |
|---|---|---|
| $name | string |
setDescription(
string $desc
)
:
void
| Name | Type | Description |
|---|---|---|
| $desc | string | The text describing the task |
setDestdir(
$destdir
)
:
voidSet the destination directory for the generated documentation
| Name | Type | Description |
|---|---|---|
| $destdir |
setExamplesdir(
\PhingFile $d
)
:
voidSet a directory to search for examples in.
| Name | Type | Description |
|---|---|---|
| $d | \PhingFile |
setIgnore(
string $sIgnore
)
:
voidSet files to ignore
| Name | Type | Description |
|---|---|---|
| $sIgnore | string |
setIgnoretags(
string $tags
)
:
voidSet (comma-separated) list of tags to ignore.
| Name | Type | Description |
|---|---|---|
| $tags | string |
setJavadocdesc(
$javadoc
)
:
voidWhether to use javadoc descriptions (more primitive).
| Name | Type | Description |
|---|---|---|
| $javadoc | boolean |
setLinksource(
$b
)
:
voidSet whether to generate sourcecode for each file parsed
| Name | Type | Description |
|---|---|---|
| $b | boolean |
setLocation(
\Location $location
)
:
voidSets 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(
string $output
)
:
voidSet the output format (e.g. HTML:Smarty:PHP).
| Name | Type | Description |
|---|---|---|
| $output | string |
setOwningTarget(
\Target $target
)
:
void
| Name | Type | Description |
|---|---|---|
| $target | \Target | Reference to owning target |
setPackageoutput(
string $packages
)
:
voidSet (comma-separated) list of packages to output.
| Name | Type | Description |
|---|---|---|
| $packages | string |
setParseprivate(
$parseprivate
)
:
voidShould private members/classes be documented
| Name | Type | Description |
|---|---|---|
| $parseprivate | boolean |
setPear(
boolean $b
)
:
voidSet whether to parse as PEAR repository.
| Name | Type | Description |
|---|---|---|
| $b | boolean |
setPhpDocumentorOptions(
\PhingPhpDocumentorSetup $phpdoc
)
:
voidSets the options on the passed-in phpdoc setup object.
| Name | Type | Description |
|---|---|---|
| $phpdoc | \PhingPhpDocumentorSetup |
setProject(
\Project $project
)
:
voidReferences 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 $b
)
:
voidSet whether to suppress output.
| Name | Type | Description |
|---|---|---|
| $b | boolean |
setRuntimeConfigurableWrapper(
\RuntimeConfigurable $wrapper
)
:
voidSets 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 |
setSourcecode(
$b
)
:
voidSet whether to generate sourcecode for each file parsed
| Name | Type | Description |
|---|---|---|
| $b | boolean |
setTarget(
$destdir
)
:
voidAlias for {@link setDestdir()}.
| Name | Type | Description |
|---|---|---|
| $destdir |
- See
- \setDestdir()
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
)
:
voidSets 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) |
setTemplateBase(
$oTemplateBase
)
:
voidSet base location of all templates for this parse.
| Name | Type | Description |
|---|---|---|
| $oTemplateBase |
setTitle(
$title
)
:
voidSet the title for the generated documentation
| Name | Type | Description |
|---|---|---|
| $title |
setUndocumentedelements(
boolean $b
)
:
voidControl whether or not warnings will be shown for undocumented elements.
Useful for identifying classes and methods that haven't yet been documented.
| Name | Type | Description |
|---|---|---|
| $b | boolean |
validate(
)
:
voidValidates that necessary minimum options have been set.
| Exception | Description |
|---|---|
| \BuildException | if validation doesn't pass |