tasks/ext/docblox/DocBloxTask.php

Show:

inherited

Classes
- \DocBloxTask

Table of Contents

DocBlox Task (http://www.docblox-project.org)

Author: Michiel Rook
Package: phing.tasks.ext.docblox
Since: 2.4.6
Version: $Id: eaa494390770adc752097a412d63fb863482fd5d $

\DocBloxTask
jump to top

Package: phing\tasks\ext\docblox

DocBlox Task (http://www.docblox-project.org)

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

Parent(s): \Task < \ProjectComponent
Author: Michiel Rook
Copyright: 2001,2002 THYRELL. All rights reserved
Since: 2.4.6
Version: $Id: eaa494390770adc752097a412d63fb863482fd5d $

Properties

string
                 $description= ''

inherited

Description of the task

Inherited from: \Task::$$description

Details

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

\PhingFile
                 $destDir= 'null'

Destination/target directory

Default valuenullDetails

Type: \PhingFile

\FileSet[]
                 $filesets= 'array()'

List of filesets

Default valuearray()Details

Type: \FileSet[]

\Location
                 $location= ''

inherited

Stored buildfile location

Inherited from: \Task::$$location

Details

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

\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

boolean
                 $quiet= 'true'

Force DocBlox to be quiet

Default valuetrueDetails

Type: boolean

\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

string
                 $template= '"new_black"'

name of the template to use

Default value"new_black"Details

Type: string

string
                 $title= '""'

Title of the project

Default value""Details

Type: string

\RuntimeConfigurable
                 $wrapper= ''

inherited

Wrapper of the task

Inherited from: \Task::$$wrapper

Details

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

Methods

createFileSet(
          
          )
        
        :
          \FileSet

Nested creator, adds a set of files (nested fileset attribute).

Returns

Type	Description
\FileSet

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

initializeDocBlox(
          
          )
        
        :
          void

Finds and initializes the DocBlox installation

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

Task entry point

Should throw a BuildException if someting goes wrong with the build

This is abstract here. Must be overloaded by real tasks.

Details

See: \Task::main()

maybeConfigure(
          
          )
        
        :
          void

inherited

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

Inherited from: \Task::maybeConfigure()

parseFiles(
          
          )
        
        :
          string

Build a list of files (from the fileset elements) and call the DocBlox parser

Returns

Type	Description
string

perform(
          
          )
        
        :
          void

inherited

Perfrom this task

Inherited from: \Task::perform()

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(
          \PhingFile $destDir
          )
        
        :
          void

Sets destination/target directory

Parameters

Name	Type	Description
$destDir	\PhingFile

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(
          \PhingFile $output
          )
        
        :
          void

Convenience setter (@see setDestDir)

Parameters

Name	Type	Description
$output	\PhingFile

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

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

Forces DocBlox to be quiet

Parameters

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

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)

setTemplate(
          \strings $template
          )
        
        :
          void

Sets the template to use

Parameters

Name	Type	Description
$template	\strings

setTitle(
          \strings $title
          )
        
        :
          void

Sets the title of the project

Parameters

Name	Type	Description
$title	\strings

tasks/ext/docblox/DocBloxTask.php

\DocBloxTaskjump to top

Properties

Methods

\DocBloxTask
jump to top