Rules::__construct() - Code Metrics - Inspection of "Rework Scrutinizer config" - kadet1090/KeyLighter - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Branch — master (f3f280)

by Maciej

created 2020-04-09 14:05 UTC

Rules::__construct() A

↳ Parent: Rules

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	2
nc	1
nop	1
dl	0
loc	5
ccs	3
cts	3
cp	1
crap	1
rs	10
c	1
b	0
f	0

<?php

/**
 * Highlighter
 *
 * Copyright (C) 2016, Some right reserved.
 *
 * @author Kacper "Kadet" Donat <[email protected]>
 *
 * Contact with author:
 * Xmpp: [email protected]
 * E-mail: [email protected]
 *
 * From Kadet with love.
 */

namespace Kadet\Highlighter\Parser;

use Kadet\Highlighter\Exceptions\NameConflictException;
use Kadet\Highlighter\Exceptions\NoSuchElementException;
use Kadet\Highlighter\Language\Language;
use Kadet\Highlighter\Parser\Validator\Validator;

class Rules extends \ArrayObject
{
    /** @var Language Default language assigned to added rules. */
    private $_language;

    /** @var Validator Default validator used in added rules. */
    public $validator;

    private function _getName($name, $prefix)
    {
        if (is_int($name)) {
            return $prefix;
        } else {
            return $prefix ? "$prefix.$name" : $name;
        }
    }

    /**
     * Rules constructor.
     *
     * @param Language $language
     */
    public function __construct($language)
    {
        $this->_language = $language;

        $this->validator = new Validator();
    }

    /**
     * Adds array of rules
     *
     * @param array       $rules
     * @param string|null $prefix
     *
     * @throws \LogicException
     */
    public function addMany(array $rules, $prefix = null)
    {
        foreach ($rules as $type => $rule) {
            $type = $this->_getName($type, $prefix);

            if ($rule instanceof Rule) {
                $this->add($type, $rule);
            } elseif (is_array($rule)) {
                $this->addMany($rule, $type);
            } else {
                throw new \LogicException('Array values has to be either arrays of rules or rules.');
            }
        }
    }

    /**
     * Adds one rule
     *
     * @param string $type
     * @param Rule   $rule
     *
     * @throws NameConflictException When there is already defined rule with given name.
     */
    public function add($type, Rule $rule)
    {
        if (!isset($this[$type])) {
            $this[$type] = [];
        }

        if ($rule->language === false) {

            $rule->language = $this->_language;
        }

        if ($rule->validator === false) {

            $rule->validator = $this->validator;
        }

        $rule->factory->setBase($type);

        if ($rule->name !== null) {
            if (isset($this[$type][$rule->name])) {
                throw new NameConflictException("Rule with '{$rule->name}' is already defined, name has to be unique!");
            }

            $this[$type][$rule->name] = $rule;
            return;
        }

        $this[$type][] = $rule;
    }

    /**
     * Return reference to rule of given type and index.
     *
     * @param string $type
     * @param mixed  $index
     *
     * @return \Kadet\Highlighter\Parser\Rule
     */
    public function &rule($type, $index = 0)
    {
        return $this[$type][$index];
    }

    /**
     * Retrieves all rules of given type.
     *
     * @param $type
     *
     * @return Rule[]
     * @throws NoSuchElementException
     */
    public function rules($type)
    {
        if (!isset($this[$type])) {
            throw new NoSuchElementException("There isn't any rule of '$type' type.");
        }

        return $this[$type];
    }

    /**
     * Replaces rule of given type and index with provided one.
     *
     * @param Rule $replacement
     * @param      $type
     * @param int  $index
     */
    public function replace(Rule $replacement, $type, $index = 0)
    {
        $current = $this->rule($type, $index);
        if ($current->name !== null) {
            $replacement->name = $current->name;
        }

        $this[$type][$index] = $replacement;
    }

    /**
     * Removes rule of given type and index.
     *
     * @param string $type
     * @param mixed  $index
     *
     * @throws NoSuchElementException
     */
    public function remove($type, $index = null)
    {
        if ($index === null) {
            unset($this[$type]);
            return;
        }

        if (!isset($this[$type][$index])) {
            throw new NoSuchElementException("There is no rule '$type' type indexed by '$index'.");
        }

        unset($this[$type][$index]);
    }

    /**
     * Retrieves all rule set.
     *
     * @return Rule[]
     */
    public function all()
    {
        $items = $this->getArrayCopy();
        if (empty($items)) {
            return [];
        }

        return call_user_func_array('array_merge', $items);
    }

    /**
     * @return Language
     */
    public function getLanguage()
    {
        return $this->_language;
    }

    /**
     * @param Language $language
     */
    public function setLanguage(Language $language = null)
    {
        $this->_language = $language;
    }
}


1		<?php
2
3		/**
4		* Highlighter
5		*
6		* Copyright (C) 2016, Some right reserved.
7		*
8		* @author Kacper "Kadet" Donat <[email protected]>
9		*
10		* Contact with author:
11		* Xmpp: [email protected]
12		* E-mail: [email protected]
13		*
14		* From Kadet with love.
15		*/
16
17		namespace Kadet\Highlighter\Parser;
18
19		use Kadet\Highlighter\Exceptions\NameConflictException;
20		use Kadet\Highlighter\Exceptions\NoSuchElementException;
21		use Kadet\Highlighter\Language\Language;
22		use Kadet\Highlighter\Parser\Validator\Validator;
23
24		class Rules extends \ArrayObject
25		{
26		/** @var Language Default language assigned to added rules. */
27		private $_language;
28
29		/** @var Validator Default validator used in added rules. */
30		public $validator;
31
32	40	private function _getName($name, $prefix)
33		{
34	40	if (is_int($name)) {
35	7	return $prefix;
36		} else {
37	40	return $prefix ? "$prefix.$name" : $name;
38		}
39		}
40
41		/**
42		* Rules constructor.
43		*
44		* @param Language $language
45		*/
46	39	public function __construct($language)
47		{
48	39	$this->_language = $language;
49
50	39	$this->validator = new Validator();
51	39	}
52
53		/**
54		* Adds array of rules
55		*
56		* @param array $rules
57		* @param string\|null $prefix
58		*
59		* @throws \LogicException
60		*/
61	55	public function addMany(array $rules, $prefix = null)
62		{
63	55	foreach ($rules as $type => $rule) {
64	40	$type = $this->_getName($type, $prefix);
65
66	40	if ($rule instanceof Rule) {
67	39	$this->add($type, $rule);
68	8	} elseif (is_array($rule)) {
69	7	$this->addMany($rule, $type);
70		} else {
71	40	throw new \LogicException('Array values has to be either arrays of rules or rules.');
72		}
73		}
74	54	}
75
76		/**
77		* Adds one rule
78		*
79		* @param string $type
80		* @param Rule $rule
81		*
82		* @throws NameConflictException When there is already defined rule with given name.
83		*/
84	43	public function add($type, Rule $rule)
85		{
86	43	if (!isset($this[$type])) {
87	41	$this[$type] = [];
88		}
89
90	43	if ($rule->language === false) {
		0 ignored issues – show introduced 2020-04-08 21:47 UTC by Report Bug Copy Issue Report The condition `$rule->language === false` is always `false`. Loading history...
91	20	$rule->language = $this->_language;
92		}
93
94	43	if ($rule->validator === false) {
		0 ignored issues – show introduced 2020-04-08 21:47 UTC by Report Bug Copy Issue Report The condition `$rule->validator === false` is always `false`. Loading history...
95	20	$rule->validator = $this->validator;
96		}
97
98	43	$rule->factory->setBase($type);
99
100	43	if ($rule->name !== null) {
101	2	if (isset($this[$type][$rule->name])) {
102	1	throw new NameConflictException("Rule with '{$rule->name}' is already defined, name has to be unique!");
103		}
104
105	2	$this[$type][$rule->name] = $rule;
106	2	return;
107		}
108
109	41	$this[$type][] = $rule;
110	41	}
111
112		/**
113		* Return reference to rule of given type and index.
114		*
115		* @param string $type
116		* @param mixed $index
117		*
118		* @return \Kadet\Highlighter\Parser\Rule
119		*/
120	3	public function &rule($type, $index = 0)
121		{
122	3	return $this[$type][$index];
123		}
124
125		/**
126		* Retrieves all rules of given type.
127		*
128		* @param $type
129		*
130		* @return Rule[]
131		* @throws NoSuchElementException
132		*/
133	2	public function rules($type)
134		{
135	2	if (!isset($this[$type])) {
136	1	throw new NoSuchElementException("There isn't any rule of '$type' type.");
137		}
138
139	1	return $this[$type];
140		}
141
142		/**
143		* Replaces rule of given type and index with provided one.
144		*
145		* @param Rule $replacement
146		* @param $type
147		* @param int $index
148		*/
149	1	public function replace(Rule $replacement, $type, $index = 0)
150		{
151	1	$current = $this->rule($type, $index);
152	1	if ($current->name !== null) {
153		$replacement->name = $current->name;
154		}
155
156	1	$this[$type][$index] = $replacement;
157	1	}
158
159		/**
160		* Removes rule of given type and index.
161		*
162		* @param string $type
163		* @param mixed $index
164		*
165		* @throws NoSuchElementException
166		*/
167	2	public function remove($type, $index = null)
168		{
169	2	if ($index === null) {
170	1	unset($this[$type]);
171	1	return;
172		}
173
174	2	if (!isset($this[$type][$index])) {
175	1	throw new NoSuchElementException("There is no rule '$type' type indexed by '$index'.");
176		}
177
178	1	unset($this[$type][$index]);
179	1	}
180
181		/**
182		* Retrieves all rule set.
183		*
184		* @return Rule[]
185		*/
186	37	public function all()
187		{
188	37	$items = $this->getArrayCopy();
189	37	if (empty($items)) {
190	1	return [];
191		}
192
193	37	return call_user_func_array('array_merge', $items);
194		}
195
196		/**
197		* @return Language
198		*/
199	1	public function getLanguage()
200		{
201	1	return $this->_language;
202		}
203
204		/**
205		* @param Language $language
206		*/
207	1	public function setLanguage(Language $language = null)
208		{
209	1	$this->_language = $language;
210	1	}
211		}
212

kadet1090 / KeyLighter

Branch — master (f3f280)

Rules::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like