MarkuaExtension - Code Metrics - danhunsaker/markua - Measure and Improve Code Quality continuously with Scrutinizer

MarkuaExtension A
last analyzed 2018-09-10 10:46 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	43
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	14

Test Coverage

Coverage

74.07%

Importance

Changes

Metric	Value
wmc	3
lcom	0
cbo	14
dl	0
loc	43
ccs	20
cts	27
cp	0.7407
rs	10
c	0
b	0
f	0

3 Methods

Rating	Name	Size	Complexity
A	getBlockParsers()	17	1
A	getBlockRenderers()	7	1
A	getName()	4	1

<?php
namespace Danhunsaker\Markua\Extension;

use League\CommonMark\Block\Parser as BlockParser;
use League\CommonMark\Extension\CommonMarkCoreExtension;
use Danhunsaker\Markua\Block\Parser as MarkuaBlockParser;
use Danhunsaker\Markua\Block\Renderer\AsideRenderer;
use Danhunsaker\Markua\Block\Renderer\IconBlockRenderer;

class MarkuaExtension extends CommonMarkCoreExtension
{

    /**
     * {@inheritdoc}
     */
    public function getBlockParsers()
    {
        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 new Author('Johannes');
    }
}

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

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

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
            // This order is important
            new BlockParser\IndentedCodeParser(),
            new BlockParser\LazyParagraphParser(),
            new BlockParser\BlockQuoteParser(),
            new MarkuaBlockParser\AsideParser(),
            new MarkuaBlockParser\IconBlockParser(),
            new BlockParser\ATXHeadingParser(),
            new BlockParser\FencedCodeParser(),
            new BlockParser\HtmlBlockParser(),
            new BlockParser\SetExtHeadingParser(),
            new BlockParser\ThematicBreakParser(),
            new BlockParser\ListParser(),
        );
    }

    /**
     * {@inheritdoc}
     */
    public function getBlockRenderers()
    {
        $renderers = parent::getBlockRenderers();
        $renderers['Danhunsaker\Markua\Block\Element\Aside'] = new AsideRenderer();
        $renderers['Danhunsaker\Markua\Block\Element\IconBlock'] = new IconBlockRenderer();
        return $renderers;
class Author {
    private $name;

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

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

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

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

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

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

    /**
     * {@inheritdoc}
     */
    public function getName()
    {
        return 'markua';
    }
}


1		<?php
2		namespace Danhunsaker\Markua\Extension;
3
4		use League\CommonMark\Block\Parser as BlockParser;
5		use League\CommonMark\Extension\CommonMarkCoreExtension;
6		use Danhunsaker\Markua\Block\Parser as MarkuaBlockParser;
7		use Danhunsaker\Markua\Block\Renderer\AsideRenderer;
8		use Danhunsaker\Markua\Block\Renderer\IconBlockRenderer;
9
10		class MarkuaExtension extends CommonMarkCoreExtension
11		{
12
13		/**
14		* {@inheritdoc}
15		*/
16	30	public function getBlockParsers()
17		{
18		return array(
		0 ignored issues – show Best Practice introduced 2018-09-10 09:22 UTC by Report Bug Copy Issue Report The expression `return array(new \League...k\Parser\ListParser());` seems to be an `array`, but some of its elements' types (`Danhunsaker\Markua\Block...\Parser\IconBlockParser`) are incompatible with the return type of the parent method `League\CommonMark\Extens...ension::getBlockParsers` of type `array<League\CommonMark\...er\LazyParagraphParser>`. 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 new Author('Johannes'); } } class BlogPost extends Post { public function getAuthor() { return '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...
19		// This order is important
20	30	new BlockParser\IndentedCodeParser(),
21	30	new BlockParser\LazyParagraphParser(),
22	30	new BlockParser\BlockQuoteParser(),
23	30	new MarkuaBlockParser\AsideParser(),
24	30	new MarkuaBlockParser\IconBlockParser(),
25	30	new BlockParser\ATXHeadingParser(),
26	30	new BlockParser\FencedCodeParser(),
27	30	new BlockParser\HtmlBlockParser(),
28	30	new BlockParser\SetExtHeadingParser(),
29	30	new BlockParser\ThematicBreakParser(),
30	30	new BlockParser\ListParser(),
31	30	);
32		}
33
34		/**
35		* {@inheritdoc}
36		*/
37	30	public function getBlockRenderers()
38		{
39	30	$renderers = parent::getBlockRenderers();
40	30	$renderers['Danhunsaker\Markua\Block\Element\Aside'] = new AsideRenderer();
41	30	$renderers['Danhunsaker\Markua\Block\Element\IconBlock'] = new IconBlockRenderer();
42	30	return $renderers;
		0 ignored issues – show Best Practice introduced 2018-09-10 09:22 UTC by Report Bug Copy Issue Report The expression `return $renderers;` seems to be an `array`, but some of its elements' types (`Danhunsaker\Markua\Block\Renderer\AsideRenderer`) are incompatible with the return type of the parent method `League\CommonMark\Extens...sion::getBlockRenderers` of type `array<string,League\Comm...\ThematicBreakRenderer>`. 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 new Author('Johannes'); } } class BlogPost extends Post { public function getAuthor() { return '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...
43		}
44
45		/**
46		* {@inheritdoc}
47		*/
48	1	public function getName()
49		{
50	1	return 'markua';
51		}
52		}
53

danhunsaker / markua

MarkuaExtension A last analyzed 2018-09-10 10:46 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

3 Methods

Duplication Side-by-Side

Filter issues like

MarkuaExtension A
last analyzed 2018-09-10 10:46 UTC