/
TypeMap.php
115 lines (107 loc) · 3.11 KB
/
TypeMap.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
<?php
/**
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @since 3.0.0
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
*/
namespace Cake\Database;
/**
* Implements default and single-use mappings for columns to their associated types
*/
class TypeMap {
/**
* Associative array with the default fields and their types this query might contain
* used to avoid repetition when calling multiple times functions inside this class that
* may require a custom type for a specific field.
*
* @var array
*/
protected $_defaults;
/**
* Associative array with the fields and their types that override defaults this query might contain
* used to avoid repetition when calling multiple times functions inside this class that
* may require a custom type for a specific field.
*
* @var array
*/
protected $_types = [];
/**
* Creates an instance with the given defaults
*
* @param array $defaults
*/
public function __construct(array $defaults = []) {
$this->defaults($defaults);
}
/**
* Configures a map of default fields and their associated types to be
* used as the default list of types for every function in this class
* with a $types param. Useful to avoid repetition when calling the same
* functions using the same fields and types.
*
* If called with no arguments it will return the currently configured types.
*
* ## Example
*
* {{{
* $query->defaults(['created' => 'datetime', 'is_visible' => 'boolean']);
* }}}
*
* @param array $defaults associative array where keys are field names and values
* are the correspondent type.
* @return this|array
*/
public function defaults(array $defaults = null) {
if ($defaults === null) {
return $this->_defaults;
}
$this->_defaults = $defaults;
return $this;
}
/**
* Configures a map of fields and their associated types for single-use.
*
* If called with no arguments it will return the currently configured types.
*
* ## Example
*
* {{{
* $query->types(['created' => 'time']);
* }}}
*
* @param array $defaults associative array where keys are field names and values
* are the correspondent type.
* @return this|array
*/
public function types(array $types = null) {
if ($types === null) {
return $this->_types;
}
$this->_types = $types;
return $this;
}
/**
* Returns the type of the given column. If there is no single use type is configured,
* the column type will be looked for inside the default mapping. If neither exist,
* null will be returned.
*
* @var null|string
*/
public function type($column) {
if (isset($this->_types[$column])) {
return $this->_types[$column];
}
if (isset($this->_defaults[$column])) {
return $this->_defaults[$column];
}
return null;
}
}