Caridea\Validate\Rule\Match

Complexity

Total Complexity

9

Size/Duplication

Total Lines	103
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	2
A	apply()	0	7	3
A	like()	0	4	1
A	url()	0	4	1
A	email()	0	4	1
A	isoDate()	0	4	1

<?php
declare(strict_types=1);
/**
 * Caridea
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 *
 * @copyright 2015-2018 LibreWorks contributors
 * @license   Apache-2.0
 */
namespace Caridea\Validate\Rule;

/**
 * Pattern matching rule.
 *
 * @copyright 2015-2018 LibreWorks contributors
 * @license   Apache-2.0
 */
class Match implements \Caridea\Validate\Rule
{
    /**
     * @var string The pattern to match
     */
    private $pattern;
    /**
     * @var string The failure error code
     */
    private $error;

    /**
     * Modified version of the Regular Expression for URL validation.
     *
     * @var string Regular Expression to match URLs
     * @copyright 2010-2013 Diego Perini (http://www.iport.it)
     * @license http://opensource.org/licenses/MIT MIT License
     * @link https://gist.github.com/dperini/729294 GitHub gist
     */
    const URL = "_^(?:https?://)(?:\\S+(?::\\S*)?@)?(?:(?:[1-9]\\d?|1\\d\\d|2[01]\\d|22[0-3])(?:\\.(?:1?\\d{1,2}|2[0-4]\\d|25[0-5])){2}(?:\\.(?:[1-9]\\d?|1\\d\\d|2[0-4]\\d|25[0-4]))|(?:(?:[a-z\\x{00a1}-\\x{ffff}0-9]-*)*[a-z\\x{00a1}-\\x{ffff}0-9]+)(?:\\.(?:[a-z\\x{00a1}-\\x{ffff}0-9]-*)*[a-z\\x{00a1}-\\x{ffff}0-9]+)*(?:\\.(?:[a-z\\x{00a1}-\\x{ffff}]{2,}))\\.?)(?::\\d{2,5})?(?:[/?#]\\S*)?\$_iuS";
    /**
     * RegEx taken from HTML5 spec for email input type.
     *
     * @var string Regular Expression to match e-mails
     * @link http://www.w3.org/TR/html5/forms.html#e-mail-state-%28type=email%29 HTML5 Form Specification
     */
    const EMAIL = '/^[a-zA-Z0-9.!#$%&\'*+\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$/';
    /**
     * A "pretty good" regex for ISO 8601 Dates
     *
     * @var string Regular Expression to match dates
     */
    const DATE = '/^(\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$/';

    /**
     * Creates a new MatchRule.
     *
     * @param string $pattern The pattern to match
     * @param string $error The failure error code
     */
    public function __construct(string $pattern, string $error = null)
    {
        $this->pattern = (string) $pattern;
        $this->error = strlen(trim((string)$error)) > 0 ? (string) $error : 'WRONG_FORMAT';
    }

    /**
     * {@inheritDoc}
     */
    public function apply($value, $data = []): ?array
    {
        if (!is_scalar($value)) {
            return ['FORMAT_ERROR'];
        }
        return preg_match($this->pattern, $value) ? null : [$this->error];
    }

    /**
     * Gets a regular expression matching rule.
     *
     * ```php
     * $rule = CompareRule::matches("^[a-z]$", "i");
     * ```
     *
     * @param string $pattern An unbounded regular expression (no delimiters!)
     * @param string $flags Any PCRE regex flags (e.g. i, s)
     * @return \Caridea\Validate\Rule\Match the created rule
     */
    public static function like(string $pattern, string $flags = ''): Match
    {
        return new Match("/$pattern/$flags", 'WRONG_FORMAT');
    }

    /**
     * Gets a rule that matches URLs.
     *
     * @return \Caridea\Validate\Rule\Match the created rule
     */
    public static function url(): Match
    {
        return new Match(self::URL, 'WRONG_URL');
    }

    /**
     * Gets a rule that matches e-mail addresses.
     *
     * @return \Caridea\Validate\Rule\Match the created rule
     */
    public static function email(): Match
    {
        return new Match(self::EMAIL, 'WRONG_EMAIL');
    }

    /**
     * Gets a rule that matches ISO 8601 dates.
     *
     * @return \Caridea\Validate\Rule\Match the created rule
     */
    public static function isoDate(): Match
    {
        return new Match(self::DATE, 'WRONG_DATE');
    }
}