FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
database/TypeMap.php at 5.x · cakephp/database · GitHub
cakephp
/
database
Public
Notifications
You must be signed in to change notification settings
Fork
13
Star
98
Code
Actions
Security and quality
0
Insights
Additional navigation options
Code
Actions
Security and quality
Insights
Expand file tree
Breadcrumbs
database
/
TypeMap.php
Copy path
More file actions
More file actions
Latest commit
History
History
History
160 lines (147 loc) · 4.5 KB
Breadcrumbs
database
/
TypeMap.php
Copy path
File metadata and controls
160 lines (147 loc) · 4.5 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
<?php
declare
(strict_types=
1
);
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://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. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 3.0.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace
Cake
\
Database
;
/**
* Implements default and single-use mappings for columns to their associated types
*/
class
TypeMap
{
/**
* Array with the default fields and the related types this query might contain.
*
* Used to avoid repetition when calling multiple functions inside this class that
* may require a custom type for a specific field.
*
* @var array<int|string, string>
*/
protected
array
$
_defaults
= [];
/**
* Array with the fields and the related types that override defaults this query might contain
*
* Used to avoid repetition when calling multiple functions inside this class that
* may require a custom type for a specific field.
*
* @var array<int|string, string>
*/
protected
array
$
_types
= [];
/**
* Creates an instance with the given defaults
*
* @param array<int|string, string> $defaults The defaults to use.
*/
public
function
__construct
(
array
$
defaults
= [])
{
$
this
->
setDefaults
(
$
defaults
);
}
/**
* Configures a map of fields and associated type.
*
* These values will be used as the default mapping of types for every function
* in this instance that supports a `$types` param.
*
* This method is useful when you want to avoid repeating type definitions
* as setting types overwrites the last set of types.
*
* ### Example
*
* ```
* $query->setDefaults(['created' => 'datetime', 'is_visible' => 'boolean']);
* ```
*
* This method will replace all the existing default mappings with the ones provided.
* To add into the mappings use `addDefaults()`.
*
* @param array<int|string, string> $defaults Array where keys are field names / positions and values
* are the correspondent type.
* @return $this
*/
public
function
setDefaults
(
array
$
defaults
)
{
$
this
->
_defaults
=
$
defaults
;
return
$
this
;
}
/**
* Returns the currently configured types.
*
* @return array<int|string, string>
*/
public
function
getDefaults
():
array
{
return
$
this
->
_defaults
;
}
/**
* Add additional default types into the type map.
*
* If a key already exists it will not be overwritten.
*
* @param array<int|string, string> $types The additional types to add.
* @return void
*/
public
function
addDefaults
(
array
$
types
):
void
{
$
this
->
_defaults
+=
$
types
;
}
/**
* Sets a map of fields and their associated types for single-use.
*
* ### Example
*
* ```
* $query->setTypes(['created' => 'time']);
* ```
*
* This method will replace all the existing type maps with the ones provided.
*
* @param array<int|string, string> $types Array where keys are field names / positions and values
* are the correspondent type.
* @return $this
*/
public
function
setTypes
(
array
$
types
)
{
$
this
->
_types
=
$
types
;
return
$
this
;
}
/**
* Gets a map of fields and their associated types for single-use.
*
* @return array<int|string, string>
*/
public
function
getTypes
():
array
{
return
$
this
->
_types
;
}
/**
* 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.
*
* @param string|int $column The type for a given column
* @return string|null
*/
public
function
type
(
string
|
int
$
column
): ?
string
{
return
$
this
->
_types
[
$
column
] ??
$
this
->
_defaults
[
$
column
] ??
null
;
}
/**
* Returns an array of all types mapped types
*
* @return array<int|string, string>
*/
public
function
toArray
():
array
{
return
$
this
->
_types
+
$
this
->
_defaults
;
}
}
Back
|
FazBrowse Home
|
New Git URL