tasks/ext/apigen/ApiGenTask.php

Show:

inherited

Classes
- \ApiGenTask

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
jump to top

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

string
                 $description= ''

inherited

Description of the task

Inherited from: \Task::$$description

Details

Type: string
Inherited_from: \Task::$$description

string
                 $executable= ''apigen''

Default ApiGen executable name.

Default value'apigen'Details

Type: string

\Location
                 $location= ''

inherited

Stored buildfile location

Inherited from: \Task::$$location

Details

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

array
                 $options= 'array(
        'progressbar' => false,
        'colors' => false,
        'update-check' => false
    )'

Default options for ApiGen.

Default value

array(
        'progressbar' => false,
        'colors' => false,
        'update-check' => false
    )

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 \Task::$$project

Default valuenullDetails

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

\Target
                 $target= ''

inherited

Owning Target object

Inherited from: \Task::$$target

Details

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

string
                 $taskName= ''

inherited

Taskname for logger

Inherited 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

\RuntimeConfigurable
                 $wrapper= ''

inherited

Wrapper of the task

Inherited from: \Task::$$wrapper

Details

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

Methods

constructArguments(
          
          )
        
        :
          string

Generates command line arguments for the ApiGen executable.

Returns

Type	Description
string

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()\Task::getProject()

Returns

Type	Description
\Project	Reference to current porject object

getRegisterSlot(
          string $slotName
          )
        
        :
          void

inherited

Returns a name

Inherited from: \Task::getRegisterSlot()

Parameters

Name	Type	Description
$slotName	string

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

Parameters

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

Details

See: \BuildEvent
See: \BuildListener

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

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

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

setAllowedHtml(
          string $allowedHtml
          )
        
        :
          void

Sets a list of HTML tags allowed in the documentation.

Parameters

Name	Type	Description
$allowedHtml	string

setAutocomplete(
          string $autocomplete
          )
        
        :
          void

Sets element types for search input autocomplete.

Parameters

Name	Type	Description
$autocomplete	string

setBaseUrl(
          string $baseUrl
          )
        
        :
          void

Sets the documentation base URL.

Parameters

Name	Type	Description
$baseUrl	string

setCharset(
          string $charset
          )
        
        :
          void

Sets the character set of source files.

Parameters

Name	Type	Description
$charset	string

setConfig(
          string $config
          )
        
        :
          void

Sets the config file name.

Parameters

Name	Type	Description
$config	string

setDebug(
          boolean $debug
          )
        
        :
          void

Enables/disables the debug mode.

Parameters

Name	Type	Description
$debug	boolean

setDeprecated(
          boolean $deprecated
          )
        
        :
          void

Sets if documentation for deprecated elements should be generated.

Parameters

Name	Type	Description
$deprecated	boolean

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

setDestination(
          string $destination
          )
        
        :
          void

Sets the destination directory.

Parameters

Name	Type	Description
$destination	string

setDownload(
          boolean $download
          )
        
        :
          void

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

Parameters

Name	Type	Description
$download	boolean

setExclude(
          string $exclude
          )
        
        :
          void

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

Parameters

Name	Type	Description
$exclude	string

setExecutable(
          string $executable
          )
        
        :
          void

Sets the ApiGen executable name.

Parameters

Name	Type	Description
$executable	string

setExtensions(
          string $extensions
          )
        
        :
          void

Sets list of allowed file extensions.

Parameters

Name	Type	Description
$extensions	string

setGoogleAnalytics(
          string $googleAnalytics
          )
        
        :
          void

Sets the Google Analytics tracking code.

Parameters

Name	Type	Description
$googleAnalytics	string

setGoogleCseId(
          string $googleCseId
          )
        
        :
          void

Sets the Google Custom Search ID.

Parameters

Name	Type	Description
$googleCseId	string

setGoogleCseLabel(
          string $googleCseLabel
          )
        
        :
          void

Sets the Google Custom Search label.

Parameters

Name	Type	Description
$googleCseLabel	string

setGroups(
          string $groups
          )
        
        :
          void

Sets how elements should be grouped in the menu.

Parameters

Name	Type	Description
$groups	string

setInternal(
          boolean $internal
          )
        
        :
          void

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

Parameters

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

setMain(
          string $main
          )
        
        :
          void

Sets the main project name prefix.

Parameters

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

setPhp(
          boolean $php
          )
        
        :
          void

Sets if documentation for PHP internal classes should be generated.

Parameters

Name	Type	Description
$php	boolean

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

setQuiet(
          boolean $quiet
          )
        
        :
          void

Enables/disables scaning and generating messages.

Parameters

Name	Type	Description
$quiet	boolean

setReport(
          string $report
          )
        
        :
          void

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

Parameters

Name	Type	Description
$report	string

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

setSkipDocPath(
          string $skipDocPath
          )
        
        :
          void

Sets masks to exclude elements from documentation generating.

Parameters

Name	Type	Description
$skipDocPath	string

setSkipDocPrefix(
          string $skipDocPrefix
          )
        
        :
          void

Sets a name prefix to exclude elements from documentation generating.

Parameters

Name	Type	Description
$skipDocPrefix	string

setSource(
          string $source
          )
        
        :
          void

Sets source files or directories.

Parameters

Name	Type	Description
$source	string

setSourceCode(
          boolean $sourceCode
          )
        
        :
          void

Sets if highlighted source code files should be generated.

Parameters

Name	Type	Description
$sourceCode	boolean

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

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)

setTemplateConfig(
          string $templateConfig
          )
        
        :
          void

Sets the template config file name.

Parameters

Name	Type	Description
$templateConfig	string

setTitle(
          string $title
          )
        
        :
          void

Sets the title of generated documentation.

Parameters

Name	Type	Description
$title	string

setTodo(
          boolean $todo
          )
        
        :
          void

Sets if documentation of tasks should be generated.

Parameters

Name	Type	Description
$todo	boolean

setTree(
          boolean $tree
          )
        
        :
          void

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

Parameters

Name	Type	Description
$tree	boolean

setUpdateCheck(
          boolean $updateCheck
          )
        
        :
          void

Enables/disables the check for ApiGen updates.

Parameters

Name	Type	Description
$updateCheck	boolean

setWipeout(
          boolean $wipeout
          )
        
        :
          void

Sets if the destination directory should be wiped out first.

Parameters

Name	Type	Description
$wipeout	boolean

tasks/ext/apigen/ApiGenTask.php

\ApiGenTaskjump to top

Properties

Methods

\ApiGenTask
jump to top