Mcustiel\PhpSimpleRegex\PregFunctions\MatchFunctions

Complexity

Total Complexity

4

Size/Duplication

Total Lines	101
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getOneMatch()	0	8	2
	getPatternByType()	0	1	?
	checkResultIsOkOrThrowException()	0	1	?
A	getAllMatches()	0	15	1
A	match()	0	13	1

<?php
namespace Mcustiel\PhpSimpleRegex\PregFunctions;

use Mcustiel\PhpSimpleRegex\MatchResult;
use Mcustiel\PhpSimpleRegex\Match;

trait MatchFunctions
{
    /**
     * Searches for all matches for the given pattern.
     *
     * @param string|\VerbalExpressions\PHPVerbalExpressions\VerbalExpressions|SelvinOrtiz\Utils\Flux\Flux|MarkWilson\VerbalExpression
     *          $pattern
     * @param string
     *          $subject
     * @param number
     *          $offset
     *
     * @throws \RuntimeException
     * @throws \InvalidArgumentException
     *
     * @return \Mcustiel\PhpSimpleRegex\MatchResult
     */
    public function getAllMatches($pattern, $subject, $offset = 0)
    {
        $matches = array();
        $result = @preg_match_all(
            $this->getPatternByType($pattern),
            $subject,
            $matches,
            PREG_SET_ORDER | PREG_OFFSET_CAPTURE,
            $offset
        );

        $this->checkResultIsOkOrThrowException($result, $pattern);

        return new MatchResult($matches);

It seems like $matches can also be of type null; however, Mcustiel\PhpSimpleRegex\MatchResult::__construct() does only seem to accept array, maybe add an additional type check?

    }

    /**
     * Searches for matches for the given pattern and returns the first match.
     *
     * @param string|\VerbalExpressions\PHPVerbalExpressions\VerbalExpressions|SelvinOrtiz\Utils\Flux\Flux|MarkWilson\VerbalExpression
     *          $pattern
     * @param string
     *          $subject
     * @param number
     *          $offset
     *
     * @throws \RuntimeException
     * @throws \InvalidArgumentException
     *
     * @return \Mcustiel\PhpSimpleRegex\Match|NULL
     */
    public function getOneMatch($pattern, $subject, $offset = 0)
    {
        $matches = array();
        $pattern = $this->getPatternByType($pattern);
        $result = @preg_match($pattern, $subject, $matches, PREG_OFFSET_CAPTURE, $offset);
        $this->checkResultIsOkOrThrowException($result, $pattern);
        return $result? new Match($matches) : null;
    }

    /**
     * Checks weather the string matches the given pattern.
     *
     * @param string|\VerbalExpressions\PHPVerbalExpressions\VerbalExpressions|SelvinOrtiz\Utils\Flux\Flux|MarkWilson\VerbalExpression
     *          $pattern
     * @param string
     *          $subject
     * @param number
     *          $offset
     *
     * @throws \RuntimeException
     * @throws \InvalidArgumentException
     *
     * @return boolean
     */
    public function match($pattern, $subject, $offset = 0)
    {
        $matches = [];
        $result = @preg_match(
            $this->getPatternByType($pattern),
            $subject,
            $matches,
            0,
            $offset
        );
        $this->checkResultIsOkOrThrowException($result, $pattern);
        return (boolean) $result;
    }

    /**
     * @param mixed $pattern
     * @throws \InvalidArgumentException
     * @return string
     */
    abstract protected function getPatternByType($pattern);

    /**
     * @param mixed  $result
     * @param string $pattern
     *
     * @throws \RuntimeException
     */
    abstract protected function checkResultIsOkOrThrowException($result, $pattern);
}