PhpMetrics

https://www.phpmetrics.org
Admin
PhpMetrics is a static analysis tool for PHP that provides comprehensive metrics about code quality,...
Tokens:10,747
Snippets:226
Trust Score:9
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install PhpMetrics and Generate HTML Report

Source: https://www.phpmetrics.org/.html

Installs PhpMetrics globally using Composer and then generates an HTML report for a specified project path.

```bash
composer global require 'phpmetrics/phpmetrics'
phpmetrics --report-html=myreport.html /path/of/your/sources
```

--------------------------------

### Develop Custom Plugin - Main Class

Source: https://www.phpmetrics.org/documentation/plugins.html

Create a main plugin class that implements `Hal\Application\Extension\Extension`. Ensure the file returns a new instance of your class. This example shows the basic structure and required methods.

```php
<?php 
namespace My; 
use Hal\Application\Config\Configuration; 
use Hal\Application\Extension\Extension; 
use Hal\Application\Extension\Reporter; 
use Hal\Application\Extension\ReporterHtmlSummary; 
use Hal\Component\Bounds\Bounds; 
use Hal\Component\Result\ResultCollection; 
require_once __DIR__.'/HtmlRenderer.php'; 
class MyExtension implements Extension { 
    /** 
     * @inheritdoc 
     */ 
    public function receive(Configuration $configuration, ResultCollection $collection, ResultCollection $aggregatedResults, Bounds $bounds) 
    { 
        // nothing to do here 
    } 
    /** 
     * @inheritdoc 
     */ 
    public function getName() 
    { 
        return 'my nice extension'; 
    } 
    /** 
     * @inheritdoc 
     */ 
    public function getReporterHtmlSummary() 
    { 
        return new HtmlRenderer; 
    } 
    /** 
     * @inheritdoc 
     */ 
    public function getReporterCliSummary() 
    { 
        // if you don't need to add anything in CLI report, just return 'null' 
        return null; 
    } 
}
return new MyExtension;
```

--------------------------------

### PHP Class Example for LCOM Calculation

Source: https://www.phpmetrics.org/documentation/how-to-understand-metrics.html

This PHP code demonstrates a class structure used to illustrate the calculation of Lack of Cohesion of Methods (LCOM). It shows methods that share attributes, leading to multiple responsibilities within the class.

```php
<?php
class Example {
    private $a;
    private $b;
    public function f1() {
        $this->a = 1;
    }
    public function f2() {
        $this->f3();
    }
    public function f3() {
        $this->a = 2;
    }
    public function f4() {
        $this->b = 3;
    }
    public function f5() {
        $this->b = 4;
    }
}
```

--------------------------------

### Enable Plugins with CLI Option

Source: https://www.phpmetrics.org/documentation/plugins.html

Use the `--plugins` option followed by a comma-separated list of plugin files to enable them. Replace `<sources>` with your project's source files.

```bash
phpmetrics --plugins=plugin1.php,plugin2.php <sources>
```

--------------------------------

### Generate HTML Report

Source: https://www.phpmetrics.org/documentation/how-to-read-report.html

Run this command to generate the HTML report. The output file path can be customized.

```bash
vendor/bin/phpmetrics --report-html=/tmp/report.html
```

--------------------------------

### Develop Custom Plugin - HTML Renderer

Source: https://www.phpmetrics.org/documentation/plugins.html

Implement the `ReporterHtmlSummary` interface to define how your plugin's content is rendered in the HTML report. This includes adding menu items, JavaScript for interactivity, and the HTML structure.

```php
<?php
namespace My;
use Hal\Application\Extension\Reporter\ReporterHtmlSummary;
class HtmlRenderer implements ReporterHtmlSummary {
    /**
     * @inheritdoc
     */
    public function getMenus()
    {
        // you can add one or more items to the menu
        return [
            'myplugin' => 'Label displayed in the menu'
        ];
    }
    /**
     * @inheritdoc
     */
    public function renderJs()
    {
        // add your Js code here
        return "document.getElementById('link-myplugin').onclick = function() { displayTab(this, 'myplugin')};";
    }
    /**
     * @inheritdoc
     */
    public function renderHtml()
    {
        return <<<EOT
<div class="tab" id="myplugin">
    <div class="row">
        <h3>My nice plugin</h3>
        <p>
            Just change the content here.
        </p>
    </div>
EOT;
    }
}
```

--------------------------------

### Run PhpMetrics in Jenkins Shell Script

Source: https://www.phpmetrics.org/documentation/jenkins.html

Execute PhpMetrics from a Jenkins 'Run Shell Script' build step. Ensure the output paths for reports are correctly specified.

```bash
#!/bin/bash

=build/phpmetrics.html --report-xml=build/phpmetrics.xml --violations-xml=build/violations.xml
```
Tokens:
Raw