1: <?php
 2: /*
 3:  * The MIT License
 4:  *
 5:  * Copyright 2017 David Schoenbauer.
 6:  *
 7:  * Permission is hereby granted, free of charge, to any person obtaining a copy
 8:  * of this software and associated documentation files (the "Software"), to deal
 9:  * in the Software without restriction, including without limitation the rights
10:  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11:  * copies of the Software, and to permit persons to whom the Software is
12:  * furnished to do so, subject to the following conditions:
13:  *
14:  * The above copyright notice and this permission notice shall be included in
15:  * all copies or substantial portions of the Software.
16:  *
17:  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18:  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19:  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20:  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21:  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22:  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23:  * THE SOFTWARE.
24:  */
25: namespace DSchoenbauer\Orm\Events\Validate\DataType;
26: 
27: use DSchoenbauer\Orm\Entity\HasBoolFieldsInterface;
28: 
29: /**
30:  * Validates boolean fields are boolean
31:  *
32:  * @author David Schoenbauer
33:  */
34: class DataTypeBoolean extends AbstractDataType
35: {
36: 
37:     /**
38:      * full name space of an interface that defines a given field type
39:      * @return string
40:      * @since v1.0.0
41:      */
42:     public function getTypeInterface()
43:     {
44:         return HasBoolFieldsInterface::class;
45:     }
46: 
47:     /**
48:      * Validates that the value is of the proper type
49:      * @param mixed $value value to DataType
50:      * @param string $field field name
51:      * @return boolean
52:      * @since v1.0.0
53:      */
54:     public function validateValue($value, $field = null)
55:     {
56:         return is_bool($value);
57:     }
58:     
59:     /**
60:      * returns the fields affected by the entity interface
61:      * @param mixed $entity an entity object implements the getTypeInterface
62:      * @return array an array of fields that are relevant to the interface
63:      * @since v1.0.0
64:      */
65:     public function getFields($entity)
66:     {
67:         return $entity->getBoolFields();
68:     }
69: }
70: