Arbit - project tracking, tracked with Arbit

API documentation :: Docs For Class arbitModulePdependController

LICENSE

INSTALL

Packages:

Classes:

View
- arbitModulePdependXHtmlHandler
- arbitPdependClassViewModel
- arbitPdependOverviewViewModel

IniBackend
- arbitPdependBackendIniModuleConfiguration

Pdepend::arbitModulePdependController

Class arbitModulePdependController

Base php_doc controller.

ezcMvcController
   |
   --arbitController
      |
      --arbitModulePdependController

Author(s):

Version:	$Revision: 1692 $
License:	GPL

Member Variables

protected array


              $classMetrics
               = array(
        'cis'    => 'Class interface size',
        'cloc'   => 'Comment lines of code',
        'cr'     => 'Code rank',
        'csz'    => 'Class size',
        'dit'    => 'Depth of inheritence tree',
        'eloc'   => 'Executable lines of code',
        'impl'   => 'Number of implemented interfaces',
        'loc'    => 'Lines of code',
        'ncloc'  => 'Non-comment lines of code',
        'nom'    => 'Number of methods',
        'rcr'    => 'Reverse code rank',
        'vars'   => 'Number of defined class properties',
        'varsi'  => 'Number of own and inherited class properties',
        'varsnp' => 'Number of public class properties',
        'wmc'    => 'Weighted Method per Class (Sum of method Cyclomatic Complexity)',
        'wmci'   => 'Weighted Method per Class + inherited WMC',
        'wmcnp'  => 'Weighted Method per Class for all public class methods',
    )

List of class metrics provided by pdepend

protected array


              $methodMetrics
               = array(
        'ccn'   => 'Cyclomatic Complexity',
        'ccn2'  => 'Extended Cyclomatic Complexity',
        'cloc'  => 'Comment Lines Of Code',
        'eloc'  => 'Executable Lines Of Code',
        'loc'   => 'Lines Of Code',
        'ncloc' => 'Non Comment Lines Of Code',
        'npath' => 'NPath Complexity',
    )

List of class metrics provided by pdepend

Method Summary

public static void	`sourceUpdated( $signal , $struct )` Handle source update signal
public arbitViewModuleModel	`analyze( $request )` Generate action
protected void	`emitAnnotations( $base , $request )` Emit annotations from pdepend results Convert the PDepend result log XML file into annotations for the source browser.
protected void	`emitCiSignals( $model , $request )` Emit continious integration update
protected array	`getClassMetrics( $element )` Get class metrics Return an array with the class metric values from a DOMElement from the summary XML file.
protected string	`getLogPath( $request )` Get path to generated log
protected array	`getMenu( )` Return the menu for the source controller
protected array	`getMethodMetrics( $element )` Get method metrics Return an array with the method metric values from a DOMElement from the summary XML file.
public arbitViewModuleModel	`graph( $request )` Graph action
public arbitViewModuleModel	`index( $request )` Index action The index action just dispatches to the default view of the source module - the custom source configuration.
public arbitViewModuleModel	`overview( $request )` Overview action
public arbitViewModuleModel	`viewClass( $request )` Class 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

analyze

arbitViewModuleModel analyze( $request )

Generate action

Generate action (Re-)Generate the API documentation

Parameters:

Name	Type	Description
`$request`	arbitRequest

emitAnnotations

void emitAnnotations( $base , $request )

Emit annotations from pdepend results Convert the PDepend result log XML file into annotations for the source browser.

Parameters:

Name	Type	Description
`$request`	arbitRequest
`$base`

emitCiSignals

void emitCiSignals( $model , $request )

Emit continious integration update

Parameters:

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

getClassMetrics

array getClassMetrics( $element )

Get class metrics Return an array with the class metric values from a DOMElement from the summary XML file.

Parameters:

Name	Type	Description
`$element`	DOMElement

getLogPath

string getLogPath( $request )

Get path to generated log

Parameters:

Name	Type	Description
`$request`	arbitRequest

getMenu

array getMenu( )

Return the menu for the source controller

getMethodMetrics

array getMethodMetrics( $element )

Get method metrics Return an array with the method metric values from a DOMElement from the summary XML file.

Parameters:

Name	Type	Description
`$element`	DOMElement

graph

arbitViewModuleModel graph( $request )

Graph action

Graph action Displays a graph generated by PDepend

Parameters:

Name	Type	Description
`$request`	arbitRequest

index

arbitViewModuleModel index( $request )

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

Parameters:

Name	Type	Description
`$request`	arbitRequest

overview

arbitViewModuleModel overview( $request )

Overview action

Overview action Displays a metric / risk overview

Parameters:

Name	Type	Description
`$request`	arbitRequest

viewClass

arbitViewModuleModel viewClass( $request )

Class action

Class action Displays a metric overview for the selected class

Parameters:

Name	Type	Description
`$request`	arbitRequest

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