PatternTrait::setPatternFacet() - Code Metrics - Inspection of "Get Tests Passing" - Algo-Web/xsdTypes - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#28)

by Christopher

created 2017-07-14 09:41 UTC

PatternTrait::setPatternFacet() A

↳ Parent: PatternTrait

Complexity

Conditions	4
Paths	6

Size

Total Lines	15
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	15
rs	9.2
cc	4
eloc	10
nc	6
nop	2

<?php
namespace AlgoWeb\xsdTypes\Facets;

trait PatternTrait
{
    use XMLPatterns;
    /**
     * @Exclude
     * @var array defines the exact sequence of characters that are acceptable
     */
    public $pattern = array();

    /**
     * @param string $newPatternToAdd
     * @param mixed  $processMultiCharacterEscape
     */
    protected function setPatternFacet($newPatternToAdd, $processMultiCharacterEscape = true)
    {
        if (null == self::$Letter) {
            self::init();
        }
        $newPatternToAdd = $this->processRegex($newPatternToAdd, $processMultiCharacterEscape);

        if (!$this->checkRegexValidPattern($newPatternToAdd)) {
            $newPatternToAdd = '/' . $newPatternToAdd . '/u';

            if (!$this->checkRegexValidPattern($newPatternToAdd)) {
                throw new \InvalidArgumentException('Invalid regex pattern provided: ' . get_class($this) .
                    'pattern is: ' . $newPatternToAdd);
            }
        }
        $this->pattern[] = $newPatternToAdd;
    }

    /**
     * @param string $patternToProcess
     * @param bool   $processMultiCharacterEscape
     *
     * @return string
     */
    private function processRegex($patternToProcess, $processMultiCharacterEscape)
    {
        if (!$processMultiCharacterEscape) {
            return $patternToProcess;
        }
        if (null == self::$NameChar) {
            init();
        }
        $patternToProcess = $this->processRegexSlashS($patternToProcess);

        $patternToProcess = $this->processRegexSlashI($patternToProcess);

        $patternToProcess = $this->processRegexSlashC($patternToProcess);

        $patternToProcess = $this->processRegexSlashD($patternToProcess);

        $patternToProcess = $this->processRegexSlashW($patternToProcess);

        return $patternToProcess;
    }

    /**
     * @param string $patternToProcess
     *
     * @return string
     */
    private function processRegexSlashS($patternToProcess)

    {
        // Any character except those matched by '\s'.
        $patternToProcess = str_replace('\S', '[^\s]', $patternToProcess);

        // Whitespace, specifically '&#20;' (space), '\t' (tab), '\n' (newline) and '\r' (return).

        $patternToProcess = str_replace('\s', '([\x{20}\t\n\r])', $patternToProcess);

        return $patternToProcess;
    }

    /**
     * @param string $patternToProcess
     *
     * @return string
     */
    private function processRegexSlashI($patternToProcess)
    {
        // Any character except those matched by '\i'.
        $patternToProcess = str_replace('\I', '[^\i]', $patternToProcess);

        // The first character in an XML identifier. Specifically, any letter, the character '_', or the character ':',
        // See the XML Recommendation for the complex specification of a letter. This character represents a subset of
        // letter that might appear in '\c'.
        $patternToProcess = str_replace('\i-[:]', self::$Letter . '|_| ', $patternToProcess);

        $patternToProcess = str_replace('\i', '(' . self::$Letter . '|_|:)', $patternToProcess);

        return $patternToProcess;
    }

    /**
     * @param string $patternToProcess
     *
     * @return string
     */
    private function processRegexSlashC($patternToProcess)
    {
        // Any character except those matched by '\c'.
        $patternToProcess = str_replace('\C', '[^\c]', $patternToProcess);

        // Any character that might appear in the built-in NMTOKEN datatype.
        // See the XML Recommendation for the complex specification of a NameChar.
        $patternToProcess = str_replace('\c-[:]', self::$Letter . '|' . self::$Digit . '|.|-|_|' . self::$CombiningChar . '|'

            . self::$Extender, $patternToProcess);
        $patternToProcess = str_replace('\c', '(' . self::$NameChar . ')', $patternToProcess);

        return $patternToProcess;

    }

    /**
     * @param string $patternToProcess
     *
     * @return string
     */
    private function processRegexSlashD($patternToProcess)

    {
        // Any character except those matched by '\d'.
        $patternToProcess = str_replace('\D', '[^(\d)]', $patternToProcess);

        // Any Decimal digit. A shortcut for '\p{Nd}'.
        $patternToProcess = str_replace('\d', '\p{Nd)', $patternToProcess);

        return $patternToProcess;
    }

    /**
     * @param string $patternToProcess
     *
     * @return string
     */
    private function processRegexSlashW($patternToProcess)

    {
        // Any character except those matched by '\w'.
        $patternToProcess = str_replace('\W', '[^\w]', $patternToProcess);

        // Any character that might appear in a word. A shortcut for '[#X0000-#x10FFFF]-[\p{P}\p{Z}\p{C}]'
        // (all characters except the set of "punctuation", "separator", and "other" characters).
        $patternToProcess = str_replace('\w', '([\x{0000}-\x{10FFFF}]-[\p{P}\p{Z}\p{C}])',

            $patternToProcess);
        return $patternToProcess;

    }

    /**
     * @param string $pattern
     *
     * @return bool
     */
    private function checkRegexValidPattern($pattern)
    {
        return !(false === @preg_match($pattern, null));
    }

    /**
     * @param string $v
     */
    private function checkPattern($v)
    {
        if (!empty($this->pattern)) {
            foreach ($this->pattern as $pattern) {
                if (!$this->matchesRegexPattern($pattern, $v)) {
                    throw new \InvalidArgumentException('Assigned value for ' . get_class($this) .
                        ' does not match pattern ' . $pattern);
                }
            }
        }
    }

    /**
     * Checks a pattern against a string.
     *
     * @param  string $pattern the regex pattern
     * @param  string $string  the string to check
     * @return bool   true if string matches pattern
     */
    private function matchesRegexPattern($pattern, $string)
    {
        $matches = null;
        return (1 == preg_match($pattern, $string, $matches) && $string == $matches[0]);
    }
}


1		<?php
2		namespace AlgoWeb\xsdTypes\Facets;
3
4		trait PatternTrait
5		{
6		use XMLPatterns;
7		/**
8		* @Exclude
9		* @var array defines the exact sequence of characters that are acceptable
10		*/
11		public $pattern = array();
12
13		/**
14		* @param string $newPatternToAdd
15		* @param mixed $processMultiCharacterEscape
16		*/
17		protected function setPatternFacet($newPatternToAdd, $processMultiCharacterEscape = true)
18		{
19		if (null == self::$Letter) {
20		self::init();
21		}
22		$newPatternToAdd = $this->processRegex($newPatternToAdd, $processMultiCharacterEscape);
		0 ignored issues – show Coding Style introduced 2017-07-07 07:43 UTC by Report Bug Copy Issue Report Consider using a different name than the parameter `$newPatternToAdd`. This often makes code more readable. Loading history...
23		if (!$this->checkRegexValidPattern($newPatternToAdd)) {
24		$newPatternToAdd = '/' . $newPatternToAdd . '/u';
		0 ignored issues – show Coding Style introduced 2017-07-07 07:43 UTC by Report Bug Copy Issue Report Consider using a different name than the parameter `$newPatternToAdd`. This often makes code more readable. Loading history...
25		if (!$this->checkRegexValidPattern($newPatternToAdd)) {
26		throw new \InvalidArgumentException('Invalid regex pattern provided: ' . get_class($this) .
27		'pattern is: ' . $newPatternToAdd);
28		}
29		}
30		$this->pattern[] = $newPatternToAdd;
31		}
32
33		/**
34		* @param string $patternToProcess
35		* @param bool $processMultiCharacterEscape
36		*
37		* @return string
38		*/
39		private function processRegex($patternToProcess, $processMultiCharacterEscape)
40		{
41		if (!$processMultiCharacterEscape) {
42		return $patternToProcess;
43		}
44		if (null == self::$NameChar) {
45		init();
46		}
47		$patternToProcess = $this->processRegexSlashS($patternToProcess);
		1 ignored issue – show Coding Style introduced 2017-07-14 07:48 UTC by Report Bug Copy Issue Report Consider using a different name than the parameter `$patternToProcess`. This often makes code more readable. Loading history...
48		$patternToProcess = $this->processRegexSlashI($patternToProcess);
		1 ignored issue – show Coding Style introduced 2017-07-14 07:48 UTC by Report Bug Copy Issue Report Consider using a different name than the parameter `$patternToProcess`. This often makes code more readable. Loading history...
49		$patternToProcess = $this->processRegexSlashC($patternToProcess);
		1 ignored issue – show Coding Style introduced 2017-07-14 07:48 UTC by Report Bug Copy Issue Report Consider using a different name than the parameter `$patternToProcess`. This often makes code more readable. Loading history...
50		$patternToProcess = $this->processRegexSlashD($patternToProcess);
		1 ignored issue – show Coding Style introduced 2017-07-14 07:48 UTC by Report Bug Copy Issue Report Consider using a different name than the parameter `$patternToProcess`. This often makes code more readable. Loading history...
51		$patternToProcess = $this->processRegexSlashW($patternToProcess);
		1 ignored issue – show Coding Style introduced 2017-07-14 07:48 UTC by Report Bug Copy Issue Report Consider using a different name than the parameter `$patternToProcess`. This often makes code more readable. Loading history...
52		return $patternToProcess;
53		}
54
55		/**
56		* @param string $patternToProcess
57		*
58		* @return string
59		*/
60	View Code Duplication	private function processRegexSlashS($patternToProcess)
		1 ignored issue – show Duplication introduced 2017-07-14 07:48 UTC by Report Bug Copy Issue Report 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...
61		{
62		// Any character except those matched by '\s'.
63		$patternToProcess = str_replace('\S', '[^\s]', $patternToProcess);
		0 ignored issues – show Coding Style introduced 2017-07-07 07:43 UTC by Report Bug Copy Issue Report Consider using a different name than the parameter `$patternToProcess`. This often makes code more readable. Loading history...
64		// Whitespace, specifically '' (space), '\t' (tab), '\n' (newline) and '\r' (return).
		1 ignored issue – show Unused Code Comprehensibility introduced 2017-07-14 07:48 UTC by Report Bug Copy Issue Report `50%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
65		$patternToProcess = str_replace('\s', '([\x{20}\t\n\r])', $patternToProcess);
		0 ignored issues – show Coding Style introduced 2017-07-07 07:43 UTC by Report Bug Copy Issue Report Consider using a different name than the parameter `$patternToProcess`. This often makes code more readable. Loading history...
66		return $patternToProcess;
67		}
68
69		/**
70		* @param string $patternToProcess
71		*
72		* @return string
73		*/
74		private function processRegexSlashI($patternToProcess)
75		{
76		// Any character except those matched by '\i'.
77		$patternToProcess = str_replace('\I', '[^\i]', $patternToProcess);
		0 ignored issues – show Coding Style introduced 2017-07-07 07:43 UTC by Report Bug Copy Issue Report Consider using a different name than the parameter `$patternToProcess`. This often makes code more readable. Loading history...
78		// The first character in an XML identifier. Specifically, any letter, the character '_', or the character ':',
79		// See the XML Recommendation for the complex specification of a letter. This character represents a subset of
80		// letter that might appear in '\c'.
81		$patternToProcess = str_replace('\i-[:]', self::$Letter . '\|_\| ', $patternToProcess);
		0 ignored issues – show Coding Style introduced 2017-07-07 07:43 UTC by Report Bug Copy Issue Report Consider using a different name than the parameter `$patternToProcess`. This often makes code more readable. Loading history...
82		$patternToProcess = str_replace('\i', '(' . self::$Letter . '\|_\|:)', $patternToProcess);
		0 ignored issues – show Coding Style introduced 2017-07-07 07:43 UTC by Report Bug Copy Issue Report Consider using a different name than the parameter `$patternToProcess`. This often makes code more readable. Loading history...
83		return $patternToProcess;
84		}
85
86		/**
87		* @param string $patternToProcess
88		*
89		* @return string
90		*/
91		private function processRegexSlashC($patternToProcess)
92		{
93		// Any character except those matched by '\c'.
94		$patternToProcess = str_replace('\C', '[^\c]', $patternToProcess);
		0 ignored issues – show Coding Style introduced 2017-07-07 07:43 UTC by Report Bug Copy Issue Report Consider using a different name than the parameter `$patternToProcess`. This often makes code more readable. Loading history...
95		// Any character that might appear in the built-in NMTOKEN datatype.
96		// See the XML Recommendation for the complex specification of a NameChar.
97		$patternToProcess = str_replace('\c-[:]', self::$Letter . '\|' . self::$Digit . '\|.\|-\|_\|' . self::$CombiningChar . '\|'
		2 ignored issues – show Coding Style introduced 2017-07-14 08:19 UTC by Report Bug Copy Issue Report Consider using a different name than the parameter `$patternToProcess`. This often makes code more readable. Loading history... Coding Style introduced 2017-07-14 08:19 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 125 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
98		. self::$Extender, $patternToProcess);
99		$patternToProcess = str_replace('\c', '(' . self::$NameChar . ')', $patternToProcess);
		1 ignored issue – show Coding Style introduced 2017-07-14 08:19 UTC by Report Bug Copy Issue Report Consider using a different name than the parameter `$patternToProcess`. This often makes code more readable. Loading history...
100		return $patternToProcess;
101
102		}
103
104		/**
105		* @param string $patternToProcess
106		*
107		* @return string
108		*/
109	View Code Duplication	private function processRegexSlashD($patternToProcess)
		1 ignored issue – show Duplication introduced 2017-07-14 07:48 UTC by Report Bug Copy Issue Report 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...
110		{
111		// Any character except those matched by '\d'.
112		$patternToProcess = str_replace('\D', '[^(\d)]', $patternToProcess);
		0 ignored issues – show Coding Style introduced 2017-07-07 07:43 UTC by Report Bug Copy Issue Report Consider using a different name than the parameter `$patternToProcess`. This often makes code more readable. Loading history...
113		// Any Decimal digit. A shortcut for '\p{Nd}'.
114		$patternToProcess = str_replace('\d', '\p{Nd)', $patternToProcess);
		0 ignored issues – show Coding Style introduced 2017-07-07 07:43 UTC by Report Bug Copy Issue Report Consider using a different name than the parameter `$patternToProcess`. This often makes code more readable. Loading history...
115		return $patternToProcess;
116		}
117
118		/**
119		* @param string $patternToProcess
120		*
121		* @return string
122		*/
123	View Code Duplication	private function processRegexSlashW($patternToProcess)
		1 ignored issue – show Duplication introduced 2017-07-14 07:48 UTC by Report Bug Copy Issue Report 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...
124		{
125		// Any character except those matched by '\w'.
126		$patternToProcess = str_replace('\W', '[^\w]', $patternToProcess);
		1 ignored issue – show Coding Style introduced 2017-07-14 07:48 UTC by Report Bug Copy Issue Report Consider using a different name than the parameter `$patternToProcess`. This often makes code more readable. Loading history...
127		// Any character that might appear in a word. A shortcut for '[#X0000-#x10FFFF]-[\p{P}\p{Z}\p{C}]'
128		// (all characters except the set of "punctuation", "separator", and "other" characters).
129		$patternToProcess = str_replace('\w', '([\x{0000}-\x{10FFFF}]-[\p{P}\p{Z}\p{C}])',
		1 ignored issue – show Coding Style introduced 2017-07-14 07:48 UTC by Report Bug Copy Issue Report Consider using a different name than the parameter `$patternToProcess`. This often makes code more readable. Loading history...
130		$patternToProcess);
131		return $patternToProcess;
132
133		}
134
135		/**
136		* @param string $pattern
137		*
138		* @return bool
139		*/
140		private function checkRegexValidPattern($pattern)
141		{
142		return !(false === @preg_match($pattern, null));
143		}
144
145		/**
146		* @param string $v
147		*/
148		private function checkPattern($v)
149		{
150		if (!empty($this->pattern)) {
151		foreach ($this->pattern as $pattern) {
152		if (!$this->matchesRegexPattern($pattern, $v)) {
153		throw new \InvalidArgumentException('Assigned value for ' . get_class($this) .
154		' does not match pattern ' . $pattern);
155		}
156		}
157		}
158		}
159
160		/**
161		* Checks a pattern against a string.
162		*
163		* @param string $pattern the regex pattern
164		* @param string $string the string to check
165		* @return bool true if string matches pattern
166		*/
167		private function matchesRegexPattern($pattern, $string)
168		{
169		$matches = null;
170		return (1 == preg_match($pattern, $string, $matches) && $string == $matches[0]);
171		}
172		}
173

Algo-Web / xsdTypes

Pull Request — master (#28)

PatternTrait::setPatternFacet() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like