ComposerJson::read() - Code Metrics - naneau/php-project-versioner - Measure and Improve Code Quality continuously with Scrutinizer

ComposerJson::read() A
last analyzed 2017-06-15 15:50 UTC

↳ Parent: ComposerJson

Complexity

Conditions	4
Paths	3

Size

Total Lines	14
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	14
rs	9.2
c	0
b	0
f	0
cc	4
eloc	8
nc	3
nop	1

<?php
/**
 * ComposerJson.php
 *
 * @package         ProjectVersioner
 * @subpackage      Reader
 */

namespace Naneau\ProjectVersioner\Reader;

use Naneau\ProjectVersioner\ReaderInterface;

use \RuntimeException;
use \stdClass;

/**
 * Finds the "version" from the composer.json file
 *
 * @category        Naneau
 * @package         ProjectVersioner
 * @subpackage      Reader
 */
class ComposerJson implements ReaderInterface
{
    /**
     * {@inheritdoc}
     **/
    public function canRead($directory)
    {
        return is_readable($directory . '/composer.json');
    }

    /**
     * {@inheritdoc}
     **/
    public function read($directory)
    {
        $json = @file_get_contents($directory . '/composer.json');
        if ($json === false) {
            return false;
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());
}
        }

        $json = json_decode($json);
        if (!($json instanceof stdClass) || empty($json->version)) {
            return false;
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());
}
        } 

        return trim($json->version);        
    }
}


1			<?php
2			/**
3			* ComposerJson.php
4			*
5			* @package ProjectVersioner
6			* @subpackage Reader
7			*/
8
9			namespace Naneau\ProjectVersioner\Reader;
10
11			use Naneau\ProjectVersioner\ReaderInterface;
12
13			use \RuntimeException;
14			use \stdClass;
15
16			/**
17			* Finds the "version" from the composer.json file
18			*
19			* @category Naneau
20			* @package ProjectVersioner
21			* @subpackage Reader
22			*/
23			class ComposerJson implements ReaderInterface
24			{
25			/**
26			* {@inheritdoc}
27			**/
28			public function canRead($directory)
29			{
30			return is_readable($directory . '/composer.json');
31			}
32
33			/**
34			* {@inheritdoc}
35			**/
36			public function read($directory)
37			{
38			$json = @file_get_contents($directory . '/composer.json');
39			if ($json === false) {
40			return false;
			0 ignored issues – show Bug Best Practice introduced 2017-06-15 15:29 UTC by Report Bug Copy Issue Report The return type of `return false;` (`false`) is incompatible with the return type declared by the interface `Naneau\ProjectVersioner\ReaderInterface::read` of type `string`. 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...
41			}
42
43			$json = json_decode($json);
44			if (!($json instanceof stdClass) \|\| empty($json->version)) {
45			return false;
			0 ignored issues – show Bug Best Practice introduced 2017-06-15 15:29 UTC by Report Bug Copy Issue Report The return type of `return false;` (`false`) is incompatible with the return type declared by the interface `Naneau\ProjectVersioner\ReaderInterface::read` of type `string`. 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...
46			}
47
48			return trim($json->version);
49			}
50			}
51

naneau / php-project-versioner

GitHub Access Token became invalid

ComposerJson::read() A last analyzed 2017-06-15 15:50 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

ComposerJson::read() A
last analyzed 2017-06-15 15:50 UTC