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

Completed

Pull Request — master (#179)

unknown

created 2019-11-01 02:19 UTC

Configuration::checkForDeprecatedOptions() A

↳ Parent: Configuration

Complexity

Conditions	6
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	6

Importance

Changes

Metric	Value
dl	0
loc	10
ccs	7
cts	7
cp	1
rs	9.2222
c	0
b	0
f	0
cc	6
nc	4
nop	1
crap	6

<?php

namespace League\HTMLToMarkdown;

class Configuration
{
    protected $config;

    /**
     * @param array $config
     */
    public function __construct(array $config = array())
    {
        $this->config = $config;

        $this->checkForDeprecatedOptions($config);
    }

    /**
     * @param array $config
     */
    public function merge(array $config = array())
    {
        $this->checkForDeprecatedOptions($config);
        $this->config = array_replace_recursive($this->config, $config);
    }

    /**
     * @param array $config
     */
    public function replace(array $config = array())
    {
        $this->checkForDeprecatedOptions($config);
        $this->config = $config;
    }

    /**
     * @param string $key
     * @param mixed  $value
     */
    public function setOption($key, $value)
    {
        $this->checkForDeprecatedOptions(array($key => $value));
        $this->config[$key] = $value;
    }

    /**
     * @param string|null $key
     * @param mixed|null  $default
     *
     * @return mixed|null
     */
    public function getOption($key = null, $default = null)
    {
        if ($key === null) {
            return $this->config;
        }

        if (!isset($this->config[$key])) {
            return $default;
        }

        return $this->config[$key];
    }

    private function checkForDeprecatedOptions(array $config)
    {
        foreach ($config as $key => $value) {
            if ($key === 'bold_style' && $value !== '**') {
                @trigger_error('Customizing the bold_style option is deprecated and may be removed in the next major version', E_USER_DEPRECATED);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
            } elseif ($key === 'italic_style' && $value !== '*') {
                @trigger_error('Customizing the italic_style option is deprecated and may be removed in the next major version', E_USER_DEPRECATED);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
            }
        }
    }
}


1		<?php
2
3		namespace League\HTMLToMarkdown;
4
5		class Configuration
6		{
7		protected $config;
8
9		/**
10		* @param array $config
11		*/
12	93	public function __construct(array $config = array())
13		{
14	93	$this->config = $config;
15
16	93	$this->checkForDeprecatedOptions($config);
17	93	}
18
19		/**
20		* @param array $config
21		*/
22	87	public function merge(array $config = array())
23		{
24	87	$this->checkForDeprecatedOptions($config);
25	87	$this->config = array_replace_recursive($this->config, $config);
26	87	}
27
28		/**
29		* @param array $config
30		*/
31		public function replace(array $config = array())
32		{
33		$this->checkForDeprecatedOptions($config);
34		$this->config = $config;
35		}
36
37		/**
38		* @param string $key
39		* @param mixed $value
40		*/
41	6	public function setOption($key, $value)
42		{
43	6	$this->checkForDeprecatedOptions(array($key => $value));
44	6	$this->config[$key] = $value;
45	6	}
46
47		/**
48		* @param string\|null $key
49		* @param mixed\|null $default
50		*
51		* @return mixed\|null
52		*/
53	87	public function getOption($key = null, $default = null)
54		{
55	87	if ($key === null) {
56		return $this->config;
57		}
58
59	87	if (!isset($this->config[$key])) {
60	12	return $default;
61		}
62
63	84	return $this->config[$key];
64		}
65
66	93	private function checkForDeprecatedOptions(array $config)
67		{
68	93	foreach ($config as $key => $value) {
69	87	if ($key === 'bold_style' && $value !== '**') {
70	3	@trigger_error('Customizing the bold_style option is deprecated and may be removed in the next major version', E_USER_DEPRECATED);
		0 ignored issues – show Security Best Practice introduced 2018-09-18 00:36 UTC by Report Bug Copy Issue Report 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...
71	87	} elseif ($key === 'italic_style' && $value !== '*') {
72	31	@trigger_error('Customizing the italic_style option is deprecated and may be removed in the next major version', E_USER_DEPRECATED);
		0 ignored issues – show Security Best Practice introduced 2018-09-18 00:36 UTC by Report Bug Copy Issue Report 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...
73		}
74		}
75	93	}
76		}
77

thephpleague / html-to-markdown

Pull Request — master (#179)

Configuration::checkForDeprecatedOptions() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like