Valdi\Validator\Contains

Complexity

Total Complexity

9

Size/Duplication

Total Lines	54
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	3
Bugs	0	Features	1

4 Methods

Rating	Name	Duplication	Size	Complexity
A	isValid()	0	8	2
A	adjustCaseInsensitive()	0	6	4
A	validateParameterCount()	0	4	2
A	getInvalidDetails()	0	3	1

<?php

/*
 * This file is part of the Valdi package.
 *
 * (c) Philip Lehmann-Böhm <philip@philiplb.de>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Valdi\Validator;

use Valdi\ValidationException;

/**
 * Validator for strings containing a substring.
 */
class Contains implements ValidatorInterface
{

    /**
     * Throws an exception if the parameters don't fulfill the expected
     * parameter count.
     *
     * @param integer $parameterAmount the amount of expected parameters
     *
     * @throws ValidationException - thrown if less than one parameter is given
     */
    protected function validateParameterCount($parameterAmount)
    {
        if ($parameterAmount < 1) {
            throw new ValidationException('"contains" expects at least 1 parameter.');
        }
    }

    /**
     * Adjusts value and parameters to be case insensitive if the second
     * parameter says so or is not given.
     *
     * @param mixed $value the value to validate
     *
     * @param array $parameters - the other parameters the validator need
     */
    protected function adjustCaseInsensitive(&$value, &$parameters)
    {
        $parameterAmount = count($parameters);
        if ($parameterAmount == 1 || $parameterAmount > 1 && $parameters[1]) {
            $parameters[0] = strtolower($parameters[0]);
            $value = strtolower($value);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function isValid($value, array $parameters)
    {
        $parameterAmount = count($parameters);

        $this->validateParameterCount($parameterAmount);
        $this->adjustCaseInsensitive($value, $parameters);

        return in_array($value, ['', null], true) || strpos($value, $parameters[0]) !== false;
    }

    /**
     * {@inheritdoc}
     */
    public function getInvalidDetails()
    {
        return 'contains';
    }
}