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\Entity;
26: 
27: /**
28:  * provides a way to add date fields to an entity
29:  *
30:  * @author David Schoenbauer <dschoenbauer@gmail.com>
31:  */
32: interface HasDateFieldsInterface
33: {
34: 
35:     /**
36:      * provides a way to add date fields to an entity
37:      * @return array an array of fields that are date data types
38:      * @since v1.0.0
39:      */
40:     public function getDateFields();
41:     
42:     /**
43:      * a default date format that the value must conform to
44:      * @return string Format accepted by date().
45:      * @link http://php.net/manual/en/function.date.php date() format
46:      * @since v1.0.0
47:      */
48:     public function getDateDefaultFormat();
49: }
50: