tasks/ext/apigen/ApiGenTask.php
ApiGen task (http://apigen.org).
- Author
- Martin Srank
- Author
- Jaroslav Hanslík
- Package
- phing.tasks.ext.apigen
- Since
- 2.4.10
\ApiGenTask
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


string
$executable= ''apigen''
Default ApiGen executable name.
'apigen'
Details- Type
- string


array
$options= 'array(
'progressbar' => false,
'colors' => false,
'update-check' => false
)'
Default options for ApiGen.
array(
'progressbar' => false,
'colors' => false,
'update-check' => false
)
Details- Type
- array


\Project
$project= 'null'
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::$$projectnull
Details- Type
- \Project
- Inherited_from
- \ProjectComponent::$$project
- Inherited_from
- \Task::$$project
Methods


constructArguments(
)
:
string
Generates command line arguments for the ApiGen executable.
Type | Description |
---|---|
string |


getLocation(
)
:
\Location
Returns the location within the buildfile this task occurs. Used by {@link BuildException} to give detailed error messages.
Inherited from: \Task::getLocation()Type | Description |
---|---|
\Location | The location object describing the position of this task within the buildfile. |


getProject(
)
:
\Project
Returns a reference to current project
Inherited from: \ProjectComponent::getProject()\Task::getProject()Type | Description |
---|---|
\Project | Reference to current porject object |


getRuntimeConfigurableWrapper(
)
:
\RuntimeConfigurable
Returns the wrapper object for runtime configuration
Inherited from: \Task::getRuntimeConfigurableWrapper()Type | Description |
---|---|
\RuntimeConfigurable | The wrapper object used by this task |


getTaskType(
)
:
string
Returns the name of the task under which it was invoked, usually the XML tagname
Inherited from: \Task::getTaskType()Type | Description |
---|---|
string | The type of this task (XML Tag) |


init(
)
:
void
Should throw a BuildException if something goes wrong with the build
This is abstract here, but may not be overloaded by subclasses.
Exception | Description |
---|---|
\BuildException |


log(
string $msg, integer $level
=
Project::MSG_INFO
)
:
void
Name | Type | Description |
---|---|---|
$msg | string | The message to log |
$level | integer | The priority of the message |
- See
- \BuildEvent
- See
- \BuildListener


main(
)
:
void
Runs ApiGen.
Should throw a BuildException if someting goes wrong with the build
This is abstract here. Must be overloaded by real tasks.
Exception | Description |
---|---|
\BuildException | If something is wrong. |
- See
- \Task::main()


maybeConfigure(
)
:
void
Configure this task if it hasn't been done already.
Inherited from: \Task::maybeConfigure()

setAccessLevels(
string $accessLevels
)
:
void
Sets the element access levels.
Documentation only for methods and properties with the given access level will be generated.
Name | Type | Description |
---|---|---|
$accessLevels | string |


setAllowedHtml(
string $allowedHtml
)
:
void
Sets a list of HTML tags allowed in the documentation.
Name | Type | Description |
---|---|---|
$allowedHtml | string |


setAutocomplete(
string $autocomplete
)
:
void
Sets element types for search input autocomplete.
Name | Type | Description |
---|---|---|
$autocomplete | string |


setBaseUrl(
string $baseUrl
)
:
void
Sets the documentation base URL.
Name | Type | Description |
---|---|---|
$baseUrl | string |


setCharset(
string $charset
)
:
void
Sets the character set of source files.
Name | Type | Description |
---|---|---|
$charset | string |


setConfig(
string $config
)
:
void
Sets the config file name.
Name | Type | Description |
---|---|---|
$config | string |


setDebug(
boolean $debug
)
:
void
Enables/disables the debug mode.
Name | Type | Description |
---|---|---|
$debug | boolean |


setDeprecated(
boolean $deprecated
)
:
void
Sets if documentation for deprecated elements should be generated.
Name | Type | Description |
---|---|---|
$deprecated | boolean |


setDescription(
string $desc
)
:
void
Name | Type | Description |
---|---|---|
$desc | string | The text describing the task |


setDestination(
string $destination
)
:
void
Sets the destination directory.
Name | Type | Description |
---|---|---|
$destination | string |


setDownload(
boolean $download
)
:
void
Sets if a link to download documentation as a ZIP archive should be generated.
Name | Type | Description |
---|---|---|
$download | boolean |


setExclude(
string $exclude
)
:
void
Sets masks (case sensitive) to exclude files or directories from processing.
Name | Type | Description |
---|---|---|
$exclude | string |


setExecutable(
string $executable
)
:
void
Sets the ApiGen executable name.
Name | Type | Description |
---|---|---|
$executable | string |


setExtensions(
string $extensions
)
:
void
Sets list of allowed file extensions.
Name | Type | Description |
---|---|---|
$extensions | string |


setGoogleAnalytics(
string $googleAnalytics
)
:
void
Sets the Google Analytics tracking code.
Name | Type | Description |
---|---|---|
$googleAnalytics | string |


setGoogleCseId(
string $googleCseId
)
:
void
Sets the Google Custom Search ID.
Name | Type | Description |
---|---|---|
$googleCseId | string |


setGoogleCseLabel(
string $googleCseLabel
)
:
void
Sets the Google Custom Search label.
Name | Type | Description |
---|---|---|
$googleCseLabel | string |


setGroups(
string $groups
)
:
void
Sets how elements should be grouped in the menu.
Name | Type | Description |
---|---|---|
$groups | string |


setInternal(
boolean $internal
)
:
void
Sets if documentation for elements marked as internal and internal documentation parts should be generated.
Name | Type | Description |
---|---|---|
$internal | boolean |


setLocation(
\Location $location
)
:
void
Sets the location within the buildfile this task occurs. Called by the parser to set location information.
Inherited from: \Task::setLocation()Name | Type | Description |
---|---|---|
$location | \Location | The location object describing the position of this task within the buildfile. |


setMain(
string $main
)
:
void
Sets the main project name prefix.
Name | Type | Description |
---|---|---|
$main | string |


setOwningTarget(
\Target $target
)
:
void
Name | Type | Description |
---|---|---|
$target | \Target | Reference to owning target |


setPhp(
boolean $php
)
:
void
Sets if documentation for PHP internal classes should be generated.
Name | Type | Description |
---|---|---|
$php | boolean |


setProject(
\Project $project
)
:
void
References the project to the current component.
Inherited from: \ProjectComponent::setProject()\Task::setProject()Name | Type | Description |
---|---|---|
$project | \Project | The reference to the current project |


setQuiet(
boolean $quiet
)
:
void
Enables/disables scaning and generating messages.
Name | Type | Description |
---|---|---|
$quiet | boolean |


setReport(
string $report
)
:
void
Sets a file name for checkstyle report of poorly documented elements.
Name | Type | Description |
---|---|---|
$report | string |


setRuntimeConfigurableWrapper(
\RuntimeConfigurable $wrapper
)
:
void
Sets the wrapper object this task should use for runtime configurable elements.
Inherited from: \Task::setRuntimeConfigurableWrapper()Name | Type | Description |
---|---|---|
$wrapper | \RuntimeConfigurable | The wrapper object this task should use |


setSkipDocPath(
string $skipDocPath
)
:
void
Sets masks to exclude elements from documentation generating.
Name | Type | Description |
---|---|---|
$skipDocPath | string |


setSkipDocPrefix(
string $skipDocPrefix
)
:
void
Sets a name prefix to exclude elements from documentation generating.
Name | Type | Description |
---|---|---|
$skipDocPrefix | string |


setSource(
string $source
)
:
void
Sets source files or directories.
Name | Type | Description |
---|---|---|
$source | string |


setSourceCode(
boolean $sourceCode
)
:
void
Sets if highlighted source code files should be generated.
Name | Type | Description |
---|---|---|
$sourceCode | boolean |


setTaskName(
string $name
)
:
string
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
string | A string representing the name of this task for log |


setTaskType(
string $name
)
:
void
Sets the type of the task. Usually this is the name of the XML tag
Inherited from: \Task::setTaskType()Name | Type | Description |
---|---|---|
$name | string | The type of this task (XML Tag) |


setTemplateConfig(
string $templateConfig
)
:
void
Sets the template config file name.
Name | Type | Description |
---|---|---|
$templateConfig | string |


setTitle(
string $title
)
:
void
Sets the title of generated documentation.
Name | Type | Description |
---|---|---|
$title | string |


setTodo(
boolean $todo
)
:
void
Sets if documentation of tasks should be generated.
Name | Type | Description |
---|---|---|
$todo | boolean |


setTree(
boolean $tree
)
:
void
Sets if tree view of classes, interfaces, traits and exceptions should be generated.
Name | Type | Description |
---|---|---|
$tree | boolean |


setUpdateCheck(
boolean $updateCheck
)
:
void
Enables/disables the check for ApiGen updates.
Name | Type | Description |
---|---|---|
$updateCheck | boolean |