DocumentBlockParser::__construct() - Code Metrics - Inspection of "Refactor the parser implementation" - thephpleague/commonmark - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — refactor-parsing ( adbb6b...fbe6de )

by Colin

created 2020-05-03 14:10 UTC

DocumentBlockParser::__construct() A

↳ Parent: DocumentBlockParser

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	3
cts	3
cp	1
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1
crap	1

<?php

/*
 * This file is part of the league/commonmark package.
 *
 * (c) Colin O'Dell <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace League\CommonMark\Parser\Block;

use League\CommonMark\Node\Block\AbstractBlock;
use League\CommonMark\Node\Block\Document;
use League\CommonMark\Parser\Cursor;
use League\CommonMark\Reference\ReferenceMapInterface;

/**
 * Parser implementation which ensures everything is added to the root-level Document
 */
final class DocumentBlockParser extends AbstractBlockContinueParser
{
    /** @var Document */
    protected $document;

    public function __construct(ReferenceMapInterface $referenceMap)
    {
        $this->document = new Document($referenceMap);
    }

    /**
     * @return Document
     */
    public function getBlock(): AbstractBlock
    {
        return $this->document;
    }

    public function isContainer(): bool
    {
        return true;
    }

    public function canContain(AbstractBlock $childBlock): bool
    {
        return true;
    }

    public function tryContinue(Cursor $cursor, BlockContinueParserInterface $activeBlockParser): ?BlockContinue
    {
        return BlockContinue::at($cursor);
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		* This file is part of the league/commonmark package.
5		*
6		* (c) Colin O'Dell <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace League\CommonMark\Parser\Block;
13
14		use League\CommonMark\Node\Block\AbstractBlock;
15		use League\CommonMark\Node\Block\Document;
16		use League\CommonMark\Parser\Cursor;
17		use League\CommonMark\Reference\ReferenceMapInterface;
18
19		/**
20		* Parser implementation which ensures everything is added to the root-level Document
21		*/
22		final class DocumentBlockParser extends AbstractBlockContinueParser
23		{
24		/** @var Document */
25		protected $document;
26
27	2499	public function __construct(ReferenceMapInterface $referenceMap)
28		{
29	2499	$this->document = new Document($referenceMap);
30	2499	}
31
32		/**
33		* @return Document
34		*/
35	2499	public function getBlock(): AbstractBlock
36		{
37	2499	return $this->document;
38		}
39
40	2493	public function isContainer(): bool
41		{
42	2493	return true;
43		}
44
45	2493	public function canContain(AbstractBlock $childBlock): bool
46		{
47	2493	return true;
48		}
49
50		public function tryContinue(Cursor $cursor, BlockContinueParserInterface $activeBlockParser): ?BlockContinue
51		{
52		return BlockContinue::at($cursor);
		0 ignored issues – show Bug Best Practice introduced 2020-05-03 01:47 UTC by Report Bug Copy Issue Report The return type of `return \League\CommonMar...kContinue::at($cursor);` (`self`) is incompatible with the return type declared by the interface `League\CommonMark\Parser...rInterface::tryContinue` of type `League\CommonMark\Parser\Block\BlockContinue\|null`. 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...
53		}
54		}
55

thephpleague / commonmark

Push — refactor-parsing ( adbb6b...fbe6de )

DocumentBlockParser::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like