tasks/ext/apigen/ApiGenTask.php

Show: inherited
Table of Contents

ApiGen task (http://apigen.org).

Author
Martin Srank  
Author
Jaroslav Hanslík  
Package
phing.tasks.ext.apigen  
Since
2.4.10  

\ApiGenTask

Package: phing\tasks\ext\apigen

ApiGen task (http://apigen.org).

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

Parent(s)
\Task < \ProjectComponent
Author
Martin Srank  
Author
Jaroslav Hanslík  
Copyright
2001,2002 THYRELL. All rights reserved  
Since
2.4.10  
Version
$Id$  

Properties

Propertyprotectedstring  $description= ''
inherited

Description of the task

Inherited from: \Task::$$description
Details
Type
string
Inherited_from
\Task::$$description  
Propertyprivatestring  $executable= ''apigen''

Default ApiGen executable name.

Default value'apigen'Details
Type
string
Propertyprotected\Location  $location= ''
inherited

Stored buildfile location

Inherited from: \Task::$$location
Details
Type
\Location
Inherited_from
\Task::$$location  
Propertyprivatearray  $options= 'array( 'progressbar' => false, 'colors' => false, 'update-check' => false )'

Default options for ApiGen.

Default valuearray( 'progressbar' => false, 'colors' => false, 'update-check' => false )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  
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\RuntimeConfigurable  $wrapper= ''
inherited

Wrapper of the task

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

Methods

methodprotectedconstructArguments( ) : string

Generates command line arguments for the ApiGen executable.

Returns
Type Description
string
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

Runs ApiGen.

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 something is wrong.
Details
See
\Task::main()  
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()
methodpublicsetAccessLevels( string $accessLevels ) : void

Sets the element access levels.

Documentation only for methods and properties with the given access level will be generated.

Parameters
Name Type Description
$accessLevels string
methodpublicsetAllowedHtml( string $allowedHtml ) : void

Sets a list of HTML tags allowed in the documentation.

Parameters
Name Type Description
$allowedHtml string
methodpublicsetAutocomplete( string $autocomplete ) : void

Sets element types for search input autocomplete.

Parameters
Name Type Description
$autocomplete string
methodpublicsetBaseUrl( string $baseUrl ) : void

Sets the documentation base URL.

Parameters
Name Type Description
$baseUrl string
methodpublicsetCharset( string $charset ) : void

Sets the character set of source files.

Parameters
Name Type Description
$charset string
methodpublicsetConfig( string $config ) : void

Sets the config file name.

Parameters
Name Type Description
$config string
methodpublicsetDebug( boolean $debug ) : void

Enables/disables the debug mode.

Parameters
Name Type Description
$debug boolean
methodpublicsetDeprecated( boolean $deprecated ) : void

Sets if documentation for deprecated elements should be generated.

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

methodpublicsetDestination( string $destination ) : void

Sets the destination directory.

Parameters
Name Type Description
$destination string
methodpublicsetDownload( boolean $download ) : void

Sets if a link to download documentation as a ZIP archive should be generated.

Parameters
Name Type Description
$download boolean
methodpublicsetExclude( string $exclude ) : void

Sets masks (case sensitive) to exclude files or directories from processing.

Parameters
Name Type Description
$exclude string
methodpublicsetExecutable( string $executable ) : void

Sets the ApiGen executable name.

Parameters
Name Type Description
$executable string
methodpublicsetExtensions( string $extensions ) : void

Sets list of allowed file extensions.

Parameters
Name Type Description
$extensions string
methodpublicsetGoogleAnalytics( string $googleAnalytics ) : void

Sets the Google Analytics tracking code.

Parameters
Name Type Description
$googleAnalytics string
methodpublicsetGoogleCseId( string $googleCseId ) : void

Sets the Google Custom Search ID.

Parameters
Name Type Description
$googleCseId string
methodpublicsetGoogleCseLabel( string $googleCseLabel ) : void

Sets the Google Custom Search label.

Parameters
Name Type Description
$googleCseLabel string
methodpublicsetGroups( string $groups ) : void

Sets how elements should be grouped in the menu.

Parameters
Name Type Description
$groups string
methodpublicsetInternal( boolean $internal ) : void

Sets if documentation for elements marked as internal and internal documentation parts should be generated.

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

methodpublicsetMain( string $main ) : void

Sets the main project name prefix.

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

methodpublicsetPhp( boolean $php ) : void

Sets if documentation for PHP internal classes should be generated.

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

Enables/disables scaning and generating messages.

Parameters
Name Type Description
$quiet boolean
methodpublicsetReport( string $report ) : void

Sets a file name for checkstyle report of poorly documented elements.

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

methodpublicsetSkipDocPath( string $skipDocPath ) : void

Sets masks to exclude elements from documentation generating.

Parameters
Name Type Description
$skipDocPath string
methodpublicsetSkipDocPrefix( string $skipDocPrefix ) : void

Sets a name prefix to exclude elements from documentation generating.

Parameters
Name Type Description
$skipDocPrefix string
methodpublicsetSource( string $source ) : void

Sets source files or directories.

Parameters
Name Type Description
$source string
methodpublicsetSourceCode( boolean $sourceCode ) : void

Sets if highlighted source code files should be generated.

Parameters
Name Type Description
$sourceCode boolean
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)

methodpublicsetTemplateConfig( string $templateConfig ) : void

Sets the template config file name.

Parameters
Name Type Description
$templateConfig string
methodpublicsetTitle( string $title ) : void

Sets the title of generated documentation.

Parameters
Name Type Description
$title string
methodpublicsetTodo( boolean $todo ) : void

Sets if documentation of tasks should be generated.

Parameters
Name Type Description
$todo boolean
methodpublicsetTree( boolean $tree ) : void

Sets if tree view of classes, interfaces, traits and exceptions should be generated.

Parameters
Name Type Description
$tree boolean
methodpublicsetUpdateCheck( boolean $updateCheck ) : void

Enables/disables the check for ApiGen updates.

Parameters
Name Type Description
$updateCheck boolean
methodpublicsetWipeout( boolean $wipeout ) : void

Sets if the destination directory should be wiped out first.

Parameters
Name Type Description
$wipeout boolean
Documentation was generated by DocBlox 0.18.1.