blob: 0e92e3ab83c61cea315732abe0dec25e7ca1b68f (
plain)
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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
|
<?php
namespace Civi\Api4\Service\Schema\Joinable;
use Civi\Api4\Service\Spec\FieldSpec;
use CRM_Core_DAO_AllCoreTables as Tables;
class Joinable {
const JOIN_SIDE_LEFT = 'LEFT';
const JOIN_SIDE_INNER = 'INNER';
const JOIN_TYPE_ONE_TO_ONE = '1_to_1';
const JOIN_TYPE_MANY_TO_ONE = 'n_to_1';
const JOIN_TYPE_ONE_TO_MANY = '1_to_n';
/**
* @var string
*/
protected $baseTable;
/**
* @var string
*/
protected $baseColumn;
/**
* @var string
*/
protected $targetTable;
/**
* @var string
*
* Name (or alias) of the target column)
*/
protected $targetColumn;
/**
* @var string
*/
protected $alias;
/**
* @var array
*/
protected $conditions = [];
/**
* @var string
*/
protected $joinSide = self::JOIN_SIDE_LEFT;
/**
* @var int
*/
protected $joinType = self::JOIN_TYPE_ONE_TO_ONE;
/**
* @var string
*/
protected $entity;
/**
* @var array
*/
protected $entityFields;
/**
* @param $targetTable
* @param $targetColumn
* @param string|null $alias
*/
public function __construct($targetTable, $targetColumn, $alias = NULL) {
$this->targetTable = $targetTable;
$this->targetColumn = $targetColumn;
if (!$this->entity) {
$this->entity = Tables::getBriefName(Tables::getClassForTable($targetTable));
}
$this->alias = $alias ?: str_replace('civicrm_', '', $targetTable);
}
/**
* Gets conditions required when joining to a base table
*
* @param string|null $baseTableAlias
* Name of the base table, if aliased.
*
* @return array
*/
public function getConditionsForJoin($baseTableAlias = NULL) {
$baseCondition = sprintf(
'%s.%s = %s.%s',
$baseTableAlias ?: $this->baseTable,
$this->baseColumn,
$this->getAlias(),
$this->targetColumn
);
return array_merge([$baseCondition], $this->conditions);
}
/**
* @return string
*/
public function getBaseTable() {
return $this->baseTable;
}
/**
* @param string $baseTable
*
* @return $this
*/
public function setBaseTable($baseTable) {
$this->baseTable = $baseTable;
return $this;
}
/**
* @return string
*/
public function getBaseColumn() {
return $this->baseColumn;
}
/**
* @param string $baseColumn
*
* @return $this
*/
public function setBaseColumn($baseColumn) {
$this->baseColumn = $baseColumn;
return $this;
}
/**
* @return string
*/
public function getAlias() {
return $this->alias;
}
/**
* @param string $alias
*
* @return $this
*/
public function setAlias($alias) {
$this->alias = $alias;
return $this;
}
/**
* @return string
*/
public function getTargetTable() {
return $this->targetTable;
}
/**
* @return string
*/
public function getTargetColumn() {
return $this->targetColumn;
}
/**
* @return string
*/
public function getEntity() {
return $this->entity;
}
/**
* @param $condition
*
* @return $this
*/
public function addCondition($condition) {
$this->conditions[] = $condition;
return $this;
}
/**
* @return array
*/
public function getExtraJoinConditions() {
return $this->conditions;
}
/**
* @param array $conditions
*
* @return $this
*/
public function setConditions($conditions) {
$this->conditions = $conditions;
return $this;
}
/**
* @return string
*/
public function getJoinSide() {
return $this->joinSide;
}
/**
* @param string $joinSide
*
* @return $this
*/
public function setJoinSide($joinSide) {
$this->joinSide = $joinSide;
return $this;
}
/**
* @return int
*/
public function getJoinType() {
return $this->joinType;
}
/**
* @param int $joinType
*
* @return $this
*/
public function setJoinType($joinType) {
$this->joinType = $joinType;
return $this;
}
/**
* @return array
*/
public function toArray() {
return get_object_vars($this);
}
/**
* @return \Civi\Api4\Service\Spec\FieldSpec[]
*/
public function getEntityFields() {
if (!$this->entityFields) {
$bao = Tables::getClassForTable($this->getTargetTable());
if ($bao) {
foreach ($bao::fields() as $field) {
$this->entityFields[] = \Civi\Api4\Service\Spec\SpecFormatter::arrayToField($field, $this->getEntity());
}
}
}
return $this->entityFields;
}
/**
* @return \Civi\Api4\Service\Spec\FieldSpec|NULL
*/
public function getField($fieldName) {
foreach ($this->getEntityFields() as $field) {
if ($field->getName() === $fieldName) {
return $field;
}
}
return NULL;
}
}
|
