IntervalFinder::__construct() - Code Metrics - ekinhbayar/IntervalParser - Measure and Improve Code Quality continuously with Scrutinizer

IntervalFinder::__construct() A
last analyzed 2017-04-07 15:22 UTC

↳ Parent: IntervalFinder

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

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

<?php declare(strict_types = 1);
/**
 * Finds intervals inside strings
 *
 * PHP version 7+
 *
 * @category   IntervalParser
 * @author     Ekin H. Bayar <[email protected]>
 * @version    0.2.0
 */
namespace IntervalParser;

class IntervalFinder
{
    # Leading separator

    const LEADING_SEPARATOR = "(?<leadingSeparator>\s?(?:in)\s?)";
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;

    # Regex to match a valid interval and any trailing string, holds the interval in $matches['interval'], the rest in $matches['trailing']

    const INTERVAL_WITH_TRAILING_DATA = "^(?<interval>(?&timepart)++)(?<trailing>.+)*?$/uix";
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;

    # Regex to handle an input that may have multiple intervals along with leading and/or trailing data

    const MULTIPLE_INTERVALS = <<<'REGEX'
    ^(?<leading>.*?)?
     (?<sep>(?&leadingSeparator))?
     (?<interval>(?&timepart)++)
     (?<trailing>.*)
    /uix
REGEX;

    /**
     * @var ParserSettings
     */
    private $settings;

    /**
     * @var Normalizer
     */
    private $normalizer;

    /**
     * IntervalFinder constructor.
     *
     * Default settings are :
     *
     *  string $symbolSeparator  = ',',
     *  string $wordSeparator = null
     *
     * @param \IntervalParser\ParserSettings $settings
     * @param \IntervalParser\Normalizer $normalizer
     */
    public function __construct(ParserSettings $settings, Normalizer $normalizer)
    {
        $this->settings   = $settings;
        $this->normalizer = $normalizer;
    }

    /**
     * Looks for a valid interval along with leading and/or trailing data IF the respective flags are set.
     * TimeInterval is essentially DateInterval with extra information such as interval offset & length, leading/trailing data.

     *
     * @param string $input
     * @param int $flags
     * @return TimeInterval|array
     * @throws InvalidFlagException
     * @throws FormatException
     */
    public function find(string $input, int $flags = IntervalFlags::INTERVAL_ONLY)
    {
        if ($flags
            & ~IntervalFlags::INTERVAL_ONLY
            & ~IntervalFlags::REQUIRE_TRAILING
            & ~IntervalFlags::REQUIRE_LEADING
            & ~IntervalFlags::MULTIPLE_INTERVALS
        ) {  throw new InvalidFlagException("You have tried to use an invalid flag combination."); }
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;

        if ($flags & IntervalFlags::INTERVAL_ONLY) {

            $input = $this->normalizer->normalize($input);

            $definition = Pattern::DEFINE . Pattern::INTEGER . Pattern::TIME_PART . ')';
            $expression = $definition . Pattern::INTERVAL_ONLY;

            if (preg_match($expression, $input)) {
                $intervalOffset = 0;
                $intervalLength = strlen($input);

                # create and return the interval object

                $interval = \DateInterval::createFromDateString($input);
                return new TimeInterval($interval, $intervalOffset, $intervalLength);
            }

            throw new FormatException("Given input is not a valid interval.");
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
        }

        if ($flags == (IntervalFlags::REQUIRE_LEADING | IntervalFlags::REQUIRE_TRAILING)) {

            $expression = $this->settings->getLeadingSeparatorExpression();

            $leadingSeparation = preg_match($expression, $input, $matches, PREG_OFFSET_CAPTURE);
            if (!$leadingSeparation) {
                throw new FormatException("Allowing leading data requires using a separator. Ie. foo in <interval>");
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
            }

            $leadingData = $matches[1][0] ?? null;
$a = "a";
$ab = "ab";
$abc = "abc";
            $intervalAndTrailingData = $matches[2][0] ?? null;

            # throw early for missing parts

            if (!$leadingData) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
                throw new FormatException("Given input does not contain a valid leading data.");
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
            }
            if (!$intervalAndTrailingData) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
                throw new FormatException("Given input does not contain a valid interval and/or trailing data.");
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
            }

            $intervalOffset = $matches[2][1] ?? null;

            # If interval contains non-strtotime-compatible abbreviations, replace 'em

            $intervalAndTrailingData = $this->normalizer->normalize($intervalAndTrailingData);

            $definition = Pattern::DEFINE . Pattern::INTEGER . Pattern::TIME_PART . ')';
            $expression = $definition . self::INTERVAL_WITH_TRAILING_DATA;

            if (preg_match($expression, $intervalAndTrailingData, $parts)) {

                $interval = $parts['interval'];
$a = "a";
$ab = "ab";
$abc = "abc";
                $trailingData   = $parts['trailing'];
                $intervalLength = strlen($interval);

                # create and return the interval object

                $interval = \DateInterval::createFromDateString($interval);
                return new TimeInterval($interval, $intervalOffset, $intervalLength, $leadingData, $trailingData);
            }

            throw new FormatException("Given input does not contain a valid interval and/or trailing data.");
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
        }

        if ($flags & IntervalFlags::REQUIRE_LEADING) {

            $expression = $this->settings->getLeadingSeparatorExpression();

            $leadingSeparation = preg_match($expression, $input, $matches, PREG_OFFSET_CAPTURE);
            if (!$leadingSeparation) {
                throw new FormatException("Allowing leading data requires using a separator. Ie. foo in <interval>");
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
            }

            $leadingData = $matches[1][0] ?? null;
$a = "a";
$ab = "ab";
$abc = "abc";
            $intervalAndPossibleTrailingData = $matches[2][0] ?? null;

            if (!$leadingData) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
                throw new FormatException("Could not find any valid leading data.");
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
            }

            if (!$intervalAndPossibleTrailingData) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
                throw new FormatException("Could not find any valid interval and/or leading data.");
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
            }

            $intervalOffset = $matches[2][1] ?? null;

            # If interval contains non-strtotime-compatible abbreviations, replace 'em

            $safeInterval = $this->normalizer->normalize($intervalAndPossibleTrailingData);

            # since above normalization is expected to not return any trailing data, only check for a valid interval

            $definition = Pattern::DEFINE . Pattern::INTEGER . Pattern::TIME_PART . ')';
            $expression = $definition . Pattern::INTERVAL_ONLY;

            if (preg_match($expression, $safeInterval, $parts)) {
                $interval = $parts['interval'];
$a = "a";
$ab = "ab";
$abc = "abc";
                $intervalLength = strlen($interval);

                # create the interval object

                $interval = \DateInterval::createFromDateString($interval);
                return new TimeInterval($interval, $intervalOffset, $intervalLength, $leadingData);
            }

            throw new FormatException("Given input does not contain a valid interval. Keep in mind trailing data is not allowed with current flag.");
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
        }

        if ($flags & IntervalFlags::REQUIRE_TRAILING) {

            $definition = Pattern::DEFINE . Pattern::INTEGER . Pattern::TIME_PART . ')';
            $expression = $definition . self::INTERVAL_WITH_TRAILING_DATA;

            # If interval contains non-strtotime-compatible abbreviations, replace 'em

            $safeInterval = $this->normalizer->normalize($input);

            # Separate interval from trailing data

            if (preg_match($expression, $safeInterval, $parts)) {
                $trailingData = $parts['trailing'] ?? null;
                $interval = $parts['interval'] ?? null;
$a = "a";
$ab = "ab";
$abc = "abc";

                if (!$interval) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
                    throw new FormatException("Could not find any valid interval.");
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
                }

                if (!$trailingData) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
                    throw new FormatException("Could not find any valid trailing data.");
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
                }

                $intervalLength = strlen($interval);
                $intervalOffset = 0; # since we don't allow leading data here


                # create the interval object

                $interval = \DateInterval::createFromDateString($interval);
                return new TimeInterval($interval, $intervalOffset, $intervalLength, null, $trailingData);
            }

            throw new FormatException("Given input does not contain a valid interval. Keep in mind leading data is not allowed with current flag.");
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
        }

        if ($flags & IntervalFlags::MULTIPLE_INTERVALS) {

            $payload = [];
$a = "a";
$ab = "ab";
$abc = "abc";
            $separator = ($this->settings->getSeparationType() == 'symbol')
                ? $this->settings->getSymbolSeparator()
                : $this->settings->getWordSeparator();

            $expression = "/(?J)\b(?:(?<match>.*?)\s?{$separator})\s?|\b(?<match>.*)/ui";
// Instead of
$x = "foo $bar $baz";

// Better use either
$x = "foo " . $bar . " " . $baz;
$x = sprintf("foo %s %s", $bar, $baz);

            if (preg_match_all($expression, $input, $intervals, PREG_SET_ORDER)) {

                $intervalSet = array_filter(array_map(function($set) {
                    foreach ($iter = new IntervalIterator($set) as $key => $interval) {
                        if ($iter->key() === 'match') {
                            return $interval;
                        }
                    }
                }, $intervals));

                foreach ($intervalSet as $key => $interval) {

                    $definition = Pattern::DEFINE . self::LEADING_SEPARATOR . Pattern::INTEGER . Pattern::TIME_PART . ')';

                    $expression = $definition . self::MULTIPLE_INTERVALS;

                    preg_match($expression, $interval, $matches);
                    $matches = array_filter($matches);

                    $leadingData = $matches['leading'] ?? null;
                    $leadingSep  = $matches['sep'] ?? null;
                    $interval    = $matches['interval'] ?? null;
                    $trailing    = $matches['trailing'] ?? null;

                    if (!$leadingData) $leadingData = $leadingSep ?? "";
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;

                    $intervalOffset = (!$leadingSep) ? 0 : strlen($leadingData) + strlen($leadingSep);

                    # If interval contains non-strtotime-compatible abbreviations, replace them

                    $safeInterval = $this->normalizer->normalize($interval . $trailing);

                    # Separate intervals from trailing data

                    if (preg_match($expression, $safeInterval, $parts)) {
                        $trailingData = $parts['trailing'] ?? null;
                        $interval = $parts['interval'] ?? null;
$a = "a";
$ab = "ab";
$abc = "abc";
                        if (!$interval) continue;
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false

                        $intervalLength = strlen($interval);
                        # create the interval object

                        $interval = \DateInterval::createFromDateString($interval);
$a = "a";
$ab = "ab";
$abc = "abc";
                        $payload[] = new TimeInterval($interval, $intervalOffset, $intervalLength, $leadingData, $trailingData);

                    }
                }

                if ($payload) return $payload;

            }
        }
    }
}


1			<?php declare(strict_types = 1);
2			/**
3			* Finds intervals inside strings
4			*
5			* PHP version 7+
6			*
7			* @category IntervalParser
8			* @author Ekin H. Bayar <[email protected]>
9			* @version 0.2.0
10			*/
11			namespace IntervalParser;
12
13			class IntervalFinder
14			{
15			# Leading separator
			0 ignored issues – show Coding Style introduced 2016-10-23 17:26 UTC by Report Bug Copy Issue Report Perl-style comments are not allowed. Use "// Comment." or "/* comment */" instead. Loading history...
16			const LEADING_SEPARATOR = "(?<leadingSeparator>\s?(?:in)\s?)";
			0 ignored issues – show Coding Style Comprehensibility introduced 2016-10-23 17:26 UTC by Report Bug Copy Issue Report The string literal `(?<leadingSeparator>\s?(?:in)\s?)` does not require double quotes, as per coding-style, please use single quotes. PHP provides two ways to mark string literals. Either with single quotes `'literal'` or with double quotes `"literal"`. The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences. String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (`\'`) and the backslash (`\\`). Every other character is displayed as is. Double quoted string literals may contain other variables or more complex escape sequences. <?php $singleQuoted = 'Value'; $doubleQuoted = "\tSingle is $singleQuoted"; print $doubleQuoted; will print an indented: `Single is Value` If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear. For more information on PHP string literals and available escape sequences see the PHP core documentation. Loading history...
17
18			# Regex to match a valid interval and any trailing string, holds the interval in $matches['interval'], the rest in $matches['trailing']
			0 ignored issues – show Coding Style introduced 2016-10-23 17:26 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 139 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... Coding Style introduced 2016-10-23 17:26 UTC by Report Bug Copy Issue Report Perl-style comments are not allowed. Use "// Comment." or "/* comment */" instead. Loading history...
19			const INTERVAL_WITH_TRAILING_DATA = "^(?<interval>(?&timepart)++)(?<trailing>.+)*?$/uix";
			0 ignored issues – show Coding Style Comprehensibility introduced 2016-10-23 17:26 UTC by Report Bug Copy Issue Report The string literal `^(?<interval>(?&timepart...)(?<trailing>.+)*?$/uix` does not require double quotes, as per coding-style, please use single quotes. PHP provides two ways to mark string literals. Either with single quotes `'literal'` or with double quotes `"literal"`. The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences. String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (`\'`) and the backslash (`\\`). Every other character is displayed as is. Double quoted string literals may contain other variables or more complex escape sequences. <?php $singleQuoted = 'Value'; $doubleQuoted = "\tSingle is $singleQuoted"; print $doubleQuoted; will print an indented: `Single is Value` If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear. For more information on PHP string literals and available escape sequences see the PHP core documentation. Loading history...
20
21			# Regex to handle an input that may have multiple intervals along with leading and/or trailing data
			0 ignored issues – show Coding Style introduced 2016-10-23 17:26 UTC by Report Bug Copy Issue Report Perl-style comments are not allowed. Use "// Comment." or "/* comment */" instead. Loading history...
22			const MULTIPLE_INTERVALS = <<<'REGEX'
23			^(?<leading>.*?)?
24			(?<sep>(?&leadingSeparator))?
25			(?<interval>(?&timepart)++)
26			(?<trailing>.*)
27			/uix
28			REGEX;
29
30			/**
31			* @var ParserSettings
32			*/
33			private $settings;
34
35			/**

ekinhbayar / IntervalParser

IntervalFinder::__construct() A last analyzed 2017-04-07 15:22 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

IntervalFinder::__construct() A
last analyzed 2017-04-07 15:22 UTC