tasks/ext/phpdoc/PhpDocumentorTask.php

Show:

inherited

Classes
- \PhpDocumentorTask

Table of Contents

$Id: PhpDocumentorTask.php 1101 2011-05-18 17:49:55Z 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.

\PhpDocumentorTask
jump to top

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: PhpDocumentorTask.php 1101 2011-05-18 17:49:55Z mrook $

Properties

\PhingFile
                 $configDir= ''

Directory in which to look for configuration files.

Details

Type: \PhingFile

string
                 $customtags= ''''

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

Default value''Details

Type: string

string
                 $defaultCategoryName= ''

Default category name.

Details

Type: string

string
                 $defaultPackageName= ''

Default package name.

Details

Type: string

string
                 $description= ''

inherited

description of the taskInherited from: \Task::$description

Details

Type: string
Inherited_from: \Task::$description

\PhingFile
                 $destdir= ''

The target directory for output files.

Details

Type: \PhingFile

\PhingFile
                 $examplesDir= ''

Directory in which to look for examples.

Details

Type: \PhingFile

array
                 $filesets= 'array()'

FileSet[] Filesets for files to parse.

Default valuearray()Details

Type: array

string
                 $ignore= ''''

files to ignore

Default value''Details

Type: string

string
                 $ignoreTags= ''

Comma-separated list of tags to ignore.

Details

Type: string

boolean
                 $javadocDesc= 'false'

Whether to use javadoc descriptions (more primitive).

Default valuefalseDetails

Type: boolean

boolean
                 $linksource= 'false'

Whether to generate sourcecode for each file parsed.

Default valuefalseDetails

Type: boolean

\Location
                 $location= ''

inherited

stored buildfile locationInherited from: \Task::$location

Details

Type: \Location
Inherited_from: \Task::$location

string
                 $output= ''

Package output format.

Details

Type: string

string
                 $packages= ''

Comma-separated list of packages to output.

Details

Type: string

boolean
                 $parsePrivate= 'false'

Whether to parse private members.

Default valuefalseDetails

Type: boolean

boolean
                 $pear= 'false'

Whether to parse as a PEAR repository.

Default valuefalseDetails

Type: boolean

array
                 $projDocFilesets= 'array()'

FileSet[] Project documentation (README/INSTALL/CHANGELOG) files.

Default valuearray()Details

Type: array

\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

Default valuenullDetails

Type: \Project
Inherited_from: \ProjectComponent::$project

boolean
                 $quiet= 'false'

Wheter to suppress output.

Default valuefalseDetails

Type: boolean

\Target
                 $target= ''

inherited

owning Target objectInherited from: \Task::$target

Details

Type: \Target
Inherited_from: \Task::$target

string
                 $taskName= ''

inherited

Taskname for loggerInherited from: \Task::$taskName

Details

Type: string
Inherited_from: \Task::$taskName

string
                 $taskType= ''

inherited

internal taskname (req)Inherited from: \Task::$taskType

Details

Type: string
Inherited_from: \Task::$taskType

\PhingFile
                 $templateBase= ''

Base directory for locating template files.

Details

Type: \PhingFile

string
                 $title= ''

Title for browser window / package index.

Details

Type: string

boolean
                 $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

\RuntimeConfigurable
                 $wrapper= ''

inherited

wrapper of the taskInherited from: \Task::$wrapper

Details

Type: \RuntimeConfigurable
Inherited_from: \Task::$wrapper

Methods

createFileset(
          
          )
        
        :
          \FileSet

Creates a FileSet.

Returns

Type	Description
\FileSet

createProjdocfileset(
          
          )
        
        :
          \FileSet

Creates a readme/install/changelog fileset.

Returns

Type	Description
\FileSet

findPhpDocumentorInstall(
          
          )
        
        :
          void

Searches include_path for PhpDocumentor install and adjusts include_path appropriately.

Throws

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

getDescription(
          
          )
        
        :
          string

inherited

Returns the textual description of the task

Inherited from: \Task::getDescription()

Returns

Type	Description
string	The text description of the task

getLocation(
          
          )
        
        :
          \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.

getOwningTarget(
          
          )
        
        :
          \Target

inherited

Returns the owning target of this task.

Inherited from: \Task::getOwningTarget()

Returns

Type	Description
\Target	The target object that owns this task

getProject(
          
          )
        
        :
          \Project

inherited

Returns a reference to current project

Inherited from: \ProjectComponent::getProject()

Returns

Type	Description
\Project	Reference to current porject object

getRegisterSlot(
           $slotName
          )
        
        :
          void

inherited

Returns a name

Inherited from: \Task::getRegisterSlot()

Parameters

Name	Type	Description
$slotName

getRuntimeConfigurableWrapper(
          
          )
        
        :
          \RuntimeConfigurable

inherited

Returns the wrapper object for runtime configuration

Inherited from: \Task::getRuntimeConfigurableWrapper()

Returns

Type	Description
\RuntimeConfigurable	The wrapper object used by this task

getTaskName(
          
          )
        
        :
          string

inherited

Returns the name of task, used only for log messages

Inherited from: \Task::getTaskName()

Returns

Type	Description
string	Name of this task

getTaskType(
          
          )
        
        :
          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)

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

log(
          string $msg, integer $level
              =
              Project::MSG_INFO
          )
        
        :
          void

inherited

Provides a project level log event to the task.

Inherited from: \Task::log()

@param string $msg The message to be logged.

Parameters

Name	Type	Description
$msg	string	The message to log
$level	integer	The priority of the message

Details

See: \BuildEvent
See: \BuildListener

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.

maybeConfigure(
          
          )
        
        :
          void

inherited

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

Inherited from: \Task::maybeConfigure()

perform(
          
          )
        
        :
          void

inherited

Perfrom this task

Inherited from: \Task::perform()

setConfigdir(
          \PhingFile $d
          )
        
        :
          void

Set a directory to search for configuration files in.

Parameters

Name	Type	Description
$d	\PhingFile

setCustomtags(
          string $sCustomtags
          )
        
        :
          void

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

Parameters

Name	Type	Description
$sCustomtags	string

setDefaultcategoryname(
          string $name
          )
        
        :
          void

Sets the default category name.

Parameters

Name	Type	Description
$name	string

setDefaultpackagename(
          string $name
          )
        
        :
          void

Sets the default package name.

Parameters

Name	Type	Description
$name	string

setDescription(
          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

setDestdir(
           $destdir
          )
        
        :
          void

Set the destination directory for the generated documentation

Parameters

Name	Type	Description
$destdir

setExamplesdir(
          \PhingFile $d
          )
        
        :
          void

Set a directory to search for examples in.

Parameters

Name	Type	Description
$d	\PhingFile

setIgnore(
          string $sIgnore
          )
        
        :
          void

Set files to ignore

Parameters

Name	Type	Description
$sIgnore	string

setIgnoretags(
          string $tags
          )
        
        :
          void

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

Parameters

Name	Type	Description
$tags	string

setJavadocdesc(
           $javadoc
          )
        
        :
          void

Whether to use javadoc descriptions (more primitive).

Parameters

Name	Type	Description
$javadoc		boolean

setLinksource(
           $b
          )
        
        :
          void

Set whether to generate sourcecode for each file parsed

Parameters

Name	Type	Description
$b		boolean

setLocation(
          \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.

setOutput(
          string $output
          )
        
        :
          void

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

Parameters

Name	Type	Description
$output	string

setOwningTarget(
          \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

setPackageoutput(
          string $packages
          )
        
        :
          void

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

Parameters

Name	Type	Description
$packages	string

setParseprivate(
           $parseprivate
          )
        
        :
          void

Should private members/classes be documented

Parameters

Name	Type	Description
$parseprivate		boolean

setPear(
          boolean $b
          )
        
        :
          void

Set whether to parse as PEAR repository.

Parameters

Name	Type	Description
$b	boolean

setPhpDocumentorOptions(
          \PhingPhpDocumentorSetup $phpdoc
          )
        
        :
          void

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

Parameters

Name	Type	Description
$phpdoc	\PhingPhpDocumentorSetup

setProject(
          \Project $project
          )
        
        :
          void

inherited

References the project to the current component.

Inherited from: \ProjectComponent::setProject()

Parameters

Name	Type	Description
$project	\Project	The reference to the current project

setQuiet(
          boolean $b
          )
        
        :
          void

Set whether to suppress output.

Parameters

Name	Type	Description
$b	boolean

setRuntimeConfigurableWrapper(
          \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

setSourcecode(
           $b
          )
        
        :
          void

Set whether to generate sourcecode for each file parsed

Parameters

Name	Type	Description
$b		boolean

setTarget(
           $destdir
          )
        
        :
          void

Alias for {@link setDestdir()}.

Parameters

Name	Type	Description
$destdir

Details

See: \setDestdir()

setTaskName(
           $name
          )
        
        :
          string

inherited

Sets the name of this task for log messages

Inherited from: \Task::setTaskName()

Parameters

Name	Type	Description
$name

Returns

Type	Description
string	A string representing the name of this task for log

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

setTemplateBase(
           $oTemplateBase
          )
        
        :
          void

Set base location of all templates for this parse.

Parameters

Name	Type	Description
$oTemplateBase

setTitle(
           $title
          )
        
        :
          void

Set the title for the generated documentation

Parameters

Name	Type	Description
$title

setUndocumentedelements(
          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

validate(
          
          )
        
        :
          void

Validates that necessary minimum options have been set.

Throws

Exception	Description
\BuildException	if validation doesn't pass

tasks/ext/phpdoc/PhpDocumentorTask.php

\PhpDocumentorTaskjump to top

Properties

Methods

\PhpDocumentorTask
jump to top