Markdown - Code Metrics - Inspection of "added linkStyle option to render links as href" - cebe/markdown-latex - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 42eb55...c2b13f )

by Carsten

created 2019-05-21 13:28 UTC

Markdown B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	356
Duplicated Lines	3.93 %

Coupling/Cohesion

Components	3
Dependencies	10

Test Coverage

Coverage

82.64%

Importance

Changes

Metric	Value
wmc	51
lcom	3
cbo	10
dl	14
loc	356
ccs	100
cts	121
cp	0.8264
rs	7.92
c	0
b	0
f	0

22 Methods

Rating	Name	Duplication	Size	Complexity
A	prepare()	0	5	1
B	consumeParagraph()	0	21	8
A	renderParagraph()	0	4	1
A	renderQuote()	0	4	1
A	renderCode()	0	10	2
A	renderList()	0	11	3
A	renderHeadline()	0	10	4
A	renderHr()	0	4	1
B	renderLink()	7	26	8
A	renderImage()	7	22	3
A	parseInlineHtml()	0	13	3
A	renderLabel()	0	4	1
A	renderEmail()	0	5	1
A	renderUrl()	0	4	1
A	renderInlineCode()	0	11	2
A	renderStrong()	0	4	1
A	renderEmph()	0	4	1
A	parseEscape()	0	10	4
A	renderBackslash()	0	4	1
A	escapeUrl()	0	4	1
A	escapeLatex()	0	7	2
A	renderText()	0	11	1

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like Markdown often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use Markdown, and based on these observations, apply Extract Interface, too.

<?php
/**
 * @copyright Copyright (c) 2014 Carsten Brandt
 * @license https://github.com/cebe/markdown/blob/master/LICENSE
 * @link https://github.com/cebe/markdown#readme
 */

namespace cebe\markdown\latex;

use cebe\markdown\block\CodeTrait;
use cebe\markdown\block\HeadlineTrait;
use cebe\markdown\block\ListTrait;
use cebe\markdown\block\QuoteTrait;
use cebe\markdown\block\RuleTrait;

use cebe\markdown\inline\CodeTrait as InlineCodeTrait;
use cebe\markdown\inline\EmphStrongTrait;
use cebe\markdown\inline\LinkTrait;

use MikeVanRiel\TextToLatex;

/**
 * Markdown parser for the [initial markdown spec](http://daringfireball.net/projects/markdown/syntax).
 *
 * @author Carsten Brandt <[email protected]>
 */
class Markdown extends \cebe\markdown\Parser
{
	// include block element parsing using traits
	use CodeTrait;
	use HeadlineTrait;
	use ListTrait {
		// Check Ul List before headline
		identifyUl as protected identifyBUl;
		consumeUl as protected consumeBUl;
	}
	use QuoteTrait;
	use RuleTrait {
		// Check Hr before checking lists
		identifyHr as protected identifyAHr;
		consumeHr as protected consumeAHr;
	}

	// include inline element parsing using traits
	use InlineCodeTrait;
	use EmphStrongTrait;
	use LinkTrait;

	/**
	 * @var string this string will be prefixed to all auto generated labels.
	 * This can be used to disambiguate labels when combining multiple markdown files into one document.
	 */
	public $labelPrefix = '';

	const LINK_STYLE_FOOTNOTE = 'footnote';
	const LINK_STYLE_HREF = 'href';

	/**
	 * @var string link style defines how links are rendered in LaTeX, there are two different options:
	 *
	 * - `footnote` (default) - render all links with a footnote, which contains the full URL of the link. This is good for printing the PDF.
	 * - `href` - render all links with a hyperref, similar to HTML, the link target is not visible in this case.
	 */
	public $linkStyle = self::LINK_STYLE_FOOTNOTE;

	/**
	 * @var array these are "escapeable" characters. When using one of these prefixed with a
	 * backslash, the character will be outputted without the backslash and is not interpreted
	 * as markdown.
	 */
	protected $escapeCharacters = [
		'\\', // backslash
		'`', // backtick
		'*', // asterisk
		'_', // underscore
		'{', '}', // curly braces
		'[', ']', // square brackets
		'(', ')', // parentheses
		'#', // hash mark
		'+', // plus sign
		'-', // minus sign (hyphen)
		'.', // dot
		'!', // exclamation mark
		'<', '>',
	];


	/**
	 * @inheritDoc
	 */
	protected function prepare()
	{
		// reset references
		$this->references = [];
	}

	/**
	 * Consume lines for a paragraph
	 *
	 * Allow headlines and code to break paragraphs
	 */
	protected function consumeParagraph($lines, $current)
	{
		// consume until newline
		$content = [];
		for ($i = $current, $count = count($lines); $i < $count; $i++) {
			$line = $lines[$i];
			if (!empty($line) && ltrim($line) !== '' &&
				!($line[0] === "\t" || $line[0] === " " && strncmp($line, '    ', 4) === 0) &&
				!$this->identifyHeadline($line, $lines, $i))
			{
				$content[] = $line;
			} else {
				break;
			}
		}
		$block = [
			'paragraph',
			'content' => $this->parseInline(implode("\n", $content)),
		];
		return [$block, --$i];
	}


	// rendering adjusted for LaTeX output


	/**
	 * @inheritdoc
	 */
	protected function renderParagraph($block)
	{
		return $this->renderAbsy($block['content']) . "\n\n";
	}

	/**
	 * @inheritdoc
	 */
	protected function renderQuote($block)
	{
		return '\begin{quote}' . $this->renderAbsy($block['content']) . "\\end{quote}\n";
	}

	/**
	 * @inheritdoc
	 */
	protected function renderCode($block)
	{
		$language = isset($block['language']) ? "\\lstset{language={$block['language']}}" : '\lstset{language={}}';

		$content = $block['content'];
		// replace No-Break Space characters in code block, which do not render in LaTeX
		$content = preg_replace("/[\x{00a0}\x{202f}]/u", ' ', $content);

		return "$language\\begin{lstlisting}\n{$content}\n\\end{lstlisting}\n";
	}

	/**
	 * @inheritdoc
	 */
	protected function renderList($block)
	{
		$type = ($block['list'] === 'ol') ? 'enumerate' : 'itemize';
		$output = "\\begin{{$type}}\n";

		foreach ($block['items'] as $item => $itemLines) {
			$output .= '\item ' . $this->renderAbsy($itemLines). "\n";
		}

		return "$output\\end{{$type}}\n";
	}

	/**
	 * @inheritdoc
	 */
	protected function renderHeadline($block)
	{
		$content = $this->renderAbsy($block['content']);
		switch($block['level']) {
			case 1: return "\\section{{$content}}\n";
			case 2: return "\\subsection{{$content}}\n";
			case 3: return "\\subsubsection{{$content}}\n";
			default: return "\\paragraph{{$content}}\n";
		}
	}

	/**
	 * @inheritdoc
	 */
	protected function renderHr($block)

	{
		return "\n\\noindent\\rule{\\textwidth}{0.4pt}\n";
	}

	/**
	 * @inheritdoc
	 */
	protected function renderLink($block)
	{
		if (isset($block['refkey'])) {

			if (($ref = $this->lookupReference($block['refkey'])) !== false) {
				$block = array_merge($block, $ref);
			} else {
				return $block['orig'];
			}
		}

		$url = $block['url'];
		$text = $this->renderAbsy($block['text']);
		if (strpos($url, '://') === false) {
			// consider all non absolute links as relative in the document
			// $title is ignored in this case.
			if (isset($url[0]) && $url[0] === '#') {
				$url = $this->labelPrefix . $url;
			}
			return '\hyperref['.str_replace('#', '::', $url).']{' . $text . '}';
		} else {
			if ($this->linkStyle === self::LINK_STYLE_HREF) {
				return '\href{' . $this->escapeUrl($url) . '}{' . $text . '}';
			}
			return $text . '\\footnote{' . (empty($block['title']) ? '' : $this->escapeLatex($block['title']) . ': ') . '\url{' . $this->escapeUrl($url) . '}}';
		}
	}

	/**
	 * @inheritdoc
	 */
	protected function renderImage($block)
	{
		if (isset($block['refkey'])) {

			if (($ref = $this->lookupReference($block['refkey'])) !== false) {
				$block = array_merge($block, $ref);
			} else {
				return $block['orig'];
			}
		}

		// TODO create figure with caption with title
		$replaces = [
			'%' => '\\%',
			'{' => '\\%7B',
			'}' => '\\%7D',
			'\\' => '\\\\',
			'#' => '\\#',
			'$' => '\\%24',
		];
		$url = str_replace(array_keys($replaces), array_values($replaces), $block['url']);
		return "\\noindent\\includegraphics[width=\\textwidth]{{$url}}";
	}

	/**
	 * Parses <a name="..."></a> tags as reference labels
	 */
	private function parseInlineHtml($text)
	{
		if (strpos($text, '>') !== false) {
			// convert a name markers to \labels
			if (preg_match('~^<((a|span)) (name|id)="(.*?)">.*?</\1>~i', $text, $matches)) {
				return [
					['label', 'name' => str_replace('#', '::', $this->labelPrefix . $matches[4])],
					strlen($matches[0])
				];
			}
		}
		return [['text', '<'], 1];
	}

	/**
	 * renders a reference label
	 */
	protected function renderLabel($block)
	{
		return "\\label{{$block['name']}}";
	}

	/**
	 * @inheritdoc
	 */
	protected function renderEmail($block)
	{
		$email = $this->escapeUrl($block[1]);
		return "\\href{mailto:{$email}}{{$email}}";
	}

	/**
	 * @inheritdoc
	 */
	protected function renderUrl($block)
	{
		return '\url{' . $this->escapeUrl($block[1]) . '}';
	}

	/**
	 * @inheritdoc
	 */
	protected function renderInlineCode($block)
	{
		// replace No-Break Space characters in code block, which do not render in LaTeX
		$content = preg_replace("/[\x{00a0}\x{202f}]/u", ' ', $block[1]);

		if (strpos($content, '|') !== false) {
			return '\\lstinline`' . str_replace("\n", ' ', $content) . '`'; // TODO make this more robust against code containing backticks
		} else {
			return '\\lstinline|' . str_replace("\n", ' ', $content) . '|';
		}
	}

	/**
	 * @inheritdoc
	 */
	protected function renderStrong($block)
	{
		return '\textbf{' . $this->renderAbsy($block[1]) . '}';
	}

	/**
	 * @inheritdoc
	 */
	protected function renderEmph($block)
	{
		return '\textit{' . $this->renderAbsy($block[1]) . '}';
	}

	/**
	 * Parses escaped special characters.
	 * This allow a backslash to be interpreted as LaTeX
	 * @marker \
	 */
	protected function parseEscape($text)
	{
		if (isset($text[1]) && in_array($text[1], $this->escapeCharacters)) {
			if ($text[1] === '\\') {
				return [['backslash'], 2];
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
			}
			return [['text', $text[1]], 2];
		}
		return [['text', $text[0]], 1];
	}

	protected function renderBackslash()
	{
		return '\\';
	}

	private $_escaper;

	/**
	 * Escape special characters in URLs
	 */
	protected function escapeUrl($string)
	{
		return str_replace('%', '\\%', $this->escapeLatex($string));
	}

	/**
	 * Escape special LaTeX characters
	 */
	protected function escapeLatex($string)
	{
		if ($this->_escaper === null) {
			$this->_escaper = new TextToLatex();
		}
		return $this->_escaper->convert($string);
	}

	/**
	 * @inheritdocs
	 *
	 * Parses a newline indicated by two spaces on the end of a markdown line.
	 */
	protected function renderText($text)
	{
		$output = str_replace("  \n", "\\\\\n", $this->escapeLatex($text[1]));
		// support No-Break Space in LaTeX
		$output = preg_replace("/\x{00a0}/u", '~', $output);
		// support Narrow No-Break Space spaces in LaTeX
		// http://unicode-table.com/en/202F/
		// http://tex.stackexchange.com/questions/76132/how-to-typeset-a-small-non-breaking-space
		$output = preg_replace("/\x{202f}/u", '\nobreak\hspace{.16667em plus .08333em}', $output);
		return $output;
	}
}


1			<?php
2			/**
3			* @copyright Copyright (c) 2014 Carsten Brandt
4			* @license https://github.com/cebe/markdown/blob/master/LICENSE
5			* @link https://github.com/cebe/markdown#readme
6			*/
7
8			namespace cebe\markdown\latex;
9
10			use cebe\markdown\block\CodeTrait;
11			use cebe\markdown\block\HeadlineTrait;
12			use cebe\markdown\block\ListTrait;
13			use cebe\markdown\block\QuoteTrait;
14			use cebe\markdown\block\RuleTrait;
15
16			use cebe\markdown\inline\CodeTrait as InlineCodeTrait;
17			use cebe\markdown\inline\EmphStrongTrait;
18			use cebe\markdown\inline\LinkTrait;
19
20			use MikeVanRiel\TextToLatex;
21
22			/**
23			* Markdown parser for the [initial markdown spec](http://daringfireball.net/projects/markdown/syntax).
24			*
25			* @author Carsten Brandt <[email protected]>
26			*/
27			class Markdown extends \cebe\markdown\Parser
28			{
29			// include block element parsing using traits
30			use CodeTrait;
31			use HeadlineTrait;
32			use ListTrait {
33			// Check Ul List before headline
34			identifyUl as protected identifyBUl;
35			consumeUl as protected consumeBUl;
36			}
37			use QuoteTrait;
38			use RuleTrait {
39			// Check Hr before checking lists
40			identifyHr as protected identifyAHr;
41			consumeHr as protected consumeAHr;
42			}
43
44			// include inline element parsing using traits
45			use InlineCodeTrait;
46			use EmphStrongTrait;
47			use LinkTrait;
48
49			/**
50			* @var string this string will be prefixed to all auto generated labels.
51			* This can be used to disambiguate labels when combining multiple markdown files into one document.
52			*/
53			public $labelPrefix = '';
54
55			const LINK_STYLE_FOOTNOTE = 'footnote';
56			const LINK_STYLE_HREF = 'href';
57
58			/**
59			* @var string link style defines how links are rendered in LaTeX, there are two different options:
60			*
61			* - `footnote` (default) - render all links with a footnote, which contains the full URL of the link. This is good for printing the PDF.
62			* - `href` - render all links with a hyperref, similar to HTML, the link target is not visible in this case.
63			*/
64			public $linkStyle = self::LINK_STYLE_FOOTNOTE;
65
66			/**
67			* @var array these are "escapeable" characters. When using one of these prefixed with a
68			* backslash, the character will be outputted without the backslash and is not interpreted
69			* as markdown.
70			*/
71			protected $escapeCharacters = [
72			'\\', // backslash
73			'`', // backtick
74			'*', // asterisk
75			'_', // underscore
76			'{', '}', // curly braces
77			'[', ']', // square brackets
78			'(', ')', // parentheses
79			'#', // hash mark
80	23		'+', // plus sign
81			'-', // minus sign (hyphen)
82			'.', // dot
83	23		'!', // exclamation mark
84	23		'<', '>',
85			];
86
87
88			/**
89			* @inheritDoc
90			*/
91	8		protected function prepare()
92			{
93			// reset references
94	8		$this->references = [];
95	8		}
96	8
97	8		/**
98	8		* Consume lines for a paragraph
99	8		*
100	8		* Allow headlines and code to break paragraphs
101	8		*/
102	8		protected function consumeParagraph($lines, $current)
103	7		{
104			// consume until newline
105	8		$content = [];
106			for ($i = $current, $count = count($lines); $i < $count; $i++) {
107	8		$line = $lines[$i];
108	8		if (!empty($line) && ltrim($line) !== '' &&
109	8		!($line[0] === "\t" \|\| $line[0] === " " && strncmp($line, ' ', 4) === 0) &&
110	8		!$this->identifyHeadline($line, $lines, $i))
111			{
112			$content[] = $line;
113			} else {
114			break;
115			}
116			}
117			$block = [
118			'paragraph',
119			'content' => $this->parseInline(implode("\n", $content)),
120	21		];
121			return [$block, --$i];
122	21		}
123
124
125			// rendering adjusted for LaTeX output
126
127
128	2		/**
129			* @inheritdoc
130	2		*/
131			protected function renderParagraph($block)
132			{
133			return $this->renderAbsy($block['content']) . "\n\n";
134			}
135
136	3		/**
137			* @inheritdoc
138	3		*/
139			protected function renderQuote($block)
140	3		{
141			return '\begin{quote}' . $this->renderAbsy($block['content']) . "\\end{quote}\n";
142	3		}
143
144	3		/**
145			* @inheritdoc
146			*/
147			protected function renderCode($block)
148			{
149			$language = isset($block['language']) ? "\\lstset{language={$block['language']}}" : '\lstset{language={}}';
150	2
151			$content = $block['content'];
152	2		// replace No-Break Space characters in code block, which do not render in LaTeX
153	2		$content = preg_replace("/[\x{00a0}\x{202f}]/u", ' ', $content);
154
155	2		return "$language\\begin{lstlisting}\n{$content}\n\\end{lstlisting}\n";
156	2		}
157	2
158			/**
159	2		* @inheritdoc
160			*/
161			protected function renderList($block)
162			{
163			$type = ($block['list'] === 'ol') ? 'enumerate' : 'itemize';
164			$output = "\\begin{{$type}}\n";
165	3
166			foreach ($block['items'] as $item => $itemLines) {
167	3		$output .= '\item ' . $this->renderAbsy($itemLines). "\n";
168	3		}
169	3
170	3		return "$output\\end{{$type}}\n";
171	2		}
172	2
173	2		/**
174			* @inheritdoc
175			*/
176			protected function renderHeadline($block)
177			{
178			$content = $this->renderAbsy($block['content']);
179	2		switch($block['level']) {
180			case 1: return "\\section{{$content}}\n";
181	2		case 2: return "\\subsection{{$content}}\n";
182			case 3: return "\\subsubsection{{$content}}\n";
183			default: return "\\paragraph{{$content}}\n";
184			}
185			}
186
187	2		/**
188			* @inheritdoc
189	2		*/
190			protected function renderHr($block)
			0 ignored issues – show Unused Code introduced 2019-05-21 13:32 UTC by Report Bug Copy Issue Report The parameter `$block` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
191			{
192			return "\n\\noindent\\rule{\\textwidth}{0.4pt}\n";
193			}
194
195			/**
196			* @inheritdoc
197	2		*/
198	2		protected function renderLink($block)
199	2		{
200		View Code Duplication	if (isset($block['refkey'])) {
			0 ignored issues – show Duplication introduced 2016-08-22 12:56 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
201			if (($ref = $this->lookupReference($block['refkey'])) !== false) {
202			$block = array_merge($block, $ref);
203			} else {
204			return $block['orig'];
205			}
206			}
207	2
208			$url = $block['url'];
209			$text = $this->renderAbsy($block['text']);
210			if (strpos($url, '://') === false) {
211			// consider all non absolute links as relative in the document
212			// $title is ignored in this case.
213			if (isset($url[0]) && $url[0] === '#') {
214	2		$url = $this->labelPrefix . $url;
215			}
216	2		return '\hyperref['.str_replace('#', '::', $url).']{' . $text . '}';
217			} else {
218			if ($this->linkStyle === self::LINK_STYLE_HREF) {
219			return '\href{' . $this->escapeUrl($url) . '}{' . $text . '}';
220			}
221			return $text . '\\footnote{' . (empty($block['title']) ? '' : $this->escapeLatex($block['title']) . ': ') . '\url{' . $this->escapeUrl($url) . '}}';
222			}
223			}
224
225			/**
226	2		* @inheritdoc
227	2		*/
228	2		protected function renderImage($block)
229	2		{
230	2	View Code Duplication	if (isset($block['refkey'])) {
			0 ignored issues – show Duplication introduced 2016-08-22 12:56 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
231	2		if (($ref = $this->lookupReference($block['refkey'])) !== false) {
232	2		$block = array_merge($block, $ref);
233	2		} else {
234	2		return $block['orig'];
235			}
236			}
237
238			// TODO create figure with caption with title
239			$replaces = [
240	2		'%' => '\\%',
241			'{' => '\\%7B',
242	2		'}' => '\\%7D',
243			'\\' => '\\\\',
244	2		'#' => '\\#',
245			'$' => '\\%24',
246	2		];
247	2		$url = str_replace(array_keys($replaces), array_values($replaces), $block['url']);
248	2		return "\\noindent\\includegraphics[width=\\textwidth]{{$url}}";
249			}
250
251			/**
252			* Parses <a name="..."></a> tags as reference labels
253			*/
254			private function parseInlineHtml($text)
255			{
256			if (strpos($text, '>') !== false) {
257	2		// convert a name markers to \labels
258			if (preg_match('~^<((a\|span)) (name\|id)="(.?)">.?</\1>~i', $text, $matches)) {
259	2		return [
260			['label', 'name' => str_replace('#', '::', $this->labelPrefix . $matches[4])],
261			strlen($matches[0])
262			];
263			}
264			}
265	2		return [['text', '<'], 1];
266			}
267	2
268	2		/**
269			* renders a reference label
270			*/
271			protected function renderLabel($block)
272			{
273			return "\\label{{$block['name']}}";
274	2		}
275
276	2		/**
277			* @inheritdoc
278			*/
279			protected function renderEmail($block)
280			{
281			$email = $this->escapeUrl($block[1]);
282	1		return "\\href{mailto:{$email}}{{$email}}";
283			}
284
285	1		/**
286			* @inheritdoc
287	1		*/
288	1		protected function renderUrl($block)
289			{
290			return '\url{' . $this->escapeUrl($block[1]) . '}';
291			}
292
293			/**
294			* @inheritdoc
295			*/
296			protected function renderInlineCode($block)
297	1		{
298			// replace No-Break Space characters in code block, which do not render in LaTeX
299	1		$content = preg_replace("/[\x{00a0}\x{202f}]/u", ' ', $block[1]);
300
301			if (strpos($content, '\|') !== false) {
302			return '\\lstinline`' . str_replace("\n", ' ', $content) . '`'; // TODO make this more robust against code containing backticks
303			} else {
304			return '\\lstinline\|' . str_replace("\n", ' ', $content) . '\|';
305	1		}
306			}
307	1
308			/**
309			* @inheritdoc
310			*/
311			protected function renderStrong($block)
312			{
313			return '\textbf{' . $this->renderAbsy($block[1]) . '}';
314			}
315	1
316			/**
317	1		* @inheritdoc
318	1		*/
319			protected function renderEmph($block)
320			{
321	1		return '\textit{' . $this->renderAbsy($block[1]) . '}';
322			}
323
324			/**
325			* Parses escaped special characters.
326			* This allow a backslash to be interpreted as LaTeX
327			* @marker \
328			*/
329			protected function parseEscape($text)
330			{
331			if (isset($text[1]) && in_array($text[1], $this->escapeCharacters)) {
332			if ($text[1] === '\\') {
333			return [['backslash'], 2];
			0 ignored issues – show Best Practice introduced 2016-08-22 12:56 UTC by Report Bug Copy Issue Report The expression `return array(array('backslash'), 2);` seems to be an `array`, but some of its elements' types (`string[]`) are incompatible with the return type of the parent method `cebe\markdown\Parser::parseEscape` of type `array<array\|integer>`. 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 new Author('Johannes'); } } class BlogPost extends Post { public function getAuthor() { return '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...
334			}
335			return [['text', $text[1]], 2];
336	4		}
337			return [['text', $text[0]], 1];
338	4		}
339
340			protected function renderBackslash()
341			{
342			return '\\';
343			}
344	21
345			private $_escaper;
346	21
347	21		/**
348	21		* Escape special characters in URLs
349	21		*/
350			protected function escapeUrl($string)
351			{
352			return str_replace('%', '\\%', $this->escapeLatex($string));
353			}
354
355			/**
356			* Escape special LaTeX characters
357	21		*/
358			protected function escapeLatex($string)
359	21		{
360			if ($this->_escaper === null) {
361	21		$this->_escaper = new TextToLatex();
362			}
363			return $this->_escaper->convert($string);
364			}
365	21
366	21		/**
367			* @inheritdocs
368			*
369	1		* Parses a newline indicated by two spaces on the end of a markdown line.
370			*/
371			protected function renderText($text)
372			{
373			$output = str_replace(" \n", "\\\\\n", $this->escapeLatex($text[1]));
374			// support No-Break Space in LaTeX
375			$output = preg_replace("/\x{00a0}/u", '~', $output);
376			// support Narrow No-Break Space spaces in LaTeX
377			// http://unicode-table.com/en/202F/
378			// http://tex.stackexchange.com/questions/76132/how-to-typeset-a-small-non-breaking-space
379			$output = preg_replace("/\x{202f}/u", '\nobreak\hspace{.16667em plus .08333em}', $output);
380			return $output;
381			}
382			}
383

cebe / markdown-latex