phing-tasks-ext-phpdoc
[ class tree: phing-tasks-ext-phpdoc ] [ index: phing-tasks-ext-phpdoc ] [ all elements ]

Class: PhpDocumentorExternalTask

Source Location: /tasks/ext/phpdoc/PhpDocumentorExternalTask.php

Class Overview

ProjectComponent
   |
   --Task
      |
      --PhpDocumentorTask
         |
         --PhpDocumentorExternalTask

Task to run phpDocumentor with an external process


Author(s):

Version:

  • $Id: PhpDocumentorExternalTask.php 552 2009-08-29 12:18:13Z mrook $

Copyright:

  • � 2001,2002 THYRELL. All rights reserved

Variables

Methods


Inherited Variables

Inherited Methods

Class: PhpDocumentorTask

PhpDocumentorTask::createFileset()
Creates a FileSet.
PhpDocumentorTask::createProjdocfileset()
Creates a readme/install/changelog fileset.
PhpDocumentorTask::findPhpDocumentorInstall()
Searches include_path for PhpDocumentor install and adjusts include_path appropriately.
PhpDocumentorTask::init()
Load the necessary environment for running PhpDoc.
PhpDocumentorTask::main()
Main entrypoint of the task
PhpDocumentorTask::setConfigdir()
Set a directory to search for configuration files in.
PhpDocumentorTask::setCustomtags()
custom tags, will be recognized and put in tags[] instead of unknowntags[].
PhpDocumentorTask::setDefaultcategoryname()
Sets the default category name.
PhpDocumentorTask::setDefaultpackagename()
Sets the default package name.
PhpDocumentorTask::setDestdir()
Set the destination directory for the generated documentation
PhpDocumentorTask::setExamplesdir()
Set a directory to search for examples in.
PhpDocumentorTask::setIgnoretags()
Set (comma-separated) list of tags to ignore.
PhpDocumentorTask::setJavadocdesc()
Whether to use javadoc descriptions (more primitive).
PhpDocumentorTask::setLinksource()
Set whether to generate sourcecode for each file parsed
PhpDocumentorTask::setOutput()
Set the output format (e.g. HTML:Smarty:PHP).
PhpDocumentorTask::setPackageoutput()
Set (comma-separated) list of packages to output.
PhpDocumentorTask::setParseprivate()
Should private members/classes be documented
PhpDocumentorTask::setPear()
Set whether to parse as PEAR repository.
PhpDocumentorTask::setPhpDocumentorOptions()
Sets the options on the passed-in phpdoc setup object.
PhpDocumentorTask::setQuiet()
Set whether to suppress output.
PhpDocumentorTask::setSourcecode()
Set whether to generate sourcecode for each file parsed
PhpDocumentorTask::setTarget()
Alias for setDestdir()).
PhpDocumentorTask::setTemplateBase()
Set base location of all templates for this parse.
PhpDocumentorTask::setTitle()
Set the title for the generated documentation
PhpDocumentorTask::setUndocumentedelements()
Control whether or not warnings will be shown for undocumented elements.
PhpDocumentorTask::validate()
Validates that necessary minimum options have been set.

Class: Task

Task::getDescription()
Returns the textual description of the task
Task::getLocation()
Returns the location within the buildfile this task occurs. Used by BuildException to give detailed error messages.
Task::getOwningTarget()
Returns the owning target of this task.
Task::getRegisterSlot()
Returns a name
Task::getRuntimeConfigurableWrapper()
Returns the wrapper object for runtime configuration
Task::getTaskName()
Returns the name of task, used only for log messages
Task::getTaskType()
Returns the name of the task under which it was invoked, usually the XML tagname
Task::init()
Called by the parser to let the task initialize properly.
Task::log()
Provides a project level log event to the task.
Task::main()
Called by the project to let the task do it's work. This method may be called more than once, if the task is invoked more than once. For example, if target1 and target2 both depend on target3, then running <em>phing target1 target2</em> will run all tasks in target3 twice.
Task::maybeConfigure()
Configure this task if it hasn't been done already.
Task::perform()
Perfrom this task
Task::setDescription()
Sets a textual description of the task
Task::setLocation()
Sets the location within the buildfile this task occurs. Called by the parser to set location information.
Task::setOwningTarget()
Sets the owning target this task belongs to.
Task::setRuntimeConfigurableWrapper()
Sets the wrapper object this task should use for runtime configurable elements.
Task::setTaskName()
Sets the name of this task for log messages
Task::setTaskType()
Sets the type of the task. Usually this is the name of the XML tag

Class: ProjectComponent

ProjectComponent::getProject()
Returns a reference to current project
ProjectComponent::log()
Logs a message with the given priority.
ProjectComponent::setProject()
References the project to the current component.

Class Details

[line 37]
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.




Tags:

author:  Markus Fischer <markus@fischer.name>
author:  Michiel Rook <michiel.rook@gmail.com>
version:  $Id: PhpDocumentorExternalTask.php 552 2009-08-29 12:18:13Z mrook $
copyright:  � 2001,2002 THYRELL. All rights reserved


[ Top ]


Class Variables

$ignoresymlinks =  false

[line 49]



Tags:

var:  ignore symlinks to other files or directories
access:  protected

Type:   bool


[ Top ]

$programPath =  'phpdoc'

[line 42]

The path to the executable for phpDocumentor



Tags:

access:  protected

Type:   mixed


[ Top ]

$sourcepath =  NULL

[line 44]



Tags:

access:  protected

Type:   mixed


[ Top ]



Class Methods


method constructArguments [line 117]

array constructArguments( )

Constructs an argument string for phpDocumentor



Tags:

access:  protected


[ Top ]

method getProgramPath [line 62]

void getProgramPath( )

Returns the path to the phpDocumentor executable



Tags:

access:  public


[ Top ]

method init [line 232]

void init( )

Override PhpDocumentorTask::init() because they're specific to the phpdoc API which we don't use.



Tags:

access:  public


Overrides PhpDocumentorTask::init() (Load the necessary environment for running PhpDoc.)

[ Top ]

method main [line 87]

void main( )

Main entrypoint of the task



Tags:

access:  public


Overrides PhpDocumentorTask::main() (Main entrypoint of the task)

[ Top ]

method setIgnoresymlinks [line 80]

void setIgnoresymlinks( bool $bSet)

Ignore symlinks to other files or directories.



Tags:

access:  public


Parameters:

bool   $bSet  

[ Top ]

method setProgramPath [line 54]

void setProgramPath( $programPath)

Sets the path to the phpDocumentor executable



Tags:

access:  public


Parameters:

   $programPath  

[ Top ]

method setSourcepath [line 70]

void setSourcepath( $sourcepath)

Set the source path. A directory or a comma separate list of directories.



Tags:

access:  public


Parameters:

   $sourcepath  

[ Top ]

method validate [line 239]

void validate( )

Validates that necessary minimum options have been set. Based on PhpDocumentorTask::validate().



Tags:

access:  protected


Overrides PhpDocumentorTask::validate() (Validates that necessary minimum options have been set.)

[ Top ]


Documentation generated on Mon, 19 Oct 2009 10:51:39 +0200 by phpDocumentor 1.4.3