FootnoteRefParser::parse() - 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

FootnoteRefParser::parse() A

↳ Parent: FootnoteRefParser

Complexity

Conditions	4
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	12
CRAP Score	4.0466

Importance

Changes

Metric	Value
dl	0
loc	24
ccs	12
cts	14
cp	0.8571
rs	9.536
c	0
b	0
f	0
cc	4
nc	4
nop	1
crap	4.0466

<?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 FootnoteRefParser 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('#\[\^([^\]]+)\]#');
        if ($m !== null) {
            if (\preg_match('#\[\^([^\]]+)\]#', $m, $matches) > 0) {
                $container->appendChild(new FootnoteRef($this->createReference($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
    {
        return new Reference($label, '#fn:' . $label, $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 FootnoteRefParser implements InlineParserInterface
23		{
24	42	public function getCharacters(): array
25		{
26	42	return ['['];
27		}
28
29	30	public function parse(InlineParserContext $inlineContext): bool
30		{
31	30	$container = $inlineContext->getContainer();
32	30	$cursor = $inlineContext->getCursor();
33	30	$nextChar = $cursor->peek();
34	30	if ($nextChar !== '^') {
35	18	return false;
36		}
37
38	18	$state = $cursor->saveState();
39
40	18	$m = $cursor->match('#\[\^([^\]]+)\]#');
41	18	if ($m !== null) {
42	18	if (\preg_match('#\[\^([^\]]+)\]#', $m, $matches) > 0) {
43	18	$container->appendChild(new FootnoteRef($this->createReference($matches[1])));
44
45	18	return true;
46		}
47		}
48
49		$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...
50
51		return false;
52		}
53
54	18	private function createReference(string $label): Reference
55		{
56	18	return new Reference($label, '#fn:' . $label, $label);
57		}
58		}
59

thephpleague / commonmark

Push — master ( 103c69...214519 )

FootnoteRefParser::parse() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like