tasks/ext/phpdoc/PhpDocumentorExternalTask.php

Show: inherited
Table of Contents

\PhpDocumentorExternalTask

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  
Copyright
2001,2002 THYRELL. All rights reserved  
Version
$Id: 6a6c740651bb91c9854fcdf0cb1d7e768b84f805 $  

Properties

Propertyprotected\PhingFile  $configDir= ''
inherited

Directory in which to look for configuration files.Inherited from: \PhpDocumentorTask::$$configDir
Details
Type
\PhingFile
Inherited_from
\PhpDocumentorTask::$$configDir  
Propertyprotectedstring  $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  
Propertyprotectedstring  $defaultCategoryName= ''
inherited

Default category name.Inherited from: \PhpDocumentorTask::$$defaultCategoryName
Details
Type
string
Inherited_from
\PhpDocumentorTask::$$defaultCategoryName  
Propertyprotectedstring  $defaultPackageName= ''
inherited

Default package name.Inherited from: \PhpDocumentorTask::$$defaultPackageName
Details
Type
string
Inherited_from
\PhpDocumentorTask::$$defaultPackageName  
Propertyprotectedstring  $description= ''
inherited

Description of the task

Inherited from: \Task::$$description\PhpDocumentorTask::$$description
Details
Type
string
Inherited_from
\Task::$$description  
Inherited_from
\PhpDocumentorTask::$$description  
Propertyprotected\PhingFile  $destdir= ''
inherited

The target directory for output files.Inherited from: \PhpDocumentorTask::$$destdir
Details
Type
\PhingFile
Inherited_from
\PhpDocumentorTask::$$destdir  
Propertyprotected\PhingFile  $examplesDir= ''
inherited

Directory in which to look for examples.Inherited from: \PhpDocumentorTask::$$examplesDir
Details
Type
\PhingFile
Inherited_from
\PhpDocumentorTask::$$examplesDir  
Propertyprotectedarray  $filesets= 'array()'
inherited

FileSet[] Filesets for files to parse.Inherited from: \PhpDocumentorTask::$$filesets
Default valuearray()Details
Type
array
Inherited_from
\PhpDocumentorTask::$$filesets  
Propertyprotectedstring  $ignore= ''''
inherited

files to ignoreInherited from: \PhpDocumentorTask::$$ignore
Default value''Details
Type
string
Inherited_from
\PhpDocumentorTask::$$ignore  
Propertyprotectedstring  $ignoreTags= ''
inherited

Comma-separated list of tags to ignore.Inherited from: \PhpDocumentorTask::$$ignoreTags
Details
Type
string
Inherited_from
\PhpDocumentorTask::$$ignoreTags  
Propertyprotectedbool  $ignoresymlinks= 'false'

ignore symlinks to other files or directories
Default valuefalseDetails
Type
bool
Propertyprotectedboolean  $javadocDesc= 'false'
inherited

Whether to use javadoc descriptions (more primitive).Inherited from: \PhpDocumentorTask::$$javadocDesc
Default valuefalseDetails
Type
boolean
Inherited_from
\PhpDocumentorTask::$$javadocDesc  
Propertyprotectedboolean  $linksource= 'false'
inherited

Whether to generate sourcecode for each file parsed.Inherited from: \PhpDocumentorTask::$$linksource
Default valuefalseDetails
Type
boolean
Inherited_from
\PhpDocumentorTask::$$linksource  
Propertyprotected\Location  $location= ''
inherited

Stored buildfile location

Inherited from: \Task::$$location\PhpDocumentorTask::$$location
Details
Type
\Location
Inherited_from
\Task::$$location  
Inherited_from
\PhpDocumentorTask::$$location  
Propertyprotectedstring  $output= ''
inherited

Package output format.Inherited from: \PhpDocumentorTask::$$output
Details
Type
string
Inherited_from
\PhpDocumentorTask::$$output  
Propertyprotectedstring  $packages= ''
inherited

Comma-separated list of packages to output.Inherited from: \PhpDocumentorTask::$$packages
Details
Type
string
Inherited_from
\PhpDocumentorTask::$$packages  
Propertyprotectedboolean  $parsePrivate= 'false'
inherited

Whether to parse private members.Inherited from: \PhpDocumentorTask::$$parsePrivate
Default valuefalseDetails
Type
boolean
Inherited_from
\PhpDocumentorTask::$$parsePrivate  
Propertyprotectedboolean  $pear= 'false'
inherited

Whether to parse as a PEAR repository.Inherited from: \PhpDocumentorTask::$$pear
Default valuefalseDetails
Type
boolean
Inherited_from
\PhpDocumentorTask::$$pear  
Propertyprotected  $programPath= ''phpdoc''

The path to the executable for phpDocumentor

Default value'phpdoc'Details
Type
n/a
Propertyprotectedarray  $projDocFilesets= 'array()'
inherited

FileSet[] Project documentation (README/INSTALL/CHANGELOG) files.Inherited from: \PhpDocumentorTask::$$projDocFilesets
Default valuearray()Details
Type
array
Inherited_from
\PhpDocumentorTask::$$projDocFilesets  
Propertyprotected\Project  $project= 'null'
inherited

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::$$project
Default valuenullDetails
Type
\Project
Inherited_from
\ProjectComponent::$$project  
Inherited_from
\Task::$$project  
Inherited_from
\PhpDocumentorTask::$$project  
Propertyprotectedboolean  $quiet= 'false'
inherited

Wheter to suppress output.Inherited from: \PhpDocumentorTask::$$quiet
Default valuefalseDetails
Type
boolean
Inherited_from
\PhpDocumentorTask::$$quiet  
Propertyprotected  $sourcepath= 'NULL'
Default valueNULLDetails
Type
n/a
Propertyprotected\Target  $target= ''
inherited

Owning Target object

Inherited from: \Task::$$target\PhpDocumentorTask::$$target
Details
Type
\Target
Inherited_from
\Task::$$target  
Inherited_from
\PhpDocumentorTask::$$target  
Propertyprotectedstring  $taskName= ''
inherited

Taskname for logger

Inherited from: \Task::$$taskName\PhpDocumentorTask::$$taskName
Details
Type
string
Inherited_from
\Task::$$taskName  
Inherited_from
\PhpDocumentorTask::$$taskName  
Propertyprotectedstring  $taskType= ''
inherited

Internal taskname (req)

Inherited from: \Task::$$taskType\PhpDocumentorTask::$$taskType
Details
Type
string
Inherited_from
\Task::$$taskType  
Inherited_from
\PhpDocumentorTask::$$taskType  
Propertyprotected\PhingFile  $templateBase= ''
inherited

Base directory for locating template files.Inherited from: \PhpDocumentorTask::$$templateBase
Details
Type
\PhingFile
Inherited_from
\PhpDocumentorTask::$$templateBase  
Propertyprotectedstring  $title= ''
inherited

Title for browser window / package index.Inherited from: \PhpDocumentorTask::$$title
Details
Type
string
Inherited_from
\PhpDocumentorTask::$$title  
Propertyprotectedboolean  $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 valuefalseDetails
Type
boolean
Inherited_from
\PhpDocumentorTask::$$undocumentedelements  
Propertyprotected\RuntimeConfigurable  $wrapper= ''
inherited

Wrapper of the task

Inherited from: \Task::$$wrapper\PhpDocumentorTask::$$wrapper
Details
Type
\RuntimeConfigurable
Inherited_from
\Task::$$wrapper  
Inherited_from
\PhpDocumentorTask::$$wrapper  

Methods

methodprotectedconstructArguments( ) : array

Constructs an argument string for phpDocumentor

Returns
Type Description
array
methodpubliccreateFileset( ) : \FileSet
inherited

Creates a FileSet.

Inherited from: \PhpDocumentorTask::createFileset()
Returns
Type Description
\FileSet
methodpubliccreateProjdocfileset( ) : \FileSet
inherited

Creates a readme/install/changelog fileset.

Inherited from: \PhpDocumentorTask::createProjdocfileset()
Returns
Type Description
\FileSet
methodprotectedfindPhpDocumentorInstall( ) : 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
methodpublicgetDescription( ) : string
inherited

Returns the textual description of the task

Inherited from: \Task::getDescription()\PhpDocumentorTask::getDescription()
Returns
Type Description
string The text description of the task
methodpublicgetLocation( ) : \Location
inherited

Returns the location within the buildfile this task occurs. Used by {@link BuildException} to give detailed error messages.

Inherited from: \Task::getLocation()\PhpDocumentorTask::getLocation()
Returns
Type Description
\Location The location object describing the position of this task within the buildfile.
methodpublicgetOwningTarget( ) : \Target
inherited

Returns the owning target of this task.

Inherited from: \Task::getOwningTarget()\PhpDocumentorTask::getOwningTarget()
Returns
Type Description
\Target The target object that owns this task
methodpublicgetProgramPath( ) : void

Returns the path to the phpDocumentor executable

methodpublicgetProject( ) : \Project
inherited

Returns a reference to current project

Inherited from: \ProjectComponent::getProject()\Task::getProject()\PhpDocumentorTask::getProject()
Returns
Type Description
\Project Reference to current porject object
methodprotectedgetRegisterSlot( string $slotName ) : void
inherited

Returns a name

Inherited from: \Task::getRegisterSlot()\PhpDocumentorTask::getRegisterSlot()
Parameters
Name Type Description
$slotName string
methodpublicgetRuntimeConfigurableWrapper( ) : \RuntimeConfigurable
inherited

Returns the wrapper object for runtime configuration

Inherited from: \Task::getRuntimeConfigurableWrapper()\PhpDocumentorTask::getRuntimeConfigurableWrapper()
Returns
Type Description
\RuntimeConfigurable The wrapper object used by this task
methodpublicgetTaskName( ) : string
inherited

Returns the name of task, used only for log messages

Inherited from: \Task::getTaskName()\PhpDocumentorTask::getTaskName()
Returns
Type Description
string Name of this task
methodpublicgetTaskType( ) : string
inherited

Returns the name of the task under which it was invoked, usually the XML tagname

Inherited from: \Task::getTaskType()\PhpDocumentorTask::getTaskType()
Returns
Type Description
string The type of this task (XML Tag)
methodpublicinit( ) : 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.

Throws
Exception Description
\BuildException
methodpubliclog( string $msg, integer $level = Project::MSG_INFO ) : void
inherited

Provides a project level log event to the task.

Inherited from: \Task::log()\PhpDocumentorTask::log()
Parameters
Name Type Description
$msg string

The message to log

$level integer

The priority of the message

Details
See
\BuildEvent  
See
\BuildListener  
methodpublicmain( ) : 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.

Throws
Exception Description
\BuildException - if the phpdoc classes can't be loaded.
methodpublicmaybeConfigure( ) : void
inherited

Configure this task if it hasn't been done already.

Inherited from: \Task::maybeConfigure()\PhpDocumentorTask::maybeConfigure()
methodpublicperform( ) : void
inherited

Perfrom this task

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

Set a directory to search for configuration files in.

Inherited from: \PhpDocumentorTask::setConfigdir()
Parameters
Name Type Description
$d \PhingFile
methodpublicsetCustomtags( 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
methodpublicsetDefaultcategoryname( string $name ) : void
inherited

Sets the default category name.

Inherited from: \PhpDocumentorTask::setDefaultcategoryname()
Parameters
Name Type Description
$name string
methodpublicsetDefaultpackagename( string $name ) : void
inherited

Sets the default package name.

Inherited from: \PhpDocumentorTask::setDefaultpackagename()
Parameters
Name Type Description
$name string
methodpublicsetDescription( string $desc ) : void
inherited

Sets a textual description of the task

Inherited from: \Task::setDescription()\PhpDocumentorTask::setDescription()
Parameters
Name Type Description
$desc string

The text describing the task

methodpublicsetDestdir(  $destdir ) : void
inherited

Set the destination directory for the generated documentation

Inherited from: \PhpDocumentorTask::setDestdir()
Parameters
Name Type Description
$destdir
methodpublicsetExamplesdir( \PhingFile $d ) : void
inherited

Set a directory to search for examples in.

Inherited from: \PhpDocumentorTask::setExamplesdir()
Parameters
Name Type Description
$d \PhingFile
methodpublicsetIgnore( string $sIgnore ) : void
inherited

Set files to ignore

Inherited from: \PhpDocumentorTask::setIgnore()
Parameters
Name Type Description
$sIgnore string
methodpublicsetIgnoresymlinks( bool $bSet ) : void

Ignore symlinks to other files or directories.

Parameters
Name Type Description
$bSet bool
methodpublicsetIgnoretags( string $tags ) : void
inherited

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

Inherited from: \PhpDocumentorTask::setIgnoretags()
Parameters
Name Type Description
$tags string
methodpublicsetJavadocdesc(  $javadoc ) : void
inherited

Whether to use javadoc descriptions (more primitive).

Inherited from: \PhpDocumentorTask::setJavadocdesc()
Parameters
Name Type Description
$javadoc

boolean

methodpublicsetLinksource(  $b ) : void
inherited

Set whether to generate sourcecode for each file parsed

Inherited from: \PhpDocumentorTask::setLinksource()
Parameters
Name Type Description
$b

boolean

methodpublicsetLocation( \Location $location ) : void
inherited

Sets the location within the buildfile this task occurs. Called by the parser to set location information.

Inherited from: \Task::setLocation()\PhpDocumentorTask::setLocation()
Parameters
Name Type Description
$location \Location

The location object describing the position of this task within the buildfile.

methodpublicsetOutput( string $output ) : void
inherited

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

Inherited from: \PhpDocumentorTask::setOutput()
Parameters
Name Type Description
$output string
methodpublicsetOwningTarget( \Target $target ) : void
inherited

Sets the owning target this task belongs to.

Inherited from: \Task::setOwningTarget()\PhpDocumentorTask::setOwningTarget()
Parameters
Name Type Description
$target \Target

Reference to owning target

methodpublicsetPackageoutput( string $packages ) : void
inherited

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

Inherited from: \PhpDocumentorTask::setPackageoutput()
Parameters
Name Type Description
$packages string
methodpublicsetParseprivate(  $parseprivate ) : void
inherited

Should private members/classes be documented

Inherited from: \PhpDocumentorTask::setParseprivate()
Parameters
Name Type Description
$parseprivate

boolean

methodpublicsetPear( boolean $b ) : void
inherited

Set whether to parse as PEAR repository.

Inherited from: \PhpDocumentorTask::setPear()
Parameters
Name Type Description
$b boolean
methodprotectedsetPhpDocumentorOptions( \PhingPhpDocumentorSetup $phpdoc ) : void
inherited

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

Inherited from: \PhpDocumentorTask::setPhpDocumentorOptions()
Parameters
Name Type Description
$phpdoc \PhingPhpDocumentorSetup
methodpublicsetProgramPath(  $programPath ) : void

Sets the path to the phpDocumentor executable

Parameters
Name Type Description
$programPath
methodpublicsetProject( \Project $project ) : void
inherited

References the project to the current component.

Inherited from: \ProjectComponent::setProject()\Task::setProject()\PhpDocumentorTask::setProject()
Parameters
Name Type Description
$project \Project

The reference to the current project

methodpublicsetQuiet( boolean $b ) : void
inherited

Set whether to suppress output.

Inherited from: \PhpDocumentorTask::setQuiet()
Parameters
Name Type Description
$b boolean
methodpublicsetRuntimeConfigurableWrapper( \RuntimeConfigurable $wrapper ) : void
inherited

Sets the wrapper object this task should use for runtime configurable elements.

Inherited from: \Task::setRuntimeConfigurableWrapper()\PhpDocumentorTask::setRuntimeConfigurableWrapper()
Parameters
Name Type Description
$wrapper \RuntimeConfigurable

The wrapper object this task should use

methodpublicsetSourcecode(  $b ) : void
inherited

Set whether to generate sourcecode for each file parsed

Inherited from: \PhpDocumentorTask::setSourcecode()
Parameters
Name Type Description
$b

boolean

methodpublicsetSourcepath(  $sourcepath ) : void

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

Parameters
Name Type Description
$sourcepath
methodpublicsetTarget(  $destdir ) : void
inherited

Alias for {@link setDestdir()}.

Inherited from: \PhpDocumentorTask::setTarget()
Parameters
Name Type Description
$destdir
Details
See
\setDestdir()  
methodpublicsetTaskName( string $name ) : string
inherited

Sets the name of this task for log messages

Inherited from: \Task::setTaskName()\PhpDocumentorTask::setTaskName()
Parameters
Name Type Description
$name string
Returns
Type Description
string A string representing the name of this task for log
methodpublicsetTaskType( string $name ) : void
inherited

Sets the type of the task. Usually this is the name of the XML tag

Inherited from: \Task::setTaskType()\PhpDocumentorTask::setTaskType()
Parameters
Name Type Description
$name string

The type of this task (XML Tag)

methodpublicsetTemplateBase(  $oTemplateBase ) : void
inherited

Set base location of all templates for this parse.

Inherited from: \PhpDocumentorTask::setTemplateBase()
Parameters
Name Type Description
$oTemplateBase
methodpublicsetTitle(  $title ) : void
inherited

Set the title for the generated documentation

Inherited from: \PhpDocumentorTask::setTitle()
Parameters
Name Type Description
$title
methodpublicsetUndocumentedelements( 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
methodprotectedvalidate( ) : 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.18.1.