robotdance/php-json-schema

<?php

/*
 * This file is part of the JsonSchema package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace JsonSchema\Constraints;

/**
 * The Constraints Interface
 *
 * @author Robert Schönthal <seroscho@googlemail.com>
 */
interface ConstraintInterface
{
    /**
     * returns all collected errors
     *
     * @return array
     */
    public function getErrors();

    /**
     * adds errors to this validator
     *
     * @param array $errors
     */
    public function addErrors(array $errors);

    /**
     * adds an error
     *
     * @param string $path
     * @param string $message
     * @param string $constraint the constraint/rule that is broken, e.g.: 'minLength'
     * @param array $more more array elements to add to the error
     */
    public function addError($path, $message, $constraint='', array $more=null);

    /**
     * checks if the validator has not raised errors
     *
     * @return boolean
     */
    public function isValid();

    /**
     * invokes the validation of an element
     *
     * @abstract
     * @param mixed $value
     * @param mixed $schema
     * @param mixed $path
     * @param mixed $i
     */
    public function check($value, $schema = null, $path = null, $i = null);
}