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
|
<?php
declare(strict_types=1);
namespace Doctrine\DBAL\Query\Expression;
use Doctrine\DBAL\Connection;
use function implode;
use function sprintf;
/**
* ExpressionBuilder class is responsible to dynamically create SQL query parts.
*/
class ExpressionBuilder
{
final public const EQ = '=';
final public const NEQ = '<>';
final public const LT = '<';
final public const LTE = '<=';
final public const GT = '>';
final public const GTE = '>=';
/**
* Initializes a new <tt>ExpressionBuilder</tt>.
*
* @param Connection $connection The DBAL Connection.
*/
public function __construct(private readonly Connection $connection)
{
}
/**
* Creates a conjunction of the given expressions.
*/
public function and(
string|CompositeExpression $expression,
string|CompositeExpression ...$expressions,
): CompositeExpression {
return CompositeExpression::and($expression, ...$expressions);
}
/**
* Creates a disjunction of the given expressions.
*/
public function or(
string|CompositeExpression $expression,
string|CompositeExpression ...$expressions,
): CompositeExpression {
return CompositeExpression::or($expression, ...$expressions);
}
/**
* Creates a comparison expression.
*
* @param string $x The left expression.
* @param string $operator The comparison operator.
* @param string $y The right expression.
*/
public function comparison(string $x, string $operator, string $y): string
{
return $x . ' ' . $operator . ' ' . $y;
}
/**
* Creates an equality comparison expression with the given arguments.
*
* First argument is considered the left expression and the second is the right expression.
* When converted to string, it will generated a <left expr> = <right expr>. Example:
*
* [php]
* // u.id = ?
* $expr->eq('u.id', '?');
*
* @param string $x The left expression.
* @param string $y The right expression.
*/
public function eq(string $x, string $y): string
{
return $this->comparison($x, self::EQ, $y);
}
/**
* Creates a non equality comparison expression with the given arguments.
* First argument is considered the left expression and the second is the right expression.
* When converted to string, it will generated a <left expr> <> <right expr>. Example:
*
* [php]
* // u.id <> 1
* $q->where($q->expr()->neq('u.id', '1'));
*
* @param string $x The left expression.
* @param string $y The right expression.
*/
public function neq(string $x, string $y): string
{
return $this->comparison($x, self::NEQ, $y);
}
/**
* Creates a lower-than comparison expression with the given arguments.
* First argument is considered the left expression and the second is the right expression.
* When converted to string, it will generated a <left expr> < <right expr>. Example:
*
* [php]
* // u.id < ?
* $q->where($q->expr()->lt('u.id', '?'));
*
* @param string $x The left expression.
* @param string $y The right expression.
*/
public function lt(string $x, string $y): string
{
return $this->comparison($x, self::LT, $y);
}
/**
* Creates a lower-than-equal comparison expression with the given arguments.
* First argument is considered the left expression and the second is the right expression.
* When converted to string, it will generated a <left expr> <= <right expr>. Example:
*
* [php]
* // u.id <= ?
* $q->where($q->expr()->lte('u.id', '?'));
*
* @param string $x The left expression.
* @param string $y The right expression.
*/
public function lte(string $x, string $y): string
{
return $this->comparison($x, self::LTE, $y);
}
/**
* Creates a greater-than comparison expression with the given arguments.
* First argument is considered the left expression and the second is the right expression.
* When converted to string, it will generated a <left expr> > <right expr>. Example:
*
* [php]
* // u.id > ?
* $q->where($q->expr()->gt('u.id', '?'));
*
* @param string $x The left expression.
* @param string $y The right expression.
*/
public function gt(string $x, string $y): string
{
return $this->comparison($x, self::GT, $y);
}
/**
* Creates a greater-than-equal comparison expression with the given arguments.
* First argument is considered the left expression and the second is the right expression.
* When converted to string, it will generated a <left expr> >= <right expr>. Example:
*
* [php]
* // u.id >= ?
* $q->where($q->expr()->gte('u.id', '?'));
*
* @param string $x The left expression.
* @param string $y The right expression.
*/
public function gte(string $x, string $y): string
{
return $this->comparison($x, self::GTE, $y);
}
/**
* Creates an IS NULL expression with the given arguments.
*
* @param string $x The expression to be restricted by IS NULL.
*/
public function isNull(string $x): string
{
return $x . ' IS NULL';
}
/**
* Creates an IS NOT NULL expression with the given arguments.
*
* @param string $x The expression to be restricted by IS NOT NULL.
*/
public function isNotNull(string $x): string
{
return $x . ' IS NOT NULL';
}
/**
* Creates a LIKE comparison expression.
*
* @param string $expression The expression to be inspected by the LIKE comparison
* @param string $pattern The pattern to compare against
*/
public function like(string $expression, string $pattern, ?string $escapeChar = null): string
{
return $this->comparison($expression, 'LIKE', $pattern) .
($escapeChar !== null ? sprintf(' ESCAPE %s', $escapeChar) : '');
}
/**
* Creates a NOT LIKE comparison expression
*
* @param string $expression The expression to be inspected by the NOT LIKE comparison
* @param string $pattern The pattern to compare against
*/
public function notLike(string $expression, string $pattern, ?string $escapeChar = null): string
{
return $this->comparison($expression, 'NOT LIKE', $pattern) .
($escapeChar !== null ? sprintf(' ESCAPE %s', $escapeChar) : '');
}
/**
* Creates an IN () comparison expression with the given arguments.
*
* @param string $x The SQL expression to be matched against the set.
* @param string|string[] $y The SQL expression or an array of SQL expressions representing the set.
*/
public function in(string $x, string|array $y): string
{
return $this->comparison($x, 'IN', '(' . implode(', ', (array) $y) . ')');
}
/**
* Creates a NOT IN () comparison expression with the given arguments.
*
* @param string $x The SQL expression to be matched against the set.
* @param string|string[] $y The SQL expression or an array of SQL expressions representing the set.
*/
public function notIn(string $x, string|array $y): string
{
return $this->comparison($x, 'NOT IN', '(' . implode(', ', (array) $y) . ')');
}
/**
* Creates an SQL literal expression from the string.
*
* The usage of this method is discouraged. Use prepared statements
* or {@see AbstractPlatform::quoteStringLiteral()} instead.
*/
public function literal(string $input): string
{
return $this->connection->quote($input);
}
}
|