# tasks/ext/phpdoc/PhpDocumentorExternalTask.php

$Id: PhpDocumentorExternalTask.php 656 2009-12-14 14:10:54Z mrook $

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

This software consists of voluntary contributions made by many individuals and is licensed under the LGPL. For more information please see http://phing.info.

## \PhpDocumentorExternalTask
jump to top

Package: phing\tasks\ext\phpdoc

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
Version
  $Id: PhpDocumentorExternalTask.php 656 2009-12-14 14:10:54Z mrook $

### Properties

`\PhingFile $configDir= ''`
inherited

Directory in which to look for configuration files.Inherited from: \PhpDocumentorTask::$$configDir
Details

Type
  \PhingFile
Inherited_from
  \PhpDocumentorTask::$$configDir

`string $customtags= ''''`
inherited

custom tags, will be recognized and put in tags[] instead of unknowntags[].Inherited from: \PhpDocumentorTask::$$customtags
Default value`''`Details

Type
  string
Inherited_from
  \PhpDocumentorTask::$$customtags

`string $defaultCategoryName= ''`
inherited

Default category name.Inherited from: \PhpDocumentorTask::$$defaultCategoryName
Details

Type
  string
Inherited_from
  \PhpDocumentorTask::$$defaultCategoryName

`string $defaultPackageName= ''`
inherited

Default package name.Inherited from: \PhpDocumentorTask::$$defaultPackageName
Details

Type
  string
Inherited_from
  \PhpDocumentorTask::$$defaultPackageName

`\PhingFile $destdir= ''`
inherited

The target directory for output files.Inherited from: \PhpDocumentorTask::$$destdir
Details

Type
  \PhingFile
Inherited_from
  \PhpDocumentorTask::$$destdir

`\PhingFile $examplesDir= ''`
inherited

Directory in which to look for examples.Inherited from: \PhpDocumentorTask::$$examplesDir
Details

Type
  \PhingFile
Inherited_from
  \PhpDocumentorTask::$$examplesDir

`array $filesets= 'array()'`
inherited

FileSet[] Filesets for files to parse.Inherited from: \PhpDocumentorTask::$$filesets
Default value `array()`Details

Type
  array
Inherited_from
  \PhpDocumentorTask::$$filesets

`string $ignore= ''''`
inherited

files to ignoreInherited from: \PhpDocumentorTask::$$ignore
Default value`''`Details

Type
  string
Inherited_from
  \PhpDocumentorTask::$$ignore

`string $ignoreTags= ''`
inherited

Comma-separated list of tags to ignore.Inherited from: \PhpDocumentorTask::$$ignoreTags
Details

Type
  string
Inherited_from
  \PhpDocumentorTask::$$ignoreTags

`bool $ignoresymlinks= 'false'`

ignore symlinks to other files or directories
Default value `false` Details

Type
  bool

`boolean $javadocDesc= 'false'`
inherited

Whether to use javadoc descriptions (more primitive).Inherited from: \PhpDocumentorTask::$$javadocDesc
Default value `false` Details

Type
  boolean
Inherited_from
  \PhpDocumentorTask::$$javadocDesc

`boolean $linksource= 'false'`
inherited

Whether to generate sourcecode for each file parsed.Inherited from: \PhpDocumentorTask::$$linksource
Default value `false` Details

Type
  boolean
Inherited_from
  \PhpDocumentorTask::$$linksource

`string $output= ''`
inherited

Package output format.Inherited from: \PhpDocumentorTask::$$output
Details

Type
  string
Inherited_from
  \PhpDocumentorTask::$$output

`string $packages= ''`
inherited

Comma-separated list of packages to output.Inherited from: \PhpDocumentorTask::$$packages
Details

Type
  string
Inherited_from
  \PhpDocumentorTask::$$packages

`boolean $parsePrivate= 'false'`
inherited

Whether to parse private members.Inherited from: \PhpDocumentorTask::$$parsePrivate
Default value `false` Details

Type
  boolean
Inherited_from
  \PhpDocumentorTask::$$parsePrivate

`boolean $pear= 'false'`
inherited

Whether to parse as a PEAR repository.Inherited from: \PhpDocumentorTask::$$pear
Default value `false` Details

Type
  boolean
Inherited_from
  \PhpDocumentorTask::$$pear

`$programPath= ''phpdoc''`

The path to the executable for phpDocumentor

Default value`'phpdoc'`Details

Type
  n/a

`array $projDocFilesets= 'array()'`
inherited

FileSet[] Project documentation (README/INSTALL/CHANGELOG) files.Inherited from: \PhpDocumentorTask::$$projDocFilesets
Default value `array()`Details

Type
  array
Inherited_from
  \PhpDocumentorTask::$$projDocFilesets

`boolean $quiet= 'false'`
inherited

Wheter to suppress output.Inherited from: \PhpDocumentorTask::$$quiet
Default value `false` Details

Type
  boolean
Inherited_from
  \PhpDocumentorTask::$$quiet

`$sourcepath= 'NULL'`
Default value `NULL` Details

Type
  n/a

`\PhingFile $templateBase= ''`
inherited

Base directory for locating template files.Inherited from: \PhpDocumentorTask::$$templateBase
Details

Type
  \PhingFile
Inherited_from
  \PhpDocumentorTask::$$templateBase

`string $title= ''`
inherited

Title for browser window / package index.Inherited from: \PhpDocumentorTask::$$title
Details

Type
  string
Inherited_from
  \PhpDocumentorTask::$$title

`boolean $undocumentedelements= 'false'`
inherited

Control whether or not warnings will be shown for undocumented elements. Useful for identifying classes and methods that haven't yet been documented.Inherited from: \PhpDocumentorTask::$$undocumentedelements
Default value `false` Details

Type
  boolean
Inherited_from
  \PhpDocumentorTask::$$undocumentedelements

### Methods

`constructArguments( ) : array`

Constructs an argument string for phpDocumentor

Returns

Type | Description
--- | ---
array |

`createFileset( ) : \FileSet`
inherited

Creates a FileSet.

Inherited from: \PhpDocumentorTask::createFileset()
Returns

Type | Description
--- | ---
\FileSet |

`createProjdocfileset( ) : \FileSet`
inherited

Creates a readme/install/changelog fileset.

Inherited from: \PhpDocumentorTask::createProjdocfileset()
Returns

Type | Description
--- | ---
\FileSet |

`findPhpDocumentorInstall( ) : void`
inherited

Searches include_path for PhpDocumentor install and adjusts include_path appropriately.

Inherited from: \PhpDocumentorTask::findPhpDocumentorInstall()
Throws

Exception | Description
--- | ---
\BuildException | - if unable to find PhpDocumentor on include_path

`getDescription( ) : void`
inherited

Inherited from: Task::getDescription()\PhpDocumentorTask::getDescription()
`getLocation( ) : void`
inherited

Inherited from: Task::getLocation()\PhpDocumentorTask::getLocation()
`getOwningTarget( ) : void`
inherited

Inherited from: Task::getOwningTarget()\PhpDocumentorTask::getOwningTarget()
`getProgramPath( ) : void`

Returns the path to the phpDocumentor executable

`getProject( ) : void`
inherited

Inherited from: ProjectComponent::getProject()\PhpDocumentorTask::getProject()
`getRegisterSlot( ) : void`
inherited

Inherited from: Task::getRegisterSlot()\PhpDocumentorTask::getRegisterSlot()
`getRuntimeConfigurableWrapper( ) : void`
inherited

Inherited from: Task::getRuntimeConfigurableWrapper()\PhpDocumentorTask::getRuntimeConfigurableWrapper()
`getTaskName( ) : void`
inherited

Inherited from: Task::getTaskName()\PhpDocumentorTask::getTaskName()
`getTaskType( ) : void`
inherited

Inherited from: Task::getTaskType()\PhpDocumentorTask::getTaskType()
`init( ) : void`

Override PhpDocumentorTask::init() because they're specific to the phpdoc API which we don't use.

`log( ) : void`
inherited

Inherited from: Task::log()\PhpDocumentorTask::log()
`main( ) : void`

Main entrypoint of the task

Throws

Exception | Description
--- | ---
\BuildException | - if the phpdoc classes can't be loaded.

`maybeConfigure( ) : void`
inherited

Inherited from: Task::maybeConfigure()\PhpDocumentorTask::maybeConfigure()
`perform( ) : void`
inherited

Inherited from: Task::perform()\PhpDocumentorTask::perform()
`setConfigdir( \PhingFile $d ) : void`
inherited

Set a directory to search for configuration files in.

Inherited from: \PhpDocumentorTask::setConfigdir()
Parameters

Name | Type | Description
--- | --- | ---
$d | \PhingFile |

`setCustomtags( string $sCustomtags ) : void`
inherited

custom tags, will be recognized and put in tags[] instead of unknowntags[].

Inherited from: \PhpDocumentorTask::setCustomtags()
Parameters

Name | Type | Description
--- | --- | ---
$sCustomtags | string |

`setDefaultcategoryname( string $name ) : void`
inherited

Sets the default category name.

Inherited from: \PhpDocumentorTask::setDefaultcategoryname()
Parameters

Name | Type | Description
--- | --- | ---
$name | string |

`setDefaultpackagename( string $name ) : void`
inherited

Sets the default package name.

Inherited from: \PhpDocumentorTask::setDefaultpackagename()
Parameters

Name | Type | Description
--- | --- | ---
$name | string |

`setDescription( ) : void`
inherited

Inherited from: Task::setDescription()\PhpDocumentorTask::setDescription()
`setDestdir( $destdir ) : void`
inherited

Set the destination directory for the generated documentation

Inherited from: \PhpDocumentorTask::setDestdir()
Parameters

Name | Type | Description
--- | --- | ---
$destdir |  |

`setExamplesdir( \PhingFile $d ) : void`
inherited

Set a directory to search for examples in.

Inherited from: \PhpDocumentorTask::setExamplesdir()
Parameters

Name | Type | Description
--- | --- | ---
$d | \PhingFile |

`setIgnore( string $sIgnore ) : void`
inherited

Set files to ignore

Inherited from: \PhpDocumentorTask::setIgnore()
Parameters

Name | Type | Description
--- | --- | ---
$sIgnore | string |

`setIgnoresymlinks( bool $bSet ) : void`

Ignore symlinks to other files or directories.

Parameters

Name | Type | Description
--- | --- | ---
$bSet | bool |

`setIgnoretags( string $tags ) : void`
inherited

Set (comma-separated) list of tags to ignore.

Inherited from: \PhpDocumentorTask::setIgnoretags()
Parameters

Name | Type | Description
--- | --- | ---
$tags | string |

`setJavadocdesc( $javadoc ) : void`
inherited

Whether to use javadoc descriptions (more primitive).

Inherited from: \PhpDocumentorTask::setJavadocdesc()
Parameters

Name | Type | Description
--- | --- | ---
$javadoc |  | boolean

`setLinksource( $b ) : void`
inherited

Set whether to generate sourcecode for each file parsed

Inherited from: \PhpDocumentorTask::setLinksource()
Parameters

Name | Type | Description
--- | --- | ---
$b |  | boolean

`setLocation( ) : void`
inherited

Inherited from: Task::setLocation()\PhpDocumentorTask::setLocation()
`setOutput( string $output ) : void`
inherited

Set the output format (e.g. HTML:Smarty:PHP).

Inherited from: \PhpDocumentorTask::setOutput()
Parameters

Name | Type | Description
--- | --- | ---
$output | string |

`setOwningTarget( ) : void`
inherited

Inherited from: Task::setOwningTarget()\PhpDocumentorTask::setOwningTarget()
`setPackageoutput( string $packages ) : void`
inherited

Set (comma-separated) list of packages to output.

Inherited from: \PhpDocumentorTask::setPackageoutput()
Parameters

Name | Type | Description
--- | --- | ---
$packages | string |

`setParseprivate( $parseprivate ) : void`
inherited

Should private members/classes be documented

Inherited from: \PhpDocumentorTask::setParseprivate()
Parameters

Name | Type | Description
--- | --- | ---
$parseprivate |  | boolean

`setPear( boolean $b ) : void`
inherited

Set whether to parse as PEAR repository.

Inherited from: \PhpDocumentorTask::setPear()
Parameters

Name | Type | Description
--- | --- | ---
$b | boolean |

`setPhpDocumentorOptions( \PhingPhpDocumentorSetup $phpdoc ) : void`
inherited

Sets the options on the passed-in phpdoc setup object.

Inherited from: \PhpDocumentorTask::setPhpDocumentorOptions()
Parameters

Name | Type | Description
--- | --- | ---
$phpdoc | \PhingPhpDocumentorSetup |

`setProgramPath( $programPath ) : void`

Sets the path to the phpDocumentor executable

Parameters

Name | Type | Description
--- | --- | ---
$programPath |  |

`setProject( ) : void`
inherited

Inherited from: ProjectComponent::setProject()\PhpDocumentorTask::setProject()
`setQuiet( boolean $b ) : void`
inherited

Set whether to suppress output.

Inherited from: \PhpDocumentorTask::setQuiet()
Parameters

Name | Type | Description
--- | --- | ---
$b | boolean |

`setRuntimeConfigurableWrapper( ) : void`
inherited

Inherited from: Task::setRuntimeConfigurableWrapper()\PhpDocumentorTask::setRuntimeConfigurableWrapper()
`setSourcecode( $b ) : void`
inherited

Set whether to generate sourcecode for each file parsed

Inherited from: \PhpDocumentorTask::setSourcecode()
Parameters

Name | Type | Description
--- | --- | ---
$b |  | boolean

`setSourcepath( $sourcepath ) : void`

Set the source path. A directory or a comma separate list of directories.

Parameters

Name | Type | Description
--- | --- | ---
$sourcepath |  |

`setTarget( $destdir ) : void`
inherited

Alias for {@link setDestdir()}.

Inherited from: \PhpDocumentorTask::setTarget()
Parameters

Name | Type | Description
--- | --- | ---
$destdir |  |

Details

See
  \setDestdir()

`setTaskName( ) : void`
inherited

Inherited from: Task::setTaskName()\PhpDocumentorTask::setTaskName()
`setTaskType( ) : void`
inherited

Inherited from: Task::setTaskType()\PhpDocumentorTask::setTaskType()
`setTemplateBase( $oTemplateBase ) : void`
inherited

Set base location of all templates for this parse.

Inherited from: \PhpDocumentorTask::setTemplateBase()
Parameters

Name | Type | Description
--- | --- | ---
$oTemplateBase |  |

`setTitle( $title ) : void`
inherited

Set the title for the generated documentation

Inherited from: \PhpDocumentorTask::setTitle()
Parameters

Name | Type | Description
--- | --- | ---
$title |  |

`setUndocumentedelements( boolean $b ) : void`
inherited

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.

Parameters

Name | Type | Description
--- | --- | ---
$b | boolean |

`validate( ) : void`

Validates that necessary minimum options have been set. Based on PhpDocumentorTask::validate().

Throws

Exception | Description
--- | ---
\BuildException | if validation doesn't pass

Documentation was generated by DocBlox 0.17.1.