CommentConverter::shouldPreserve() - Code Metrics - Inspection of "Added option to preserve comments (#179)" - thephpleague/html-to-markdown - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 63adb9...1faad8 )

by Colin

created 2019-11-02 14:29 UTC

CommentConverter::shouldPreserve() A

↳ Parent: CommentConverter

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	3

Importance

Changes

Metric	Value
dl	0
loc	12
ccs	8
cts	8
cp	1
rs	9.8666
c	0
b	0
f	0
cc	3
nc	3
nop	1
crap	3

<?php

namespace League\HTMLToMarkdown\Converter;

use League\HTMLToMarkdown\Configuration;
use League\HTMLToMarkdown\ConfigurationAwareInterface;
use League\HTMLToMarkdown\ElementInterface;

class CommentConverter implements ConverterInterface, ConfigurationAwareInterface
{
    /**
     * @var Configuration
     */
    protected $config;

    /**
     * @param Configuration $config
     */
    public function setConfig(Configuration $config)
    {
        $this->config = $config;
    }

    /**
     * @param ElementInterface $element
     *
     * @return string
     */
    public function convert(ElementInterface $element)
    {
        if ($this->shouldPreserve($element)) {
            return '<!--' . $element->getValue() . '-->';
        }
        return '';
    }

    /**
     * @return string[]
     */
    public function getSupportedTags()
    {
        return array('#comment');
    }

    /**
     * @param ElementInterface $element
     *
     * @return bool
     */
    private function shouldPreserve(ElementInterface $element)
    {
        $preserve = $this->config->getOption('preserve_comments');
        if ($preserve === true) {
            return true;
        }
        if (is_array($preserve)) {
            $value = trim($element->getValue());
            return in_array($value, $preserve);
        }
        return false;
    }
}


1		<?php
2
3		namespace League\HTMLToMarkdown\Converter;
4
5		use League\HTMLToMarkdown\Configuration;
6		use League\HTMLToMarkdown\ConfigurationAwareInterface;
7		use League\HTMLToMarkdown\ElementInterface;
8
9		class CommentConverter implements ConverterInterface, ConfigurationAwareInterface
10		{
11		/**
12		* @var Configuration
13		*/
14		protected $config;
15
16		/**
17		* @param Configuration $config
18		*/
19	90	public function setConfig(Configuration $config)
20		{
21	90	$this->config = $config;
22	90	}
23
24		/**
25		* @param ElementInterface $element
26		*
27		* @return string
28		*/
29	6	public function convert(ElementInterface $element)
30		{
31	6	if ($this->shouldPreserve($element)) {
32	3	return '<!--' . $element->getValue() . '-->';
33		}
34	6	return '';
35		}
36
37		/**
38		* @return string[]
39		*/
40	90	public function getSupportedTags()
41		{
42	90	return array('#comment');
43		}
44
45		/**
46		* @param ElementInterface $element
47		*
48		* @return bool
49		*/
50	6	private function shouldPreserve(ElementInterface $element)
51		{
52	6	$preserve = $this->config->getOption('preserve_comments');
53	6	if ($preserve === true) {
54	3	return true;
55		}
56	6	if (is_array($preserve)) {
57	3	$value = trim($element->getValue());
58	3	return in_array($value, $preserve);
59		}
60	3	return false;
61		}
62		}
63

thephpleague / html-to-markdown

Push — master ( 63adb9...1faad8 )

CommentConverter::shouldPreserve() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like