File Flikore/Validator/Interfaces/IValidator.php

 1 <?php
 2 
 3 /**
 4  * The MIT License
 5  *
 6  * Copyright 2014 George Marques <george at georgemarques.com.br>.
 7  *
 8  * Permission is hereby granted, free of charge, to any person obtaining a copy
 9  * of this software and associated documentation files (the "Software"), to deal
10  * in the Software without restriction, including without limitation the rights
11  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12  * copies of the Software, and to permit persons to whom the Software is
13  * furnished to do so, subject to the following conditions:
14  *
15  * The above copyright notice and this permission notice shall be included in
16  * all copies or substantial portions of the Software.
17  *
18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24  * THE SOFTWARE.
25  */
26 
27 namespace Flikore\Validator\Interfaces;
28 
29 /**
30  * The interface for validation classes.
31  *
32  * @author George Marques <george at georgemarques.com.br>
33  * @version 0.5.2
34  * @since 0.5.0
35  * @license http://opensource.org/licenses/MIT MIT
36  * @copyright (c) 2014, George Marques
37  * @package Flikore\Validator
38  */
39 interface IValidator
40 {
41     /**
42      * Checks if the value passes the validation test.
43      * @param mixed $value The value to test.
44      * 
45      * @return boolean Whether it passes the test or not.
46      */
47     public function validate($value);
48 
49     /**
50      * Checks if the value passes the validation test and throws
51      * an exception if not.
52      * 
53      * @param mixed $value The value to test.
54      * @throws Exception\ValidatorException
55      */
56     public function assert($value);
57     
58     /**
59      * Adds a new key-value pair to be replaced by the templating engine.
60      * This does not check if it's replacing a specific validator value.
61      * 
62      * @param string $key The key to replace (in the template as "%key%")
63      * @param string $value The value to be inserted instead of the key.
64      */
65     public function addKeyValue($key, $value);
66 }
67
Namespaces

Interfaces
