PHP Interface PDepend\Metrics\Analyzer

Show file Open project: horde/horde

Public Methods

Method Description
__construct ( array $options = [] ) Constructs a new analyzer instance.
addAnalyzeListener ( PDepend\Metrics\AnalyzerListener $listener ) : void Adds a listener to this analyzer.
analyze ( PDepend\Source\AST\ASTNamespace[] $namespaces ) : void Processes all {@link \PDepend\Source\AST\ASTNamespace} code nodes.
isEnabled ( ) : boolean An analyzer that is active must return true to recognized by pdepend framework, while an analyzer that does not perform any action for any reason should return false.
setOptions ( array $options = [] ) Set global options

Method Details

__construct() public method

Constructs a new analyzer instance.
public __construct ( array $options = [] )
$options array

addAnalyzeListener() public method

Adds a listener to this analyzer.
public addAnalyzeListener ( PDepend\Metrics\AnalyzerListener $listener ) : void
$listener PDepend\Metrics\AnalyzerListener The listener instance.
return void

analyze() public method

Processes all {@link \PDepend\Source\AST\ASTNamespace} code nodes.
public analyze ( PDepend\Source\AST\ASTNamespace[] $namespaces ) : void
$namespaces PDepend\Source\AST\ASTNamespace[]
return void

isEnabled() public method

An analyzer that is active must return true to recognized by pdepend framework, while an analyzer that does not perform any action for any reason should return false.
Since: 0.9.10
public isEnabled ( ) : boolean
return boolean

setOptions() public method

Set global options
Since: 2.0.1
public setOptions ( array $options = [] )
$options array