AnonymousFootnoteRefParser - Code Metrics - Inspection of "Merge remote-tracking branch 'origin/1.5' into mas..." - thephpleague/commonmark - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 103c69...214519 )

by Colin

created 2020-05-25 15:37 UTC

AnonymousFootnoteRefParser A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	42
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	5

Test Coverage

Coverage

86.36%

Importance

Changes

Metric	Value
wmc	6
lcom	0
cbo	5
dl	0
loc	42
ccs	19
cts	22
cp	0.8636
rs	10
c	0
b	0
f	0

3 Methods

Rating	Name	Size	Complexity
A	getCharacters()	4	1
A	parse()	25	4
A	createReference()	8	1

<?php

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

declare(strict_types=1);

namespace League\CommonMark\Extension\Footnote\Parser;

use League\CommonMark\Extension\Footnote\Node\FootnoteRef;
use League\CommonMark\Parser\Inline\InlineParserInterface;
use League\CommonMark\Parser\InlineParserContext;
use League\CommonMark\Reference\Reference;

final class AnonymousFootnoteRefParser implements InlineParserInterface
{
    public function getCharacters(): array
    {
        return ['^'];
    }

    public function parse(InlineParserContext $inlineContext): bool
    {
        $container = $inlineContext->getContainer();
        $cursor    = $inlineContext->getCursor();
        $nextChar  = $cursor->peek();
        if ($nextChar !== '[') {
            return false;
        }

        $state = $cursor->saveState();

        $m = $cursor->match('/\^\[[^\n^\]]+\]/');
        if ($m !== null) {
            if (\preg_match('#\^\[([^\]]+)\]#', $m, $matches) > 0) {
                $reference = $this->createReference($matches[1]);
                $container->appendChild(new FootnoteRef($reference, $matches[1]));

                return true;
            }
        }

        $cursor->restoreState($state);
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}

        return false;
    }

    private function createReference(string $label): Reference
    {
        $refLabel = Reference::normalizeReference($label);
        $refLabel = \mb_strtolower(\str_replace(' ', '-', $refLabel));
        $refLabel = \substr($refLabel, 0, 20);

        return new Reference($refLabel, '#fn:' . $refLabel, $label);
    }
}


1		<?php
2
3		/*
4		* This file is part of the league/commonmark package.
5		*
6		* (c) Colin O'Dell <[email protected]>
7		* (c) Rezo Zero / Ambroise Maupate
8		*
9		* For the full copyright and license information, please view the LICENSE
10		* file that was distributed with this source code.
11		*/
12
13		declare(strict_types=1);
14
15		namespace League\CommonMark\Extension\Footnote\Parser;
16
17		use League\CommonMark\Extension\Footnote\Node\FootnoteRef;
18		use League\CommonMark\Parser\Inline\InlineParserInterface;
19		use League\CommonMark\Parser\InlineParserContext;
20		use League\CommonMark\Reference\Reference;
21
22		final class AnonymousFootnoteRefParser implements InlineParserInterface
23		{
24	42	public function getCharacters(): array
25		{
26	42	return ['^'];
27		}
28
29	18	public function parse(InlineParserContext $inlineContext): bool
30		{
31	18	$container = $inlineContext->getContainer();
32	18	$cursor = $inlineContext->getCursor();
33	18	$nextChar = $cursor->peek();
34	18	if ($nextChar !== '[') {
35		return false;
36		}
37
38	18	$state = $cursor->saveState();
39
40	18	$m = $cursor->match('/\^\[[^\n^\]]+\]/');
41	18	if ($m !== null) {
42	18	if (\preg_match('#\^\[([^\]]+)\]#', $m, $matches) > 0) {
43	18	$reference = $this->createReference($matches[1]);
44	18	$container->appendChild(new FootnoteRef($reference, $matches[1]));
45
46	18	return true;
47		}
48		}
49
50		$cursor->restoreState($state);
		0 ignored issues – show Unused Code introduced 2020-05-25 16:07 UTC by Report Bug Copy Issue Report The call to the method `League\CommonMark\Parser\Cursor::restoreState()` seems un-needed as the method has no side-effects. PHP Analyzer performs a side-effects analysis of your code. A side-effect is basically anything that might be visible after the scope of the method is left. Let’s take a look at an example: class User { private $email; public function getEmail() { return $this->email; } public function setEmail($email) { $this->email = $email; } } If we look at the `getEmail()` method, we can see that it has no side-effect. Whether you call this method or not, no future calls to other methods are affected by this. As such code as the following is useless: $user = new User(); $user->getEmail(); // This line could safely be removed as it has no effect. On the hand, if we look at the `setEmail()`, this method _has_ side-effects. In the following case, we could not remove the method call: $user = new User(); $user->setEmail('email@domain'); // This line has a side-effect (it changes an // instance variable). Loading history...
51
52		return false;
53		}
54
55	18	private function createReference(string $label): Reference
56		{
57	18	$refLabel = Reference::normalizeReference($label);
58	18	$refLabel = \mb_strtolower(\str_replace(' ', '-', $refLabel));
59	18	$refLabel = \substr($refLabel, 0, 20);
60
61	18	return new Reference($refLabel, '#fn:' . $refLabel, $label);
62		}
63		}
64

thephpleague / commonmark

Push — master ( 103c69...214519 )

AnonymousFootnoteRefParser A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

3 Methods

Duplication Side-by-Side

Filter issues like