• Home
• PDepend
• Engine

PHP Class PDepend\Engine

The PDepend is a php port/adaption of the Java class file analyzer JDepend. Show file Open project: pdepend/pdepend Class Usage Examples

Protected Properties

Property	Type	Description
$configuration	PDepend\Util\Configuration	The system configuration.

Public Methods

Method	Description
__construct ( PDepend\Util\Configuration $configuration, PDepend\Util\Cache\CacheFactory $cacheFactory, PDepend\Metrics\AnalyzerFactory $analyzerFactory )	Constructs a new php depend facade.
addDirectory ( string $directory ) : void	Adds the specified directory to the list of directories to be analyzed.
addFile ( string $file ) : void	Adds a single source code file to the list of files to be analysed.
addFileFilter ( PDepend\Input\Filter $filter ) : void	Adds a new input/file filter.
addProcessListener ( pdepend\ProcessListener $listener ) : void	Adds a process listener.
addReportGenerator ( PDepend\Report\ReportGenerator $generator ) : void	Adds a logger to the output list.
analyze ( ) : PDepend\Source\AST\ASTNamespace[]	Analyzes the registered directories and returns the collection of analyzed namespace.
countClasses ( ) : integer	Returns the number of analyzed php classes and interfaces.
countNamespaces ( ) : integer	Returns the number of analyzed namespaces.
getExceptions ( ) : PDepend\Source\Parser\ParserException[]	Returns an array with all {@link \PDepend\Source\Parser\ParserException} that were caught during the parsing process.
getNamespace ( string $name ) : PDepend\Source\AST\ASTNamespace	Returns the analyzed namespace for the given name.
getNamespaces ( ) : PDepend\Source\AST\ASTNamespace[]	Returns an array with the analyzed namespace.
setCodeFilter ( PDepend\Source\AST\ASTArtifactList\ArtifactFilter $filter ) : void	Sets an additional code filter. These filters could be used to hide external libraries and global stuff from the PDepend output.
setOptions ( array $options = [] ) : void	Sets analyzer options.
setWithoutAnnotations ( ) : void	Should the parse ignore doc comment annotations?

Protected Methods

Method	Description
fireEndAnalyzeProcess ( ) : void	Sends the end analyzing process event.
fireEndFileParsing ( PDepend\Source\Tokenizer\Tokenizer $tokenizer ) : void	Sends the end file parsing event.
fireEndLogProcess ( ) : void	Sends the end log process event.
fireEndParseProcess ( PDepend\Source\Builder\Builder $builder ) : void	Send the end parsing process event.
fireStartAnalyzeProcess ( ) : void	Sends the start analyzing process event.
fireStartFileParsing ( PDepend\Source\Tokenizer\Tokenizer $tokenizer ) : void	Sends the start file parsing event.
fireStartLogProcess ( ) : void	Sends the start log process event.
fireStartParseProcess ( PDepend\Source\Builder\Builder $builder ) : void	Send the start parsing process event.

Private Methods

Method	Description
createAnalyzers ( $options )
createFileIterator ( ) : Iterator	This method will create an iterator instance which contains all files that are part of the parsing process.
performAnalyzeProcess ( ) : void	This method performs the analysing process of the parsed source files. It creates the required analyzers for the registered listeners and then applies them to the source tree.
performParseProcess ( ) : void	This method performs the parsing process of all source files. It expects that the $_builder property was initialized with a concrete builder implementation.

Method Details

Property Details