Kontrolio\Rules\AbstractRule

Complexity

Total Complexity

9

Size/Duplication

Total Lines	104
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	emptyValueAllowed()	0	3	1
A	allowingEmptyValue()	0	3	1
A	allowEmptyValue()	0	5	1
A	getName()	0	18	3
A	getViolations()	0	3	1
A	canSkipValidation()	0	3	1
A	hasViolations()	0	3	1

<?php

namespace Kontrolio\Rules;

/**
 * Validation rule base class.
 *
 * @package Kontrolio\Rules
 */
abstract class AbstractRule implements RuleInterface
{
    /**
     * Empty allowed/disallowed state.
     *
     * @var bool
     */
    protected $emptyAllowed = false;

    /**
     * Validation violations.
     *
     * @var array
     */
    protected $violations = [];

    /**
     * Constructs a rule allowing empty input by default.
     *
     *
     * @return $this
     */
    public static function allowingEmptyValue()
    {
        return (new static)->allowEmptyValue();
    }

    /**
     * Returns validation rule identifier.
     *
     * @return string
     */
    public function getName()
    {
        $class = get_class($this);
        $segments = explode('\\', $class);
        $name = end($segments);

        if (!ctype_lower($name)) {
            $name = preg_replace('/\s+/u', '', $name);
            $name = mb_strtolower(preg_replace('/(.)(?=[A-Z])/u', '$1_', $name), 'UTF-8');
        }

        $postfix = strrpos($name, '_rule');

        if ($postfix !== false) {
            $name = substr($name, 0, $postfix);
        }

        return $name;
    }

    /**
     * When true, validation will be bypassed if validated value is null or an empty string.
     *
     * @return bool
     */
    public function emptyValueAllowed()
    {
        return $this->emptyAllowed;
    }

    /**
     * Allows bypassing validation when value is null or an empty string.
     *
     * @return $this
     */
    public function allowEmptyValue()
    {
        $this->emptyAllowed = true;
        
        return $this;
    }

    /**
     * When simply true or some conditions return true, informs validator service that validation can be skipped.
     *
     * @param mixed $input
     *
     * @return bool
     */
    public function canSkipValidation($input = null)
    {
        return false;
    }

    /**
     * Checks whether validation rule has any violations.
     *
     * @return bool
     */
    public function hasViolations()
    {
        return count($this->violations) > 0;
    }

    /**
     * Returns validation rule violations.
     *
     * @return array
     */
    public function getViolations()
    {
        return $this->violations;
    }
}