tasks/ext/phpdoc/PhpDocumentorExternalTask.php

Show:

inherited

Classes
- \PhpDocumentorExternalTask

Table of Contents

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

string
                 $description= ''

inherited

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

Details

Type: string
Inherited_from: \Task::$description

\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 valuearray()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 valuefalseDetails

Type: bool

boolean
                 $javadocDesc= 'false'

inherited

Whether to use javadoc descriptions (more primitive).Inherited from: \PhpDocumentorTask::$javadocDesc

Default valuefalseDetails

Type: boolean
Inherited_from: \PhpDocumentorTask::$javadocDesc

boolean
                 $linksource= 'false'

inherited

Whether to generate sourcecode for each file parsed.Inherited from: \PhpDocumentorTask::$linksource

Default valuefalseDetails

Type: boolean
Inherited_from: \PhpDocumentorTask::$linksource

\Location
                 $location= ''

inherited

stored buildfile locationInherited from: \Task::$location

Details

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

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 valuefalseDetails

Type: boolean
Inherited_from: \PhpDocumentorTask::$parsePrivate

boolean
                 $pear= 'false'

inherited

Whether to parse as a PEAR repository.Inherited from: \PhpDocumentorTask::$pear

Default valuefalseDetails

Type: boolean
Inherited_from: \PhpDocumentorTask::$pear


                 $programPath= ''phpdoc''

The path to the executable for phpDocumentor

Default value'phpdoc'Details

Type

array
                 $projDocFilesets= 'array()'

inherited

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

Default valuearray()Details

Type: array
Inherited_from: \PhpDocumentorTask::$projDocFilesets

\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'

inherited

Wheter to suppress output.Inherited from: \PhpDocumentorTask::$quiet

Default valuefalseDetails

Type: boolean
Inherited_from: \PhpDocumentorTask::$quiet


                 $sourcepath= 'NULL'

Default valueNULLDetails

Type

\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= ''

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 valuefalseDetails

Type: boolean
Inherited_from: \PhpDocumentorTask::$undocumentedelements

\RuntimeConfigurable
                 $wrapper= ''

inherited

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

Details

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

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

getProgramPath(
          
          )
        
        :
          void

Returns the path to the phpDocumentor executable

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)

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

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

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

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

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

inherited

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

Inherited from: \PhpDocumentorTask::setOutput()

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

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

inherited

Set whether to suppress output.

Inherited from: \PhpDocumentorTask::setQuiet()

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

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

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

tasks/ext/phpdoc/PhpDocumentorExternalTask.php

\PhpDocumentorExternalTaskjump to top

Properties

Methods

\PhpDocumentorExternalTask
jump to top