Completed
Push — master ( fce42c...ce3e45 )
by Colin
10s
created

ParagraphConverter::escapeListlikeCharacters()   A

Complexity

Conditions 3
Paths 2

Size

Total Lines 9
Code Lines 5

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 12

Importance

Changes 0
Metric Value
dl 0
loc 9
ccs 0
cts 0
cp 0
rs 9.6666
c 0
b 0
f 0
cc 3
eloc 5
nc 2
nop 1
crap 12
1
<?php
2
3
namespace League\HTMLToMarkdown\Converter;
4
5
use League\HTMLToMarkdown\ElementInterface;
6
7
class ParagraphConverter implements ConverterInterface
8
{
9
    /**
10
     * @param ElementInterface $element
11
     *
12
     * @return string
13
     */
14 27
    public function convert(ElementInterface $element)
15
    {
16 27
        $value = $element->getValue();
17
18 27
        $markdown = '';
19
20 27
        $lines = preg_split('/\r\n|\r|\n/', $value);
21 27
        foreach ($lines as $line) {
22
            /*
23
             * Some special characters need to be escaped based on the position that they appear
24
             * The following function will deal with those special cases.
25
             */
26 27
            $markdown .= $this->escapeSpecialCharacters($line);
27 27
            $markdown .= "\n";
28 27
        }
29
30 27
        return trim($markdown) !== '' ? rtrim($markdown) . "\n\n" : '';
31
    }
32
33
    /**
34
     * @return string[]
35
     */
36 78
    public function getSupportedTags()
37
    {
38 78
        return array('p');
39
    }
40
41
    /**
42
     * @param string $line
43
     *
44
     * @return string
45
     */
46 27
    private function escapeSpecialCharacters($line)
47
    {
48 27
        $line = $this->escapeHeaderlikeCharacters($line);
49 27
        $line = $this->escapeBlockquotelikeCharacters($line);
50 27
        $line = $this->escapeOrderedListlikeCharacters($line);
51
        $line = $this->escapeListlikeCharacters($line);
52 27
53
        return $line;
54
    }
55
56
    /**
57
     * @param string $line
58
     *
59
     * @return string
60 27
     */
61 View Code Duplication
    private function escapeBlockquotelikeCharacters($line)
0 ignored issues
show
Duplication introduced by Andres Rey
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
62 27
    {
63
        if (strpos(ltrim($line), '>') === 0) {
64 3
            // Found a > char, escaping it
65
            return '\\' . ltrim($line);
66 27
        } else {
67
            return $line;
68
        }
69
    }
70
71
    /**
72
     * @param string $line
73
     *
74
     * @return string
75 27
     */
76 View Code Duplication
    private function escapeHeaderlikeCharacters($line)
0 ignored issues
show
Duplication introduced by Andres Rey
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
77 27
    {
78
        if (strpos(ltrim($line), '--') === 0) {
79 3
            // Found a -- structure, escaping it
80
            return '\\' . ltrim($line);
81 27
        } else {
82
            return $line;
83
        }
84
    }
85
86
    /**
87
     * @param string $line
88
     *
89
     * @return string
90 27
     */
91
    private function escapeOrderedListlikeCharacters($line)
92
    {
93 27
        // This regex will match numbers ending on ')' or '.' that are at the beginning of the line.
94
        if (preg_match('/^[0-9]+(?=\)|\.)/', $line, $match)) {
95 3
            // Found an Ordered list like character, escaping it
96
            return substr_replace($line, '\\', strlen($match[0]), 0);
97 27
        } else {
98
            return $line;
99
        }
100
    }
101
102
    /**
103
     * @param string $line
104
     *
105
     * @return string
106
     */
107
    private function escapeListlikeCharacters($line)
108
    {
109
        if (strpos(ltrim($line), '- ') === 0 || strpos(ltrim($line), '+ ') === 0) {
110
            // Found an list like character, escaping it
111
            return '\\' . ltrim($line);
112
        } else {
113
            return $line;
114
        }
115
    }
116
}
117