interface ConstraintInterface

Same name in this branch
  1. 11.1.x vendor/composer/semver/src/Constraint/ConstraintInterface.php \Composer\Semver\Constraint\ConstraintInterface

The Constraints Interface

@author Robert Schönthal <seroscho@googlemail.com>

Hierarchy

Expanded class hierarchy of ConstraintInterface

All classes that implement ConstraintInterface

File

vendor/justinrainbow/json-schema/src/JsonSchema/Constraints/ConstraintInterface.php, line 19

Namespace

JsonSchema\Constraints
View source 
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 JsonPointer|null $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(?JsonPointer $path, $message, $constraint = '', ?array $more = null);
    
    /**
     * checks if the validator has not raised errors
     *
     * @return bool
     */
    public function isValid();
    
    /**
     * invokes the validation of an element
     *
     * @abstract
     *
     * @param mixed            $value
     * @param mixed            $schema
     * @param JsonPointer|null $path
     * @param mixed            $i
     *
     * @throws \JsonSchema\Exception\ExceptionInterface
     */
    public function check(&$value, $schema = null, ?JsonPointer $path = null, $i = null);

}

Members

Title Modifiers Object type Summary Overrides
ConstraintInterface::addError public function adds an error
ConstraintInterface::addErrors public function adds errors to this validator
ConstraintInterface::check public function invokes the validation of an element 9
ConstraintInterface::getErrors public function returns all collected errors
ConstraintInterface::isValid public function checks if the validator has not raised errors