mamuz/php-dependency-analysis

Static code analysis to find violations in a dependency graph

PhpDependencyAnalysis

, _(*1)

PhpDependencyAnalysis is an extendable static code analysis for object-oriented PHP-Projects to generate dependency graphs from abstract datatypes (Classes, Interfaces and Traits) based on namespaces. Dependencies can be aggregated to build graphs for several levels, like Package-Level or Layer-Level. Each dependency can be verified to a defined architecture., _(*2)

Read the Introduction-Chapter for further informations., _(*3)

Example

, _(*4)

See more examples., _(*5)

Installation

As a Docker Image (recommend way)

docker pull mamuz/phpda

As a Composer Dependency

NOTE: For graph creation GraphViz is required on your machine, which is an open source graph visualization software and available for the most platforms., _(*6)

$ composer require --dev mamuz/php-dependency-analysis

As a Phar

Since version 2.0.0 not supported anymore., _(*7)

Features

• High customizing level
• Graph creation on customized levels respectively different scopes and layers
• Supports Usage-Graph, Call-Graph and Inheritance-Graph
• Dependencies can be aggregated such as to a package, a module or a layer
• Detecting cycles and violations between layers in a tiered architecture
• Verifiying dependency graph against a user-defined reference architecture
• Collected namespaces of dependencies are modifiable to meet custom use cases
• Printing graphs in several formats (HTML, SVG, DOT, JSON)
• Extandable by adding user-defined plugins for collecting and displaying
• Compatible to PHP7 Features, like Return Type Declarations and Anonymous Classes

Usage

Phpda can run out of the box by using a prepared configuration. As you can see configuration is defined by a YAML file., _(*8)

To provide your own configuration create a yml file, e.g. located in ./phpda.yml:, _(*9)

mode: 'usage'
source: './src'
filePattern: '*.php'
ignore: 'tests'
formatter: 'PhpDA\Writer\Strategy\Svg'
target: './phpda.svg'
groupLength: 1
visitor:
  - PhpDA\Parser\Visitor\TagCollector
  - PhpDA\Parser\Visitor\SuperglobalCollector
visitorOptions:
  PhpDA\Parser\Visitor\Required\DeclaredNamespaceCollector: {minDepth: 2, sliceLength: 2}
  PhpDA\Parser\Visitor\Required\MetaNamespaceCollector: {minDepth: 2, sliceLength: 2}
  PhpDA\Parser\Visitor\Required\UsedNamespaceCollector: {minDepth: 2, sliceLength: 2}
  PhpDA\Parser\Visitor\TagCollector: {minDepth: 2, sliceLength: 2}

Perform an analysis with that configuration:, _(*10)

$ docker run --rm -v $PWD:/app mamuz/phpda

Read the Configuration-Chapter to get knowledge about all available options., _(*11)

Wiki

1. Introduction
2. Requirements
3. Configuration
4. Examples
5. Plugins

Code of Conduct

As contributors and maintainers of this project you have to respect the Code of Coduct, _(*12)

Changelog

See record of changes made to this project here, _(*13)

Contributing

Before opening up a pull-request please read the Contributing-Guideline, _(*14)

Alternatives

Check the resources in Satic Analysis Section at Awesome PHP, _(*15)