PHP Class PDepend\Report\Overview\Pyramid

http://www.springer.com/computer/programming/book/978-3-540-24429-5
Inheritance: implements PDepend\Report\FileAwareGenerator
Datei anzeigen Open project: pdepend/pdepend Class Usage Examples

Public Methods

Method Description
close ( ) : void Closes the logger process and writes the output file.
getAcceptedAnalyzers ( ) : array(string) Returns an array with accepted analyzer types. These types can be concrete analyzer classes or one of the descriptive analyzer interfaces.
log ( PDepend\Metrics\Analyzer $analyzer ) : boolean Adds an analyzer to log. If this logger accepts the given analyzer it with return true, otherwise the return value is false.
setLogFile ( string $logFile ) : void Sets the output log file.

Private Methods

Method Description
collectMetrics ( ) : array(string Aggregates the required metrics from the registered analyzers.
computeProportions ( array $metrics ) : array(string Computes the proportions between the given metrics.
computeThreshold ( string $name, mixed $value ) : string Computes the threshold (low, average, high) for the given value and metric.

Method Details

close() public method

Closes the logger process and writes the output file.
public close ( ) : void
return void

getAcceptedAnalyzers() public method

Returns an array with accepted analyzer types. These types can be concrete analyzer classes or one of the descriptive analyzer interfaces.
public getAcceptedAnalyzers ( ) : array(string)
return array(string)

log() public method

Adds an analyzer to log. If this logger accepts the given analyzer it with return true, otherwise the return value is false.
public log ( PDepend\Metrics\Analyzer $analyzer ) : boolean
$analyzer PDepend\Metrics\Analyzer The analyzer to log.
return boolean

setLogFile() public method

Sets the output log file.
public setLogFile ( string $logFile ) : void
$logFile string The output log file.
return void