tasks/ext/phpdoc/PhpDocumentor2Task.php

Show: inherited
Table of Contents

PhpDocumentor2 Task (http://www.phpdoc.org) Based on the DocBlox Task

Author
Michiel Rook  
Package
phing.tasks.ext.phpdoc  
Since
2.4.10  
Version
$Id: eaa494390770adc752097a412d63fb863482fd5d $  

\PhpDocumentor2Task

Package: phing\tasks\ext\phpdoc

PhpDocumentor2 Task (http://www.phpdoc.org) Based on the DocBlox Task

Use {@link Project#createTask} to register a new Task.

Parent(s)
\Task < \ProjectComponent
Author
Michiel Rook  
Copyright
2001,2002 THYRELL. All rights reserved  
Since
2.4.10  
Version
$Id: eaa494390770adc752097a412d63fb863482fd5d $  

Properties

Propertyprotectedstring  $description= ''
inherited

Description of the task

Inherited from: \Task::$$description
Details
Type
string
Inherited_from
\Task::$$description  
Propertyprivate\PhingFile  $destDir= 'null'

Destination/target directory

Default valuenullDetails
Type
\PhingFile
Propertyprivate\FileSet[]  $filesets= 'array()'

List of filesets

Default valuearray()Details
Type
\FileSet[]
Propertyprotected\Location  $location= ''
inherited

Stored buildfile location

Inherited from: \Task::$$location
Details
Type
\Location
Inherited_from
\Task::$$location  
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  
Propertyprivateboolean  $quiet= 'true'

Force phpDocumentor to be quiet

Default valuetrueDetails
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  
Propertyprivatestring  $template= '"responsive"'

name of the template to use

Default value"responsive"Details
Type
string
Propertyprivatestring  $title= '""'

Title of the project

Default value""Details
Type
string
Propertyprotected\RuntimeConfigurable  $wrapper= ''
inherited

Wrapper of the task

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

Methods

methodpubliccreateFileSet( ) : \FileSet

Nested creator, adds a set of files (nested fileset attribute).

Returns
Type Description
\FileSet
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
methodprivateinitializePhpDocumentor( ) : void

Finds and initializes the phpDocumentor installation

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

Task entry point

Should throw a BuildException if someting goes wrong with the build

This is abstract here. Must be overloaded by real tasks.

Details
See
\Task::main()  
methodpublicmaybeConfigure( ) : void
inherited

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

Inherited from: \Task::maybeConfigure()
methodprivateparseFiles( ) : string

Build a list of files (from the fileset elements) and call the phpDocumentor parser

Returns
Type Description
string
methodpublicperform( ) : void
inherited

Perfrom this task

Inherited from: \Task::perform()
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( \PhingFile $destDir ) : void

Sets destination/target directory

Parameters
Name Type Description
$destDir \PhingFile
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( \PhingFile $output ) : void

Convenience setter (@see setDestDir)

Parameters
Name Type Description
$output \PhingFile
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

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 $quiet ) : void

Forces phpDocumentor to be quiet

Parameters
Name Type Description
$quiet 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

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)

methodpublicsetTemplate( \strings $template ) : void

Sets the template to use

Parameters
Name Type Description
$template \strings
methodpublicsetTitle( \strings $title ) : void

Sets the title of the project

Parameters
Name Type Description
$title \strings
Documentation was generated by DocBlox 0.18.1.