File Validation.php | ICanBoogie/Validate master

  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290

<?php

/*
 * This file is part of the ICanBoogie package.
 *
 * (c) Olivier Laviale <olivier.laviale@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace ICanBoogie\Validate;

use ICanBoogie\Validate\ValidatorProvider\BuiltinValidatorProvider;

/**
 * Validates data against a set of rules.
 */
class Validation implements ValidatorOptions
{
    const SERIALIZED_STOP_ON_ERROR_SUFFIX = '!';
    const SERIALIZED_VALIDATION_SEPARATOR = '|';
    const SERIALIZED_ALIAS_SEPARATOR = ':';
    const SERIALIZED_PARAM_SEPARATOR = ';';

    /**
     * @var array
     */
    protected $validations = [];

    /**
     * @var ValidatorProvider|callable
     */
    private $validator_provider;

    /**
     * @param array $rules Validation rules.
     * @param ValidatorProvider|callable $validator_provider
     */
    public function __construct(array $rules, callable $validator_provider = null)
    {
        $this->validator_provider = $validator_provider ?: new BuiltinValidatorProvider;

        $this->validates($rules);
    }

    /**
     * Defines validation rules.
     *
     * **Note:** The specified rules may override previously defined rules for the same attributes.
     *
     * @param array $rules
     *
     * @return $this
     */
    public function validates(array $rules)
    {
        foreach ($rules as $attribute => $validations)
        {
            if (is_string($validations))
            {
                $validations = $this->unserialize_validations($validations);
            }

            foreach ($validations as $class_or_alias => $params)
            {
                $this->validates_with($attribute, $class_or_alias, $params);
            }
        }

        return $this;
    }

    /**
     * Defines validation for an attribute.
     *
     * @param string $attribute The attribute to validate.
     * @param string $class_or_alias The class name or alias of the validator.
     * @param array $params The validator parameters and options.
     *
     * @return $this
     */
    public function validates_with($attribute, $class_or_alias, array $params)
    {
        $this->validations[$attribute][$class_or_alias] = $params;

        return $this;
    }

    /**
     * Validates data.
     *
     * @param Reader $reader
     *
     * @return ValidationErrors|array Returns a {@link ValidationErrors} instance if there are
     * validation errors, an empty array otherwise.
     */
    public function validate(Reader $reader)
    {
        $context = $this->create_context($reader);

        foreach ($this->validations as $attribute => $validators)
        {
            /* @var $attribute string */

            $context->attribute = $attribute;

            $this->validate_attribute($attribute, $validators, $context);
        }

        return $context->errors ? new ValidationErrors($context->errors) : [];
    }

    /**
     * Validates an attribute.
     *
     * @param string $attribute
     * @param array $validators
     * @param Context $context
     */
    protected function validate_attribute($attribute, array $validators, Context $context)
    {
        foreach ($validators as $class_or_alias => $validator_params)
        {
            $context->value = $value = $context->value($attribute);
            $context->validator = $validator = $this->create_validator($class_or_alias);
            $context->validator_params = $validator->normalize_params($validator_params);
            $context->message = $validator::DEFAULT_MESSAGE;
            $context->message_args = [

                Validator::MESSAGE_ARG_ATTRIBUTE => $attribute,
                Validator::MESSAGE_ARG_VALUE => $value,
                Validator::MESSAGE_ARG_VALIDATOR => get_class($validator),

            ];

            if ($this->should_skip($context))
            {
                return;
            }

            if (!$validator->validate($value, $context))
            {
                $this->error($context);
            }

            if ($this->should_stop($context))
            {
                break;
            }
        }
    }

    /**
     * Asserts that data is valid.
     *
     * @param Reader $reader
     *
     * @throws ValidationFailed if the validation failed.
     */
    public function assert(Reader $reader)
    {
        $errors = $this->validate($reader);

        if ($errors instanceof ValidationErrors)
        {
            throw new ValidationFailed($errors);
        }
    }

    /**
     * Creates a validation context.
     *
     * @param Reader $reader
     *
     * @return Context
     */
    protected function create_context(Reader $reader)
    {
        $context = new Context;
        $context->reader = $reader;

        return $context;
    }

    /**
     * Whether the validator should be skipped.
     *
     * @param Context $context
     *
     * @return bool
     */
    protected function should_skip(Context $context)
    {
        /* @var $if Validation\IfCallable|callable */
        /* @var $unless Validation\UnlessCallable|callable */

        $if = $context->option(self::OPTION_IF);
        $unless = $context->option(self::OPTION_UNLESS);

        return ($if && !$if($context)) || ($unless && $unless($context));
    }

    /**
     * Whether validation for an attribute should stop.
     *
     * @param Context $context
     *
     * @return bool
     */
    protected function should_stop(Context $context)
    {
        if (!$context->option(self::OPTION_STOP_ON_ERROR))
        {
            return false;
        }

        return !empty($context->errors[$context->attribute]);
    }

    /**
     * Resolves validations from a string.
     *
     * @param string $serialized_validations
     *
     * @return array An array of key/value pairs where _key_ if the alias of a validator and
     * _value_ its parameters and options.
     */
    protected function unserialize_validations($serialized_validations)
    {
        $validations = [];

        foreach (explode(self::SERIALIZED_VALIDATION_SEPARATOR, $serialized_validations) as $serialized_alias_and_params)
        {
            list($alias, $params) = explode(self::SERIALIZED_ALIAS_SEPARATOR, $serialized_alias_and_params, 2) + [ 1 => null ];

            $params = $params === null ? [] : explode(self::SERIALIZED_PARAM_SEPARATOR, $params);

            if (substr($alias, -1) === self::SERIALIZED_STOP_ON_ERROR_SUFFIX)
            {
                $params[self::OPTION_STOP_ON_ERROR] = true;
                $alias = substr($alias, 0, -1);
            }

            $validations[$alias] = $params;
        }

        return $validations;
    }

    /**
     * Creates a validator.
     *
     * @param string $class_or_alias The class or alias of the validator.
     *
     * @return Validator
     */
    protected function create_validator($class_or_alias)
    {
        $provider = $this->validator_provider;

        return $provider($class_or_alias);
    }

    /**
     * Creates an error message.
     *
     * @param string $message
     * @param array $args
     *
     * @return Message
     */
    protected function create_message($message, array $args)
    {
        return new Message($message, $args);
    }

    /**
     * Adds an error to the collection.
     *
     * @param Context $context
     */
    protected function error(Context $context)
    {
        $context->errors[$context->attribute][] = $this->create_message(
            $context->option(self::OPTION_MESSAGE) ?: $context->message,
            $context->message_args);
    }
}

Namespaces

Classes

Interfaces

Exceptions