DirectoryRecursiveAggregator::aggregates() - Code Metrics - Halleck45/PhpMetrics - Measure and Improve Code Quality continuously with Scrutinizer

DirectoryRecursiveAggregator::aggregates() C
last analyzed 2015-12-15 11:18 UTC

↳ Parent: DirectoryRecursiveAggregator

Complexity

Conditions	8
Paths	19

Size

Total Lines	40
Code Lines	22

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	40
rs	5.3846
cc	8
eloc	22
nc	19
nop	1

<?php

/*
 * (c) Jean-François Lépine <https://twitter.com/Halleck45>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Hal\Component\Aggregator;
use Hal\Component\Result\ResultCollection;

/**
 * Agregates by directory
 *
 * @author Jean-François Lépine <https://twitter.com/Halleck45>
 */
class DirectoryRecursiveAggregator implements Aggregator {

    /**
     * Max depth
     *
     * @var int
     */
    private $depth;

    /**
     * Constructor
     *
     * @param $depth
     */
    public function __construct($depth)
    {
        $this->depth = $depth;
    }


    /**
     * @inheritdoc
     * @throws \RuntimeException
     */
    public function aggregates(ResultCollection $results) {
        $array = new ResultCollection();
        foreach($results as $result) {
            $basename = dirname($result->getFilename());

            // from 'folder1/folder2/file.php', we want an array with ('folder1', 'folder2')
            $namespaces = explode(DIRECTORY_SEPARATOR, $basename);

            if($this->depth) {
                array_splice($namespaces, $this->depth);
            }

            // merge infos for each namespace in the DirectoryResultCollection
            $len = sizeof($namespaces, COUNT_NORMAL);

            for($i = 0; $i < $len; $i++) {

                $namespace = $namespaces[$i];
                if(0 === strlen($namespace)) {
                    $namespace = '.';
                }

                if(0 === $i) {
                    // root
                    if(!isset($array[$namespace])) {
                        $array[$namespace] = new ResultCollection();
                    }
                    $parent = &$array[$namespace];
                } else {
                    // namespace
                    if(!isset($parent[$namespace])) {
                        $parent[$namespace] = new ResultCollection(); // ResultRecursiveCollection -> has getOOP(), etc.
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
                    }
                    $parent = &$parent[$namespace];
                }
            }
            $parent->push($result);
        }
        return $array;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }
}

1			<?php
2
3			/*
4			* (c) Jean-François Lépine <https://twitter.com/Halleck45>
5			*
6			* For the full copyright and license information, please view the LICENSE
7			* file that was distributed with this source code.
8			*/
9
10			namespace Hal\Component\Aggregator;
11			use Hal\Component\Result\ResultCollection;
12
13			/**
14			* Agregates by directory
15			*
16			* @author Jean-François Lépine <https://twitter.com/Halleck45>
17			*/
18			class DirectoryRecursiveAggregator implements Aggregator {
19
20			/**
21			* Max depth
22			*
23			* @var int
24			*/
25			private $depth;
26
27			/**
28			* Constructor
29			*
30			* @param $depth
31			*/
32			public function __construct($depth)
33			{
34			$this->depth = $depth;
35			}
36
37
38			/**
39			* @inheritdoc
40			* @throws \RuntimeException
41			*/
42			public function aggregates(ResultCollection $results) {
43			$array = new ResultCollection();
44			foreach($results as $result) {
45			$basename = dirname($result->getFilename());
46
47			// from 'folder1/folder2/file.php', we want an array with ('folder1', 'folder2')
48			$namespaces = explode(DIRECTORY_SEPARATOR, $basename);
49
50			if($this->depth) {
51			array_splice($namespaces, $this->depth);
52			}
53
54			// merge infos for each namespace in the DirectoryResultCollection
55			$len = sizeof($namespaces, COUNT_NORMAL);
56
57			for($i = 0; $i < $len; $i++) {
58
59			$namespace = $namespaces[$i];
60			if(0 === strlen($namespace)) {
61			$namespace = '.';
62			}
63
64			if(0 === $i) {
65			// root
66			if(!isset($array[$namespace])) {
67			$array[$namespace] = new ResultCollection();
68			}
69			$parent = &$array[$namespace];
70			} else {
71			// namespace
72			if(!isset($parent[$namespace])) {
73			$parent[$namespace] = new ResultCollection(); // ResultRecursiveCollection -> has getOOP(), etc.
			0 ignored issues – show Bug introduced 2015-11-25 11:13 UTC by Report Bug Copy Issue Report The variable `$parent` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
74			}
75			$parent = &$parent[$namespace];
76			}
77			}
78			$parent->push($result);
79			}
80			return $array;
			0 ignored issues – show Bug Best Practice introduced 2015-11-25 11:13 UTC by Report Bug Copy Issue Report The return type of `return $array;` (`Hal\Component\Result\ResultCollection`) is incompatible with the return type declared by the interface `Hal\Component\Aggregator\Aggregator::aggregates` of type `Hal\Component\Result\ResultCollection[]`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
81			}
82			}

Halleck45 / PhpMetrics

DirectoryRecursiveAggregator::aggregates() C last analyzed 2015-12-15 11:18 UTC

Complexity

Size

Duplication

Available Fixes

Duplication Side-by-Side

Filter issues like

DirectoryRecursiveAggregator::aggregates() C
last analyzed 2015-12-15 11:18 UTC