|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
namespace mindplay\sql\model\components; |
|
4
|
|
|
|
|
5
|
|
|
use mindplay\sql\framework\Driver; |
|
6
|
|
|
use mindplay\sql\framework\mappers\TypeMapper; |
|
7
|
|
|
use mindplay\sql\framework\TypeProvider; |
|
8
|
|
|
use mindplay\sql\model\Column; |
|
9
|
|
|
use mindplay\sql\model\Table; |
|
10
|
|
|
use mindplay\sql\model\Type; |
|
11
|
|
|
use OutOfBoundsException; |
|
12
|
|
|
|
|
13
|
|
|
/** |
|
14
|
|
|
* This component implements support for return variable expressions (for use in a SELECT or RETURNING clause) |
|
15
|
|
|
*/ |
|
16
|
|
|
class ReturnVars |
|
17
|
|
|
{ |
|
18
|
|
|
/** |
|
19
|
|
|
* @var string[] list of return variable expressions (for use in a SELECT or RETURNING clause) |
|
20
|
|
|
*/ |
|
21
|
|
|
private $vars = []; |
|
22
|
|
|
|
|
23
|
|
|
/** |
|
24
|
|
|
* @var Type[] map where return variable name maps to Type |
|
25
|
|
|
*/ |
|
26
|
|
|
private $type_map = []; |
|
27
|
|
|
|
|
28
|
|
|
/** |
|
29
|
|
|
* @var Table |
|
30
|
|
|
*/ |
|
31
|
|
|
private $root; |
|
32
|
|
|
|
|
33
|
|
|
/** |
|
34
|
|
|
* @var Driver |
|
35
|
|
|
*/ |
|
36
|
|
|
private $driver; |
|
37
|
|
|
|
|
38
|
|
|
/** |
|
39
|
|
|
* @var TypeProvider |
|
40
|
|
|
*/ |
|
41
|
|
|
private $types; |
|
42
|
|
|
|
|
43
|
|
|
/** |
|
44
|
|
|
* @param Table $root |
|
45
|
|
|
* @param Driver $driver |
|
46
|
|
|
* @param TypeProvider $types |
|
47
|
|
|
*/ |
|
48
|
1 |
|
public function __construct(Table $root, Driver $driver, TypeProvider $types) |
|
49
|
|
|
{ |
|
50
|
1 |
|
$this->root = $root; |
|
51
|
1 |
|
$this->driver = $driver; |
|
52
|
1 |
|
$this->types = $types; |
|
53
|
1 |
|
} |
|
54
|
|
|
|
|
55
|
|
|
/** |
|
56
|
|
|
* Add all the Columns of a full Table to be selected and returned |
|
57
|
|
|
* |
|
58
|
|
|
* @param Table $table Table to select and return |
|
59
|
|
|
*/ |
|
60
|
1 |
|
public function addTable(Table $table) |
|
61
|
|
|
{ |
|
62
|
1 |
|
$this->vars[] = "{$table}.*"; |
|
63
|
|
|
|
|
64
|
1 |
|
$this->type_map = array_merge($this->type_map, $this->createTypeMap($table)); |
|
65
|
1 |
|
} |
|
66
|
|
|
|
|
67
|
|
|
/** |
|
68
|
|
|
* Add one or more Columns to select and return |
|
69
|
|
|
* |
|
70
|
|
|
* @param Column|Column[] one or more Columns to select and return |
|
71
|
|
|
*/ |
|
72
|
1 |
|
public function addColumns($cols) |
|
73
|
|
|
{ |
|
74
|
|
|
/** |
|
75
|
|
|
* @var Column[] $cols |
|
76
|
|
|
*/ |
|
77
|
|
|
|
|
78
|
1 |
|
$cols = is_array($cols) ? $cols : [$cols]; |
|
79
|
|
|
|
|
80
|
1 |
|
foreach ($cols as $col) { |
|
81
|
1 |
|
$alias = $col->getAlias(); |
|
82
|
|
|
|
|
83
|
1 |
|
$col_name = $alias ?: $col->getName(); |
|
84
|
|
|
|
|
85
|
1 |
|
$table = $col->getTable(); |
|
86
|
|
|
|
|
87
|
1 |
|
$table_name = $table->getAlias() ?: $table->getName(); |
|
88
|
|
|
|
|
89
|
1 |
|
$column_expr = $this->driver->quoteName($table_name) . '.' . $this->driver->quoteName($col->getName()); |
|
90
|
|
|
|
|
91
|
1 |
|
$this->vars[$col_name] = $alias |
|
92
|
1 |
|
? "{$column_expr} AS " . $this->driver->quoteName($col_name) |
|
93
|
1 |
|
: "{$column_expr}"; |
|
94
|
|
|
|
|
95
|
1 |
|
$this->type_map[$col_name] = $col->getType(); |
|
96
|
|
|
} |
|
97
|
1 |
|
} |
|
98
|
|
|
|
|
99
|
|
|
/** |
|
100
|
|
|
* Add an SQL expression to select and return |
|
101
|
|
|
* |
|
102
|
|
|
* @param string $expr return expression |
|
103
|
|
|
* @param string|null $name return variable name (optional, but usually required) |
|
104
|
|
|
* @param Type|string|null $type optional Type (or Type class-name) |
|
105
|
|
|
*/ |
|
106
|
1 |
|
public function addValue($expr, $name = null, $type = null) |
|
107
|
|
|
{ |
|
108
|
1 |
|
if (isset($this->vars[$name])) { |
|
109
|
|
|
throw new OutOfBoundsException("duplicate return variable name: {$name}"); |
|
110
|
|
|
} |
|
111
|
|
|
|
|
112
|
1 |
|
if ($name === null) { |
|
113
|
1 |
|
$this->vars[] = "{$expr}"; |
|
114
|
|
|
} else { |
|
115
|
1 |
|
$quoted_name = $this->driver->quoteName($name); |
|
116
|
|
|
|
|
117
|
1 |
|
$this->vars[$name] = "{$expr} AS {$quoted_name}"; |
|
118
|
|
|
|
|
119
|
1 |
|
if ($type !== null) { |
|
120
|
1 |
|
$this->type_map[$name] = is_string($type) |
|
121
|
1 |
|
? $this->types->getType($type) |
|
122
|
|
|
: $type; // assumes Type instance |
|
123
|
|
|
} |
|
124
|
|
|
} |
|
125
|
1 |
|
} |
|
126
|
|
|
|
|
127
|
|
|
/** |
|
128
|
|
|
* @return TypeMapper |
|
129
|
|
|
*/ |
|
130
|
1 |
|
public function createTypeMapper() |
|
131
|
|
|
{ |
|
132
|
1 |
|
$type_map = $this->type_map; |
|
133
|
|
|
|
|
134
|
1 |
|
if (count($this->vars) === 0) { |
|
135
|
|
|
// no defined return vars - buildReturnVars() will auto-select the root node, so |
|
136
|
|
|
// we need to add root Column Types to the TypeMapper we're creating here: |
|
137
|
|
|
|
|
138
|
1 |
|
$type_map = array_merge($this->createTypeMap($this->root), $type_map); |
|
139
|
|
|
} |
|
140
|
|
|
|
|
141
|
1 |
|
return new TypeMapper($type_map); |
|
142
|
|
|
} |
|
143
|
|
|
|
|
144
|
|
|
/** |
|
145
|
|
|
* @return bool true, if any return vars have been added |
|
146
|
|
|
*/ |
|
147
|
1 |
|
public function hasReturnVars() |
|
148
|
|
|
{ |
|
149
|
1 |
|
return count($this->vars) > 0; |
|
150
|
|
|
} |
|
151
|
|
|
|
|
152
|
|
|
/** |
|
153
|
|
|
* @return string comma-separated return expressions (for use in the SELECT or RETURNING clause of an SQL query) |
|
154
|
|
|
*/ |
|
155
|
1 |
|
public function buildReturnVars() |
|
156
|
|
|
{ |
|
157
|
1 |
|
$vars = $this->vars; |
|
158
|
|
|
|
|
159
|
1 |
|
if (count($vars) === 0) { |
|
160
|
|
|
// no defined return vars - createTypeMapper() will create a Type-map for the root node, |
|
161
|
|
|
// so we need to auto-select the root node here: |
|
162
|
|
|
|
|
163
|
1 |
|
$vars[] = "{$this->root}.*"; |
|
164
|
|
|
} |
|
165
|
|
|
|
|
166
|
1 |
|
return implode(",\n ", $vars); |
|
167
|
|
|
} |
|
168
|
|
|
|
|
169
|
|
|
/** |
|
170
|
|
|
* Internally creates a full Type-map for all Columns in a given Table |
|
171
|
|
|
* |
|
172
|
|
|
* @param Table $table |
|
173
|
|
|
* |
|
174
|
|
|
* @return Type[] map where Column Alias maps to Type |
|
175
|
|
|
*/ |
|
176
|
1 |
|
private function createTypeMap(Table $table) |
|
177
|
|
|
{ |
|
178
|
1 |
|
$type_map = []; |
|
179
|
|
|
|
|
180
|
1 |
|
foreach ($table->listColumns() as $column) { |
|
181
|
1 |
|
$type_map[$column->getAlias() ?: $column->getName()] = $column->getType(); |
|
182
|
|
|
} |
|
183
|
|
|
|
|
184
|
1 |
|
return $type_map; |
|
185
|
|
|
} |
|
186
|
|
|
} |
|
187
|
|
|
|
mindplay-dk /
sql
