QuoteParser   A
last analyzed

Complexity

Total Complexity 3

Size/Duplication

Total Lines 33
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 1

Test Coverage

Coverage 0%

Importance

Changes 0
Metric Value
wmc 3
lcom 1
cbo 1
dl 0
loc 33
ccs 0
cts 13
cp 0
rs 10
c 0
b 0
f 0

3 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 5 1
A getCharacters() 0 4 1
A parse() 0 4 1
1
<?php
2
3
/*
4
 * This file is part of the league/commonmark-ext-smartpunct package.
5
 *
6
 * (c) Colin O'Dell <[email protected]>
7
 *
8
 * Original code based on the CommonMark JS reference parser (http://bitly.com/commonmark-js)
9
 *  - (c) John MacFarlane
10
 *
11
 * For the full copyright and license information, please view the LICENSE
12
 * file that was distributed with this source code.
13
 */
14
15
namespace League\CommonMark\Ext\SmartPunct;
16
17
use League\CommonMark\Extension\SmartPunct\Quote;
0 ignored issues
show
Bug introduced by
This use statement conflicts with another class in this namespace, League\CommonMark\Ext\SmartPunct\Quote.

Let’s assume that you have a directory layout like this:

.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php

and let’s assume the following content of Bar.php:

// Bar.php
namespace OtherDir;

use SomeDir\Foo; // This now conflicts the class OtherDir\Foo

If both files OtherDir/Foo.php and SomeDir/Foo.php are loaded in the same runtime, you will see a PHP error such as the following:

PHP Fatal error:  Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php

However, as OtherDir/Foo.php does not necessarily have to be loaded and the error is only triggered if it is loaded before OtherDir/Bar.php, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias:

// Bar.php
namespace OtherDir;

use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore.
Loading history...
18
use League\CommonMark\Extension\SmartPunct\QuoteParser as CoreParser;
19
use League\CommonMark\Inline\Parser\InlineParserInterface;
20
use League\CommonMark\InlineParserContext;
21
22
/**
23
 * @deprecated The league/commonmark-ext-smartpunct extension is now deprecated. All functionality has been moved into league/commonmark 1.3+, so use that instead.
24
 */
25
final class QuoteParser implements InlineParserInterface
26
{
27
    public const DOUBLE_QUOTES = [Quote::DOUBLE_QUOTE, Quote::DOUBLE_QUOTE_OPENER, Quote::DOUBLE_QUOTE_CLOSER];
28
    public const SINGLE_QUOTES = [Quote::SINGLE_QUOTE, Quote::SINGLE_QUOTE_OPENER, Quote::SINGLE_QUOTE_CLOSER];
29
30
    private $coreParser;
31
32
    public function __construct()
33
    {
34
        @trigger_error(sprintf('league/commonmark-ext-smartpunct is deprecated; use %s from league/commonmark 1.3+ instead', CoreParser::class), E_USER_DEPRECATED);
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

If you suppress an error, we recommend checking for the error condition explicitly:

// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
35
        $this->coreParser = new CoreParser();
36
    }
37
38
    /**
39
     * @return string[]
40
     */
41
    public function getCharacters(): array
42
    {
43
        return $this->coreParser->getCharacters();
44
    }
45
46
    /**
47
     * Normalizes any quote characters found and manually adds them to the delimiter stack
48
     *
49
     * @param InlineParserContext $inlineContext
50
     *
51
     * @return bool
52
     */
53
    public function parse(InlineParserContext $inlineContext): bool
54
    {
55
        return $this->coreParser->parse($inlineContext);
56
    }
57
}
58