AbstractCombinedRegexp::throwFailedMatchException() - Code Metrics - yiisoft/strings - Measure and Improve Code Quality continuously with Scrutinizer

throwFailedMatchException() A
last analyzed 2024-01-07 16:15 UTC

↳ Parent: AbstractCombinedRegexp

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

<?php

declare(strict_types=1);

namespace Yiisoft\Strings;

use Exception;

use function sprintf;

/**
 * `CombinedRegexp` optimizes matching of multiple regular expressions.
 * Read more about the concept in
 * {@see https://nikic.github.io/2014/02/18/Fast-request-routing-using-regular-expressions.html}.
 */
abstract class AbstractCombinedRegexp
{
    public const REGEXP_DELIMITER = '/';
    public const QUOTE_REPLACER = '\\/';

    /**
     * @return string[] Regular expressions to combine.
     */
    abstract public function getPatterns(): array;

    /**
     * @return string Flags to apply to all regular expressions.
     */
    abstract public function getFlags(): string;

    /**
     * @return string The compiled pattern.
     */
    abstract public function getCompiledPattern(): string;

    /**
     * Returns `true` whether the given string matches any of the patterns, `false` - otherwise.
     */
    abstract public function matches(string $string): bool;

    /**
     * Returns pattern that matches the given string.
     * @throws Exception if the string does not match any of the patterns.
     */
    abstract public function getMatchingPattern(string $string): string;

    /**
     * Returns position of the pattern that matches the given string.
     * @throws Exception if the string does not match any of the patterns.
     */
    abstract public function getMatchingPatternPosition(string $string): int;

    /**
     * @throws Exception
     * @return never-return

     */
    protected function throwFailedMatchException(string $string): void
    {
        throw new Exception(
            sprintf(
                'Failed to match pattern "%s" with string "%s".',
                $this->getCompiledPattern(),
                $string,
            )
        );
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Strings;
6
7		use Exception;
8
9		use function sprintf;
10
11		/**
12		* `CombinedRegexp` optimizes matching of multiple regular expressions.
13		* Read more about the concept in
14		* {@see https://nikic.github.io/2014/02/18/Fast-request-routing-using-regular-expressions.html}.
15		*/
16		abstract class AbstractCombinedRegexp
17		{
18		public const REGEXP_DELIMITER = '/';
19		public const QUOTE_REPLACER = '\\/';
20
21		/**
22		* @return string[] Regular expressions to combine.
23		*/
24		abstract public function getPatterns(): array;
25
26		/**
27		* @return string Flags to apply to all regular expressions.
28		*/
29		abstract public function getFlags(): string;
30
31		/**
32		* @return string The compiled pattern.
33		*/
34		abstract public function getCompiledPattern(): string;
35
36		/**
37		* Returns `true` whether the given string matches any of the patterns, `false` - otherwise.
38		*/
39		abstract public function matches(string $string): bool;
40
41		/**
42		* Returns pattern that matches the given string.
43		* @throws Exception if the string does not match any of the patterns.
44		*/
45		abstract public function getMatchingPattern(string $string): string;
46
47		/**
48		* Returns position of the pattern that matches the given string.
49		* @throws Exception if the string does not match any of the patterns.
50		*/
51		abstract public function getMatchingPatternPosition(string $string): int;
52
53		/**
54		* @throws Exception
55		* @return never-return
		0 ignored issues – show Documentation Bug introduced 2023-08-04 07:15 UTC by Report Bug Copy Issue Report The doc comment `never-return` at position `0` could not be parsed: Unknown type name 'never-return' at position 0 in never-return. Loading history...
56		*/
57	3	protected function throwFailedMatchException(string $string): void
58		{
59	3	throw new Exception(
60	3	sprintf(
61	3	'Failed to match pattern "%s" with string "%s".',
62	3	$this->getCompiledPattern(),
63	3	$string,
64	3	)
65	3	);
66		}
67		}
68

yiisoft / strings

throwFailedMatchException() A last analyzed 2024-01-07 16:15 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

throwFailedMatchException() A
last analyzed 2024-01-07 16:15 UTC