tasks/ext/phpdoc/PhpDocumentorTask.php

Show: inherited
Table of Contents

\PhpDocumentorTask

Package: phing\tasks\ext\phpdoc

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

Propertyprotected\PhingFile  $configDir= ''

Directory in which to look for configuration files.
Details
Type
\PhingFile
Propertyprotectedstring  $customtags= ''''

custom tags, will be recognized and put in tags[] instead of unknowntags[].
Default value''Details
Type
string
Propertyprotectedstring  $defaultCategoryName= ''

Default category name.
Details
Type
string
Propertyprotectedstring  $defaultPackageName= ''

Default package name.
Details
Type
string
Propertyprotectedstring  $description= ''
inherited

Description of the task

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

The target directory for output files.
Details
Type
\PhingFile
Propertyprotected\PhingFile  $examplesDir= ''

Directory in which to look for examples.
Details
Type
\PhingFile
Propertyprotectedarray  $filesets= 'array()'

FileSet[] Filesets for files to parse.
Default valuearray()Details
Type
array
Propertyprotectedstring  $ignore= ''''

files to ignore
Default value''Details
Type
string
Propertyprotectedstring  $ignoreTags= ''

Comma-separated list of tags to ignore.
Details
Type
string
Propertyprotectedboolean  $javadocDesc= 'false'

Whether to use javadoc descriptions (more primitive).
Default valuefalseDetails
Type
boolean
Propertyprotectedboolean  $linksource= 'false'

Whether to generate sourcecode for each file parsed.
Default valuefalseDetails
Type
boolean
Propertyprotected\Location  $location= ''
inherited

Stored buildfile location

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

Package output format.
Details
Type
string
Propertyprotectedstring  $packages= ''

Comma-separated list of packages to output.
Details
Type
string
Propertyprotectedboolean  $parsePrivate= 'false'

Whether to parse private members.
Default valuefalseDetails
Type
boolean
Propertyprotectedboolean  $pear= 'false'

Whether to parse as a PEAR repository.
Default valuefalseDetails
Type
boolean
Propertyprotectedarray  $projDocFilesets= 'array()'

FileSet[] Project documentation (README/INSTALL/CHANGELOG) files.
Default valuearray()Details
Type
array
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
Default valuenullDetails
Type
\Project
Inherited_from
\ProjectComponent::$$project  
Inherited_from
\Task::$$project  
Propertyprotectedboolean  $quiet= 'false'

Wheter to suppress output.
Default valuefalseDetails
Type
boolean
Propertyprotected\Target  $target= ''
inherited

Owning Target object

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

Taskname for logger

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

Internal taskname (req)

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

Base directory for locating template files.
Details
Type
\PhingFile
Propertyprotectedstring  $title= ''

Title for browser window / package index.
Details
Type
string
Propertyprotectedboolean  $undocumentedelements= 'false'

Control whether or not warnings will be shown for undocumented elements. Useful for identifying classes and methods that haven't yet been documented.
Default valuefalseDetails
Type
boolean
Propertyprotected\RuntimeConfigurable  $wrapper= ''
inherited

Wrapper of the task

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

Methods

methodpubliccreateFileset( ) : \FileSet

Creates a FileSet.

Returns
Type Description
\FileSet
methodpubliccreateProjdocfileset( ) : \FileSet

Creates a readme/install/changelog fileset.

Returns
Type Description
\FileSet
methodprotectedfindPhpDocumentorInstall( ) : void

Searches include_path for PhpDocumentor install and adjusts include_path appropriately.

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()
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()
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()
Returns
Type Description
\Target The target object that owns this task
methodpublicgetProject( ) : \Project
inherited

Returns a reference to current project

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

Returns a name

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

Returns the wrapper object for runtime configuration

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

Called by the parser to let the task initialize properly.

Inherited from: \Task::init()

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()
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 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.

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()
methodpublicperform( ) : void
inherited

Perfrom this task

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

Set a directory to search for configuration files in.

Parameters
Name Type Description
$d \PhingFile
methodpublicsetCustomtags( string $sCustomtags ) : void

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

Parameters
Name Type Description
$sCustomtags string
methodpublicsetDefaultcategoryname( string $name ) : void

Sets the default category name.

Parameters
Name Type Description
$name string
methodpublicsetDefaultpackagename( string $name ) : void

Sets the default package name.

Parameters
Name Type Description
$name string
methodpublicsetDescription( string $desc ) : void
inherited

Sets a textual description of the task

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

The text describing the task

methodpublicsetDestdir(  $destdir ) : void

Set the destination directory for the generated documentation

Parameters
Name Type Description
$destdir
methodpublicsetExamplesdir( \PhingFile $d ) : void

Set a directory to search for examples in.

Parameters
Name Type Description
$d \PhingFile
methodpublicsetIgnore( string $sIgnore ) : void

Set files to ignore

Parameters
Name Type Description
$sIgnore string
methodpublicsetIgnoretags( string $tags ) : void

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

Parameters
Name Type Description
$tags string
methodpublicsetJavadocdesc(  $javadoc ) : void

Whether to use javadoc descriptions (more primitive).

Parameters
Name Type Description
$javadoc

boolean

methodpublicsetLinksource(  $b ) : void

Set whether to generate sourcecode for each file parsed

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()
Parameters
Name Type Description
$location \Location

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

methodpublicsetOutput( string $output ) : void

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

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

Sets the owning target this task belongs to.

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

Reference to owning target

methodpublicsetPackageoutput( string $packages ) : void

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

Parameters
Name Type Description
$packages string
methodpublicsetParseprivate(  $parseprivate ) : void

Should private members/classes be documented

Parameters
Name Type Description
$parseprivate

boolean

methodpublicsetPear( boolean $b ) : void

Set whether to parse as PEAR repository.

Parameters
Name Type Description
$b boolean
methodprotectedsetPhpDocumentorOptions( \PhingPhpDocumentorSetup $phpdoc ) : void

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

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

References the project to the current component.

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

The reference to the current project

methodpublicsetQuiet( boolean $b ) : void

Set whether to suppress output.

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()
Parameters
Name Type Description
$wrapper \RuntimeConfigurable

The wrapper object this task should use

methodpublicsetSourcecode(  $b ) : void

Set whether to generate sourcecode for each file parsed

Parameters
Name Type Description
$b

boolean

methodpublicsetTarget(  $destdir ) : void

Alias for {@link setDestdir()}.

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()
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()
Parameters
Name Type Description
$name string

The type of this task (XML Tag)

methodpublicsetTemplateBase(  $oTemplateBase ) : void

Set base location of all templates for this parse.

Parameters
Name Type Description
$oTemplateBase
methodpublicsetTitle(  $title ) : void

Set the title for the generated documentation

Parameters
Name Type Description
$title
methodpublicsetUndocumentedelements( boolean $b ) : void

Control whether or not warnings will be shown for undocumented elements.

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.

Throws
Exception Description
\BuildException if validation doesn't pass
Documentation was generated by DocBlox 0.18.1.