ex
Fork of mbed-os-example-mbed5-blinky by
dumi_doc-master/schema/vendor/justinrainbow/json-schema/src/JsonSchema/Constraints/ConstraintInterface.php@44:c1d8923072ba, 2017-07-18 (annotated)
- Committer:
- TMBOY
- Date:
- Tue Jul 18 16:27:22 2017 +0800
- Revision:
- 44:c1d8923072ba
?
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| TMBOY | 44:c1d8923072ba | 1 | <?php |
| TMBOY | 44:c1d8923072ba | 2 | |
| TMBOY | 44:c1d8923072ba | 3 | /* |
| TMBOY | 44:c1d8923072ba | 4 | * This file is part of the JsonSchema package. |
| TMBOY | 44:c1d8923072ba | 5 | * |
| TMBOY | 44:c1d8923072ba | 6 | * For the full copyright and license information, please view the LICENSE |
| TMBOY | 44:c1d8923072ba | 7 | * file that was distributed with this source code. |
| TMBOY | 44:c1d8923072ba | 8 | */ |
| TMBOY | 44:c1d8923072ba | 9 | |
| TMBOY | 44:c1d8923072ba | 10 | namespace JsonSchema\Constraints; |
| TMBOY | 44:c1d8923072ba | 11 | |
| TMBOY | 44:c1d8923072ba | 12 | use JsonSchema\Entity\JsonPointer; |
| TMBOY | 44:c1d8923072ba | 13 | |
| TMBOY | 44:c1d8923072ba | 14 | /** |
| TMBOY | 44:c1d8923072ba | 15 | * The Constraints Interface |
| TMBOY | 44:c1d8923072ba | 16 | * |
| TMBOY | 44:c1d8923072ba | 17 | * @author Robert Schönthal <seroscho@googlemail.com> |
| TMBOY | 44:c1d8923072ba | 18 | */ |
| TMBOY | 44:c1d8923072ba | 19 | interface ConstraintInterface |
| TMBOY | 44:c1d8923072ba | 20 | { |
| TMBOY | 44:c1d8923072ba | 21 | /** |
| TMBOY | 44:c1d8923072ba | 22 | * returns all collected errors |
| TMBOY | 44:c1d8923072ba | 23 | * |
| TMBOY | 44:c1d8923072ba | 24 | * @return array |
| TMBOY | 44:c1d8923072ba | 25 | */ |
| TMBOY | 44:c1d8923072ba | 26 | public function getErrors(); |
| TMBOY | 44:c1d8923072ba | 27 | |
| TMBOY | 44:c1d8923072ba | 28 | /** |
| TMBOY | 44:c1d8923072ba | 29 | * adds errors to this validator |
| TMBOY | 44:c1d8923072ba | 30 | * |
| TMBOY | 44:c1d8923072ba | 31 | * @param array $errors |
| TMBOY | 44:c1d8923072ba | 32 | */ |
| TMBOY | 44:c1d8923072ba | 33 | public function addErrors(array $errors); |
| TMBOY | 44:c1d8923072ba | 34 | |
| TMBOY | 44:c1d8923072ba | 35 | /** |
| TMBOY | 44:c1d8923072ba | 36 | * adds an error |
| TMBOY | 44:c1d8923072ba | 37 | * |
| TMBOY | 44:c1d8923072ba | 38 | * @param JsonPointer|null $path |
| TMBOY | 44:c1d8923072ba | 39 | * @param string $message |
| TMBOY | 44:c1d8923072ba | 40 | * @param string $constraint the constraint/rule that is broken, e.g.: 'minLength' |
| TMBOY | 44:c1d8923072ba | 41 | * @param array $more more array elements to add to the error |
| TMBOY | 44:c1d8923072ba | 42 | */ |
| TMBOY | 44:c1d8923072ba | 43 | public function addError(JsonPointer $path = null, $message, $constraint='', array $more=null); |
| TMBOY | 44:c1d8923072ba | 44 | |
| TMBOY | 44:c1d8923072ba | 45 | /** |
| TMBOY | 44:c1d8923072ba | 46 | * checks if the validator has not raised errors |
| TMBOY | 44:c1d8923072ba | 47 | * |
| TMBOY | 44:c1d8923072ba | 48 | * @return boolean |
| TMBOY | 44:c1d8923072ba | 49 | */ |
| TMBOY | 44:c1d8923072ba | 50 | public function isValid(); |
| TMBOY | 44:c1d8923072ba | 51 | |
| TMBOY | 44:c1d8923072ba | 52 | /** |
| TMBOY | 44:c1d8923072ba | 53 | * invokes the validation of an element |
| TMBOY | 44:c1d8923072ba | 54 | * |
| TMBOY | 44:c1d8923072ba | 55 | * @abstract |
| TMBOY | 44:c1d8923072ba | 56 | * @param mixed $value |
| TMBOY | 44:c1d8923072ba | 57 | * @param mixed $schema |
| TMBOY | 44:c1d8923072ba | 58 | * @param JsonPointer|null $path |
| TMBOY | 44:c1d8923072ba | 59 | * @param mixed $i |
| TMBOY | 44:c1d8923072ba | 60 | * @throws \JsonSchema\Exception\ExceptionInterface |
| TMBOY | 44:c1d8923072ba | 61 | */ |
| TMBOY | 44:c1d8923072ba | 62 | public function check($value, $schema = null, JsonPointer $path = null, $i = null); |
| TMBOY | 44:c1d8923072ba | 63 | } |
