Arbit - project tracking, tracked with Arbit

API documentation :: Docs For Class arbitModulePhpDocController

LICENSE

INSTALL

Packages:

Classes:

View
- arbitModulePhpDocXHtmlHandler
- arbitPhpDocHtmlViewModel
- arbitPhpDocLogViewModel

Converter
- HTMLArbitConverter

PhpDoc::arbitModulePhpDocController

Class arbitModulePhpDocController

Base php_doc controller.

ezcMvcController
   |
   --arbitController
      |
      --arbitModulePhpDocController

Author(s):

Version:	$Revision: 1692 $
License:	GPL

Method Summary

public static void	`sourceUpdated( $signal , $struct )` Handle source update signal
protected void	`emitCiSignals( $model , $request )` Emit continious integration update
public arbitViewModuleModel	`generate( $request )` Generate action
protected string	`getDocPath( $request )` Get path to generated documentation
protected array	`getMenu( )` Return the menu for the php_doc controller
public arbitViewModuleModel	`index( $request )` Index action The index action just dispatches to the default view of the php_doc module - the custom php_doc configuration.
public arbitViewModuleModel	`log( $request )` Log action
protected array	`parsePhpDocLog( $log , $basepath )` Parse log from PHP documentor Parse the log and return an array of errors and warnings associated with the respective file and line where the problem occured.
protected void	`reportErrors( $request , $errors )` Report errors back to source module
public arbitViewModuleModel	`view( $request )` Overview action

Inherited Methods

From arbitController
public static string	`arbitController::createActionMethodName()` Creates a method name to call from an action name.
public ezcMvcResult\|ezcMvcInternalRedirect	`arbitController::createResult()` Runs the controller to process the query and return variables usable to render the view.
protected void	`arbitController::setRequestVariables()` Don't copy shit here.
public void	`arbitController::__call()` Wrapper for unknown actions Wrapper for unknown actions, which throws an exception instead of causing PHP to report a fatal error.

Methods

sourceUpdated

static void sourceUpdated( string $signal , $struct )

Handle source update signal

Parameters:

Name	Type	Description
`$signal`	string
`$struct`	arbitSignalSlotStruct

emitCiSignals

void emitCiSignals( $model , $request )

Emit continious integration update

Parameters:

Name	Type	Description
`$model`	arbitSourceCheckoutViewModel
`$request`	arbitRequest

generate

arbitViewModuleModel generate( $request )

Generate action

Generate action (Re-)Generate the API documentation

Parameters:

Name	Type	Description
`$request`	arbitRequest

getDocPath

string getDocPath( $request )

Get path to generated documentation

Parameters:

Name	Type	Description
`$request`	arbitRequest

getMenu

array getMenu( )

Return the menu for the php_doc controller

index

arbitViewModuleModel index( $request )

Index action The index action just dispatches to the default view of the php_doc module - the custom php_doc configuration.

Parameters:

Name	Type	Description
`$request`	arbitRequest

log

arbitViewModuleModel log( $request )

Log action

Log action Display the documentation rendering log

Parameters:

Name	Type	Description
`$request`	arbitRequest

parsePhpDocLog

array parsePhpDocLog( string $log , $basepath )

Parse log from PHP documentor Parse the log and return an array of errors and warnings associated with the respective file and line where the problem occured.

Parameters:

Name	Type	Description
`$log`	string
`$basepath`

reportErrors

void reportErrors( $request , $errors )

Report errors back to source module

Parameters:

Name	Type	Description
`$request`	arbitRequest
`$errors`	array

view

arbitViewModuleModel view( $request )

Overview action

Overview action Show user an overview of all PhpDoc questions

Parameters:

Name	Type	Description
`$request`	arbitRequest

Documentation generated on Mon, 05 Apr 2010 14:01:44 +0200 by phpDocumentor 1.4.3