Mbright\Validation\Spec\SanitizeSpec

Complexity

Total Complexity

7

Size/Duplication

Total Lines	84
Duplicated Lines	0 %

Test Coverage

Coverage

95%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	usingBlank()	0	6	1
A	getDefaultMessage()	0	9	2
A	to()	0	6	1
A	__invoke()	0	13	3

<?php

namespace Mbright\Validation\Spec;

use Mbright\Validation\Exception\ValidationFailureException;
use Mbright\Validation\Rule\Sanitize\SanitizeRuleInterface;

class SanitizeSpec extends AbstractSpec
{
    /**
     * Value to use when inserting
     *
     * @var mixed
     */
    protected $blankValue;

    /**
     * Failure mode for the rule.
     *
     * @var string
     */
    protected $failureMode = 'HARD_FAILURE';

    /**
     * Invokes the rule the spec is configured for.
     *
     * @param object $subject
     *
     * @return bool
     */
    public function __invoke($subject): bool
    {
        if (!$this->subjectFieldIsBlank($subject)) {
            return parent::__invoke($subject);
        }

        if (!$this->allowBlanks) {
            return false;
        }

        $subject->{$this->field} = $this->blankValue;

        return true;
    }

    /**
     * Set the Sanitize rule to be used.
     *
     * @param SanitizeRuleInterface $rule
     *
     * @return SanitizeSpec
     */
    public function to(SanitizeRuleInterface $rule): self
    {
        $this->rule = $rule;
        $this->ruleClass = get_class($rule);

        return $this;
    }

    /**
     * Sets the blank value to use.
     *
     * Defaults to null.
     *
     * @param $blankValue
     *
     * @return SanitizeSpec
     */
    public function usingBlank($blankValue = null): self
    {
        $this->allowBlanks = true;
        $this->blankValue = $blankValue;

        return $this;
    }

    /**
     * Returns the default failure message for this rule specification.
     *
     * @return string
     */
    protected function getDefaultMessage(): string
    {
        $message = $this->field . ' should have sanitized to ';

        if ($this->allowBlanks) {
            $message .= 'blank or ';
        }

        return "{$message}" . parent::getDefaultMessage();
    }
}