ICanBoogie/Validate master
  • Namespace
  • Class

Namespaces

  • ICanBoogie
    • Validate
      • Reader
      • Validation
      • Validator
      • ValidatorProvider

Classes

  • Context
  • Message
  • Render
  • Validation
  • ValidationErrors

Interfaces

  • Reader
  • Validator
  • ValidatorOptions
  • ValidatorProvider

Exceptions

  • ParameterIsMissing
  • ValidationFailed
 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 
<?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;

/**
 * An interface for validators.
 */
interface Validator extends ValidatorOptions
{
    /**
     * Validator alias.
     */
    const ALIAS = null;

    /**
     * Default error message.
     */
    const DEFAULT_MESSAGE = "is not valid";

    /**
     * Index name of message `attribute` argument.
     */
    const MESSAGE_ARG_ATTRIBUTE = 'attribute';

    /**
     * Index name of message `value` argument.
     */
    const MESSAGE_ARG_VALUE = 'value';

    /**
     * Index name of message `validator` argument.
     */
    const MESSAGE_ARG_VALIDATOR = 'validator';

    /**
     * Normalize parameters and options.
     *
     * @param array $params
     *
     * @return array
     */
    public function normalize_params(array $params);

    /**
     * Validate a value.
     *
     * @param mixed $value
     * @param Context $context
     *
     * @return bool
     */
    public function validate($value, Context $context);
}
ICanBoogie/Validate master API documentation generated by ApiGen