aboutsummaryrefslogtreecommitdiffstats
path: root/lib/private/DB/QueryBuilder
diff options
context:
space:
mode:
authorprovokateurin <kate@provokateurin.de>2024-09-06 09:44:04 +0200
committerprovokateurin <kate@provokateurin.de>2024-09-09 11:09:37 +0200
commit007be83a968e6aee649ff8de173163cb5ef93a86 (patch)
tree18e03c4a5562989bbd6482e9e6a47f3619b71e30 /lib/private/DB/QueryBuilder
parentfc10fa592626d154a91d77d35c93beabdc7605c1 (diff)
downloadnextcloud-server-fix/oc/inheritdoc.tar.gz
nextcloud-server-fix/oc/inheritdoc.zip
fix(OC): Remove doc blocks for OCP implementationsfix/oc/inheritdoc
Signed-off-by: provokateurin <kate@provokateurin.de>
Diffstat (limited to 'lib/private/DB/QueryBuilder')
-rw-r--r--lib/private/DB/QueryBuilder/CompositeExpression.php24
-rw-r--r--lib/private/DB/QueryBuilder/ExpressionBuilder/ExpressionBuilder.php248
-rw-r--r--lib/private/DB/QueryBuilder/QueryBuilder.php698
3 files changed, 0 insertions, 970 deletions
diff --git a/lib/private/DB/QueryBuilder/CompositeExpression.php b/lib/private/DB/QueryBuilder/CompositeExpression.php
index 6edf385360c..4532314644e 100644
--- a/lib/private/DB/QueryBuilder/CompositeExpression.php
+++ b/lib/private/DB/QueryBuilder/CompositeExpression.php
@@ -20,13 +20,6 @@ class CompositeExpression implements ICompositeExpression, \Countable {
) {
}
- /**
- * Adds multiple parts to composite expression.
- *
- * @param array $parts
- *
- * @return \OCP\DB\QueryBuilder\ICompositeExpression
- */
public function addMultiple(array $parts = []): ICompositeExpression {
foreach ($parts as $part) {
$this->add($part);
@@ -35,13 +28,6 @@ class CompositeExpression implements ICompositeExpression, \Countable {
return $this;
}
- /**
- * Adds an expression to composite expression.
- *
- * @param mixed $part
- *
- * @return \OCP\DB\QueryBuilder\ICompositeExpression
- */
public function add($part): ICompositeExpression {
if ($part === null) {
return $this;
@@ -56,20 +42,10 @@ class CompositeExpression implements ICompositeExpression, \Countable {
return $this;
}
- /**
- * Retrieves the amount of expressions on composite expression.
- *
- * @return integer
- */
public function count(): int {
return count($this->parts);
}
- /**
- * Returns the type of this composite expression (AND/OR).
- *
- * @return string
- */
public function getType(): string {
return $this->type;
}
diff --git a/lib/private/DB/QueryBuilder/ExpressionBuilder/ExpressionBuilder.php b/lib/private/DB/QueryBuilder/ExpressionBuilder/ExpressionBuilder.php
index b922c861630..1a89165951a 100644
--- a/lib/private/DB/QueryBuilder/ExpressionBuilder/ExpressionBuilder.php
+++ b/lib/private/DB/QueryBuilder/ExpressionBuilder/ExpressionBuilder.php
@@ -17,7 +17,6 @@ use OC\DB\QueryBuilder\QuoteHelper;
use OCP\DB\QueryBuilder\ICompositeExpression;
use OCP\DB\QueryBuilder\IExpressionBuilder;
use OCP\DB\QueryBuilder\ILiteral;
-use OCP\DB\QueryBuilder\IParameter;
use OCP\DB\QueryBuilder\IQueryBuilder;
use OCP\DB\QueryBuilder\IQueryFunction;
use OCP\IDBConnection;
@@ -47,20 +46,6 @@ class ExpressionBuilder implements IExpressionBuilder {
$this->functionBuilder = $queryBuilder->func();
}
- /**
- * Creates a conjunction of the given boolean expressions.
- *
- * Example:
- *
- * [php]
- * // (u.type = ?) AND (u.role = ?)
- * $expr->andX('u.type = ?', 'u.role = ?'));
- *
- * @param mixed ...$x Optional clause. Defaults = null, but requires
- * at least one defined when converting to string.
- *
- * @return \OCP\DB\QueryBuilder\ICompositeExpression
- */
public function andX(...$x): ICompositeExpression {
if (empty($x)) {
$this->logger->debug('Calling ' . IQueryBuilder::class . '::' . __FUNCTION__ . ' without parameters is deprecated and will throw soon.', ['exception' => new \Exception('No parameters in call to ' . __METHOD__)]);
@@ -68,20 +53,6 @@ class ExpressionBuilder implements IExpressionBuilder {
return new CompositeExpression(CompositeExpression::TYPE_AND, $x);
}
- /**
- * Creates a disjunction of the given boolean expressions.
- *
- * Example:
- *
- * [php]
- * // (u.type = ?) OR (u.role = ?)
- * $qb->where($qb->expr()->orX('u.type = ?', 'u.role = ?'));
- *
- * @param mixed ...$x Optional clause. Defaults = null, but requires
- * at least one defined when converting to string.
- *
- * @return \OCP\DB\QueryBuilder\ICompositeExpression
- */
public function orX(...$x): ICompositeExpression {
if (empty($x)) {
$this->logger->debug('Calling ' . IQueryBuilder::class . '::' . __FUNCTION__ . ' without parameters is deprecated and will throw soon.', ['exception' => new \Exception('No parameters in call to ' . __METHOD__)]);
@@ -89,289 +60,94 @@ class ExpressionBuilder implements IExpressionBuilder {
return new CompositeExpression(CompositeExpression::TYPE_OR, $x);
}
- /**
- * Creates a comparison expression.
- *
- * @param mixed $x The left expression.
- * @param string $operator One of the IExpressionBuilder::* constants.
- * @param mixed $y The right expression.
- * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants
- * required when comparing text fields for oci compatibility
- *
- * @return string
- */
public function comparison($x, string $operator, $y, $type = null): string {
$x = $this->prepareColumn($x, $type);
$y = $this->prepareColumn($y, $type);
return $this->expressionBuilder->comparison($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 mixed $x The left expression.
- * @param mixed $y The right expression.
- * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants
- * required when comparing text fields for oci compatibility
- *
- * @return string
- */
public function eq($x, $y, $type = null): string {
$x = $this->prepareColumn($x, $type);
$y = $this->prepareColumn($y, $type);
return $this->expressionBuilder->eq($x, $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 mixed $x The left expression.
- * @param mixed $y The right expression.
- * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants
- * required when comparing text fields for oci compatibility
- *
- * @return string
- */
public function neq($x, $y, $type = null): string {
$x = $this->prepareColumn($x, $type);
$y = $this->prepareColumn($y, $type);
return $this->expressionBuilder->neq($x, $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 mixed $x The left expression.
- * @param mixed $y The right expression.
- * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants
- * required when comparing text fields for oci compatibility
- *
- * @return string
- */
public function lt($x, $y, $type = null): string {
$x = $this->prepareColumn($x, $type);
$y = $this->prepareColumn($y, $type);
return $this->expressionBuilder->lt($x, $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 mixed $x The left expression.
- * @param mixed $y The right expression.
- * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants
- * required when comparing text fields for oci compatibility
- *
- * @return string
- */
public function lte($x, $y, $type = null): string {
$x = $this->prepareColumn($x, $type);
$y = $this->prepareColumn($y, $type);
return $this->expressionBuilder->lte($x, $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 mixed $x The left expression.
- * @param mixed $y The right expression.
- * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants
- * required when comparing text fields for oci compatibility
- *
- * @return string
- */
public function gt($x, $y, $type = null): string {
$x = $this->prepareColumn($x, $type);
$y = $this->prepareColumn($y, $type);
return $this->expressionBuilder->gt($x, $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 mixed $x The left expression.
- * @param mixed $y The right expression.
- * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants
- * required when comparing text fields for oci compatibility
- *
- * @return string
- */
public function gte($x, $y, $type = null): string {
$x = $this->prepareColumn($x, $type);
$y = $this->prepareColumn($y, $type);
return $this->expressionBuilder->gte($x, $y);
}
- /**
- * Creates an IS NULL expression with the given arguments.
- *
- * @param string|ILiteral|IParameter|IQueryFunction $x The field in string format to be restricted by IS NULL.
- *
- * @return string
- */
public function isNull($x): string {
$x = $this->helper->quoteColumnName($x);
return $this->expressionBuilder->isNull($x);
}
- /**
- * Creates an IS NOT NULL expression with the given arguments.
- *
- * @param string|ILiteral|IParameter|IQueryFunction $x The field in string format to be restricted by IS NOT NULL.
- *
- * @return string
- */
public function isNotNull($x): string {
$x = $this->helper->quoteColumnName($x);
return $this->expressionBuilder->isNotNull($x);
}
- /**
- * Creates a LIKE() comparison expression with the given arguments.
- *
- * @param ILiteral|IParameter|IQueryFunction|string $x Field in string format to be inspected by LIKE() comparison.
- * @param mixed $y Argument to be used in LIKE() comparison.
- * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants
- * required when comparing text fields for oci compatibility
- *
- * @return string
- */
public function like($x, $y, $type = null): string {
$x = $this->helper->quoteColumnName($x);
$y = $this->helper->quoteColumnName($y);
return $this->expressionBuilder->like($x, $y);
}
- /**
- * Creates a ILIKE() comparison expression with the given arguments.
- *
- * @param string $x Field in string format to be inspected by ILIKE() comparison.
- * @param mixed $y Argument to be used in ILIKE() comparison.
- * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants
- * required when comparing text fields for oci compatibility
- *
- * @return string
- * @since 9.0.0
- */
public function iLike($x, $y, $type = null): string {
return $this->expressionBuilder->like($this->functionBuilder->lower($x), $this->functionBuilder->lower($y));
}
- /**
- * Creates a NOT LIKE() comparison expression with the given arguments.
- *
- * @param ILiteral|IParameter|IQueryFunction|string $x Field in string format to be inspected by NOT LIKE() comparison.
- * @param mixed $y Argument to be used in NOT LIKE() comparison.
- * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants
- * required when comparing text fields for oci compatibility
- *
- * @return string
- */
public function notLike($x, $y, $type = null): string {
$x = $this->helper->quoteColumnName($x);
$y = $this->helper->quoteColumnName($y);
return $this->expressionBuilder->notLike($x, $y);
}
- /**
- * Creates a IN () comparison expression with the given arguments.
- *
- * @param ILiteral|IParameter|IQueryFunction|string $x The field in string format to be inspected by IN() comparison.
- * @param ILiteral|IParameter|IQueryFunction|string|array $y The placeholder or the array of values to be used by IN() comparison.
- * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants
- * required when comparing text fields for oci compatibility
- *
- * @return string
- */
public function in($x, $y, $type = null): string {
$x = $this->helper->quoteColumnName($x);
$y = $this->helper->quoteColumnNames($y);
return $this->expressionBuilder->in($x, $y);
}
- /**
- * Creates a NOT IN () comparison expression with the given arguments.
- *
- * @param ILiteral|IParameter|IQueryFunction|string $x The field in string format to be inspected by NOT IN() comparison.
- * @param ILiteral|IParameter|IQueryFunction|string|array $y The placeholder or the array of values to be used by NOT IN() comparison.
- * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants
- * required when comparing text fields for oci compatibility
- *
- * @return string
- */
public function notIn($x, $y, $type = null): string {
$x = $this->helper->quoteColumnName($x);
$y = $this->helper->quoteColumnNames($y);
return $this->expressionBuilder->notIn($x, $y);
}
- /**
- * Creates a $x = '' statement, because Oracle needs a different check
- *
- * @param string|ILiteral|IParameter|IQueryFunction $x The field in string format to be inspected by the comparison.
- * @return string
- * @since 13.0.0
- */
public function emptyString($x): string {
return $this->eq($x, $this->literal('', IQueryBuilder::PARAM_STR));
}
- /**
- * Creates a `$x <> ''` statement, because Oracle needs a different check
- *
- * @param string|ILiteral|IParameter|IQueryFunction $x The field in string format to be inspected by the comparison.
- * @return string
- * @since 13.0.0
- */
public function nonEmptyString($x): string {
return $this->neq($x, $this->literal('', IQueryBuilder::PARAM_STR));
}
- /**
- * Binary AND Operator copies a bit to the result if it exists in both operands.
- *
- * @param string|ILiteral $x The field or value to check
- * @param int $y Bitmap that must be set
- * @return IQueryFunction
- * @since 12.0.0
- */
public function bitwiseAnd($x, int $y): IQueryFunction {
return new QueryFunction($this->connection->getDatabasePlatform()->getBitAndComparisonExpression(
$this->helper->quoteColumnName($x),
@@ -379,14 +155,6 @@ class ExpressionBuilder implements IExpressionBuilder {
));
}
- /**
- * Binary OR Operator copies a bit if it exists in either operand.
- *
- * @param string|ILiteral $x The field or value to check
- * @param int $y Bitmap that must be set
- * @return IQueryFunction
- * @since 12.0.0
- */
public function bitwiseOr($x, int $y): IQueryFunction {
return new QueryFunction($this->connection->getDatabasePlatform()->getBitOrComparisonExpression(
$this->helper->quoteColumnName($x),
@@ -394,26 +162,10 @@ class ExpressionBuilder implements IExpressionBuilder {
));
}
- /**
- * Quotes a given input parameter.
- *
- * @param mixed $input The parameter to be quoted.
- * @param int $type One of the IQueryBuilder::PARAM_* constants
- *
- * @return ILiteral
- */
public function literal($input, $type = IQueryBuilder::PARAM_STR): ILiteral {
return new Literal($this->expressionBuilder->literal($input, $type));
}
- /**
- * Returns a IQueryFunction that casts the column to the given type
- *
- * @param string|IQueryFunction $column
- * @param mixed $type One of IQueryBuilder::PARAM_*
- * @psalm-param IQueryBuilder::PARAM_* $type
- * @return IQueryFunction
- */
public function castColumn($column, $type): IQueryFunction {
return new QueryFunction(
$this->helper->quoteColumnName($column)
diff --git a/lib/private/DB/QueryBuilder/QueryBuilder.php b/lib/private/DB/QueryBuilder/QueryBuilder.php
index 5c7e273c9ec..4c1fc69e0ad 100644
--- a/lib/private/DB/QueryBuilder/QueryBuilder.php
+++ b/lib/private/DB/QueryBuilder/QueryBuilder.php
@@ -20,9 +20,6 @@ use OC\DB\QueryBuilder\FunctionBuilder\PgSqlFunctionBuilder;
use OC\DB\QueryBuilder\FunctionBuilder\SqliteFunctionBuilder;
use OC\SystemConfig;
use OCP\DB\IResult;
-use OCP\DB\QueryBuilder\ICompositeExpression;
-use OCP\DB\QueryBuilder\ILiteral;
-use OCP\DB\QueryBuilder\IParameter;
use OCP\DB\QueryBuilder\IQueryBuilder;
use OCP\DB\QueryBuilder\IQueryFunction;
use OCP\IDBConnection;
@@ -65,33 +62,10 @@ class QueryBuilder implements IQueryBuilder {
$this->helper = new QuoteHelper();
}
- /**
- * Enable/disable automatic prefixing of table names with the oc_ prefix
- *
- * @param bool $enabled If set to true table names will be prefixed with the
- * owncloud database prefix automatically.
- * @since 8.2.0
- */
public function automaticTablePrefix($enabled) {
$this->automaticTablePrefix = (bool)$enabled;
}
- /**
- * Gets an ExpressionBuilder used for object-oriented construction of query expressions.
- * This producer method is intended for convenient inline usage. Example:
- *
- * <code>
- * $qb = $conn->getQueryBuilder()
- * ->select('u')
- * ->from('users', 'u')
- * ->where($qb->expr()->eq('u.id', 1));
- * </code>
- *
- * For more complex expression construction, consider storing the expression
- * builder object in a local variable.
- *
- * @return \OCP\DB\QueryBuilder\IExpressionBuilder
- */
public function expr() {
return match($this->connection->getDatabaseProvider()) {
IDBConnection::PLATFORM_ORACLE => new OCIExpressionBuilder($this->connection, $this, $this->logger),
@@ -101,22 +75,6 @@ class QueryBuilder implements IQueryBuilder {
};
}
- /**
- * Gets an FunctionBuilder used for object-oriented construction of query functions.
- * This producer method is intended for convenient inline usage. Example:
- *
- * <code>
- * $qb = $conn->getQueryBuilder()
- * ->select('u')
- * ->from('users', 'u')
- * ->where($qb->fun()->md5('u.id'));
- * </code>
- *
- * For more complex function construction, consider storing the function
- * builder object in a local variable.
- *
- * @return \OCP\DB\QueryBuilder\IFunctionBuilder
- */
public function func() {
return match($this->connection->getDatabaseProvider()) {
IDBConnection::PLATFORM_ORACLE => new OCIFunctionBuilder($this->connection, $this, $this->helper),
@@ -126,31 +84,14 @@ class QueryBuilder implements IQueryBuilder {
};
}
- /**
- * Gets the type of the currently built query.
- *
- * @return integer
- */
public function getType() {
return $this->queryBuilder->getType();
}
- /**
- * Gets the associated DBAL Connection for this query builder.
- *
- * @return \OCP\IDBConnection
- */
public function getConnection() {
return $this->connection;
}
- /**
- * Gets the state of this query builder instance.
- *
- * @return int Always returns 0 which is former `QueryBuilder::STATE_DIRTY`
- * @deprecated 30.0.0 This function is going to be removed with the next Doctrine/DBAL update
- * and we can not fix this in our wrapper.
- */
public function getState() {
$this->logger->debug(IQueryBuilder::class . '::' . __FUNCTION__ . ' is deprecated and will be removed soon.', ['exception' => new \Exception('Deprecated call to ' . __METHOD__)]);
return $this->queryBuilder->getState();
@@ -235,14 +176,6 @@ class QueryBuilder implements IQueryBuilder {
}
}
- /**
- * Executes this query using the bound parameters and their types.
- *
- * Uses {@see Connection::executeQuery} for select statements and {@see Connection::executeUpdate}
- * for insert, update and delete statements.
- *
- * @return IResult|int
- */
public function execute(?IDBConnection $connection = null) {
try {
if ($this->getType() === \Doctrine\DBAL\Query\QueryBuilder::SELECT) {
@@ -294,144 +227,48 @@ class QueryBuilder implements IQueryBuilder {
}
- /**
- * Gets the complete SQL string formed by the current specifications of this QueryBuilder.
- *
- * <code>
- * $qb = $conn->getQueryBuilder()
- * ->select('u')
- * ->from('User', 'u')
- * echo $qb->getSQL(); // SELECT u FROM User u
- * </code>
- *
- * @return string The SQL query string.
- */
public function getSQL() {
return $this->queryBuilder->getSQL();
}
- /**
- * Sets a query parameter for the query being constructed.
- *
- * <code>
- * $qb = $conn->getQueryBuilder()
- * ->select('u')
- * ->from('users', 'u')
- * ->where('u.id = :user_id')
- * ->setParameter(':user_id', 1);
- * </code>
- *
- * @param string|integer $key The parameter position or name.
- * @param mixed $value The parameter value.
- * @param string|null|int $type One of the IQueryBuilder::PARAM_* constants.
- *
- * @return $this This QueryBuilder instance.
- */
public function setParameter($key, $value, $type = null) {
$this->queryBuilder->setParameter($key, $value, $type);
return $this;
}
- /**
- * Sets a collection of query parameters for the query being constructed.
- *
- * <code>
- * $qb = $conn->getQueryBuilder()
- * ->select('u')
- * ->from('users', 'u')
- * ->where('u.id = :user_id1 OR u.id = :user_id2')
- * ->setParameters(array(
- * ':user_id1' => 1,
- * ':user_id2' => 2
- * ));
- * </code>
- *
- * @param array $params The query parameters to set.
- * @param array $types The query parameters types to set.
- *
- * @return $this This QueryBuilder instance.
- */
public function setParameters(array $params, array $types = []) {
$this->queryBuilder->setParameters($params, $types);
return $this;
}
- /**
- * Gets all defined query parameters for the query being constructed indexed by parameter index or name.
- *
- * @return array The currently defined query parameters indexed by parameter index or name.
- */
public function getParameters() {
return $this->queryBuilder->getParameters();
}
- /**
- * Gets a (previously set) query parameter of the query being constructed.
- *
- * @param mixed $key The key (index or name) of the bound parameter.
- *
- * @return mixed The value of the bound parameter.
- */
public function getParameter($key) {
return $this->queryBuilder->getParameter($key);
}
- /**
- * Gets all defined query parameter types for the query being constructed indexed by parameter index or name.
- *
- * @return array The currently defined query parameter types indexed by parameter index or name.
- */
public function getParameterTypes() {
return $this->queryBuilder->getParameterTypes();
}
- /**
- * Gets a (previously set) query parameter type of the query being constructed.
- *
- * @param mixed $key The key (index or name) of the bound parameter type.
- *
- * @return mixed The value of the bound parameter type.
- */
public function getParameterType($key) {
return $this->queryBuilder->getParameterType($key);
}
- /**
- * Sets the position of the first result to retrieve (the "offset").
- *
- * @param int $firstResult The first result to return.
- *
- * @return $this This QueryBuilder instance.
- */
public function setFirstResult($firstResult) {
$this->queryBuilder->setFirstResult((int)$firstResult);
return $this;
}
- /**
- * Gets the position of the first result the query object was set to retrieve (the "offset").
- * Returns 0 if {@link setFirstResult} was not applied to this QueryBuilder.
- *
- * @return int The position of the first result.
- */
public function getFirstResult() {
return $this->queryBuilder->getFirstResult();
}
- /**
- * Sets the maximum number of results to retrieve (the "limit").
- *
- * NOTE: Setting max results to "0" will cause mixed behaviour. While most
- * of the databases will just return an empty result set, Oracle will return
- * all entries.
- *
- * @param int|null $maxResults The maximum number of results to retrieve.
- *
- * @return $this This QueryBuilder instance.
- */
public function setMaxResults($maxResults) {
if ($maxResults === null) {
$this->queryBuilder->setMaxResults($maxResults);
@@ -442,31 +279,10 @@ class QueryBuilder implements IQueryBuilder {
return $this;
}
- /**
- * Gets the maximum number of results the query object was set to retrieve (the "limit").
- * Returns NULL if {@link setMaxResults} was not applied to this query builder.
- *
- * @return int|null The maximum number of results.
- */
public function getMaxResults() {
return $this->queryBuilder->getMaxResults();
}
- /**
- * Specifies an item that is to be returned in the query result.
- * Replaces any previously specified selections, if any.
- *
- * <code>
- * $qb = $conn->getQueryBuilder()
- * ->select('u.id', 'p.id')
- * ->from('users', 'u')
- * ->leftJoin('u', 'phonenumbers', 'p', 'u.id = p.user_id');
- * </code>
- *
- * @param mixed ...$selects The selection expressions.
- *
- * '@return $this This QueryBuilder instance.
- */
public function select(...$selects) {
if (count($selects) === 1 && is_array($selects[0])) {
$selects = $selects[0];
@@ -480,21 +296,6 @@ class QueryBuilder implements IQueryBuilder {
return $this;
}
- /**
- * Specifies an item that is to be returned with a different name in the query result.
- *
- * <code>
- * $qb = $conn->getQueryBuilder()
- * ->selectAlias('u.id', 'user_id')
- * ->from('users', 'u')
- * ->leftJoin('u', 'phonenumbers', 'p', 'u.id = p.user_id');
- * </code>
- *
- * @param mixed $select The selection expressions.
- * @param string $alias The column alias used in the constructed query.
- *
- * @return $this This QueryBuilder instance.
- */
public function selectAlias($select, $alias) {
$this->queryBuilder->addSelect(
$this->helper->quoteColumnName($select) . ' AS ' . $this->helper->quoteColumnName($alias)
@@ -504,19 +305,6 @@ class QueryBuilder implements IQueryBuilder {
return $this;
}
- /**
- * Specifies an item that is to be returned uniquely in the query result.
- *
- * <code>
- * $qb = $conn->getQueryBuilder()
- * ->selectDistinct('type')
- * ->from('users');
- * </code>
- *
- * @param mixed $select The selection expressions.
- *
- * @return $this This QueryBuilder instance.
- */
public function selectDistinct($select) {
if (!is_array($select)) {
$select = [$select];
@@ -532,21 +320,6 @@ class QueryBuilder implements IQueryBuilder {
return $this;
}
- /**
- * Adds an item that is to be returned in the query result.
- *
- * <code>
- * $qb = $conn->getQueryBuilder()
- * ->select('u.id')
- * ->addSelect('p.id')
- * ->from('users', 'u')
- * ->leftJoin('u', 'phonenumbers', 'u.id = p.user_id');
- * </code>
- *
- * @param mixed ...$selects The selection expression.
- *
- * @return $this This QueryBuilder instance.
- */
public function addSelect(...$selects) {
if (count($selects) === 1 && is_array($selects[0])) {
$selects = $selects[0];
@@ -584,23 +357,6 @@ class QueryBuilder implements IQueryBuilder {
}, $this->selectedColumns));
}
- /**
- * Turns the query being built into a bulk delete query that ranges over
- * a certain table.
- *
- * <code>
- * $qb = $conn->getQueryBuilder()
- * ->delete('users', 'u')
- * ->where('u.id = :user_id');
- * ->setParameter(':user_id', 1);
- * </code>
- *
- * @param string $delete The table whose rows are subject to the deletion.
- * @param string $alias The table alias used in the constructed query.
- *
- * @return $this This QueryBuilder instance.
- * @since 30.0.0 Alias is deprecated and will no longer be used with the next Doctrine/DBAL update
- */
public function delete($delete = null, $alias = null) {
if ($alias !== null) {
$this->logger->debug('DELETE queries with alias are no longer supported and the provided alias is ignored', ['exception' => new \InvalidArgumentException('Table alias provided for DELETE query')]);
@@ -614,23 +370,6 @@ class QueryBuilder implements IQueryBuilder {
return $this;
}
- /**
- * Turns the query being built into a bulk update query that ranges over
- * a certain table
- *
- * <code>
- * $qb = $conn->getQueryBuilder()
- * ->update('users', 'u')
- * ->set('u.password', md5('password'))
- * ->where('u.id = ?');
- * </code>
- *
- * @param string $update The table whose rows are subject to the update.
- * @param string $alias The table alias used in the constructed query.
- *
- * @return $this This QueryBuilder instance.
- * @since 30.0.0 Alias is deprecated and will no longer be used with the next Doctrine/DBAL update
- */
public function update($update = null, $alias = null) {
if ($alias !== null) {
$this->logger->debug('UPDATE queries with alias are no longer supported and the provided alias is ignored', ['exception' => new \InvalidArgumentException('Table alias provided for UPDATE query')]);
@@ -644,25 +383,6 @@ class QueryBuilder implements IQueryBuilder {
return $this;
}
- /**
- * Turns the query being built into an insert query that inserts into
- * a certain table
- *
- * <code>
- * $qb = $conn->getQueryBuilder()
- * ->insert('users')
- * ->values(
- * array(
- * 'name' => '?',
- * 'password' => '?'
- * )
- * );
- * </code>
- *
- * @param string $insert The table into which the rows should be inserted.
- *
- * @return $this This QueryBuilder instance.
- */
public function insert($insert = null) {
$this->queryBuilder->insert(
$this->getTableName($insert)
@@ -673,21 +393,6 @@ class QueryBuilder implements IQueryBuilder {
return $this;
}
- /**
- * Creates and adds a query root corresponding to the table identified by the
- * given alias, forming a cartesian product with any existing query roots.
- *
- * <code>
- * $qb = $conn->getQueryBuilder()
- * ->select('u.id')
- * ->from('users', 'u')
- * </code>
- *
- * @param string|IQueryFunction $from The table.
- * @param string|null $alias The alias of the table.
- *
- * @return $this This QueryBuilder instance.
- */
public function from($from, $alias = null) {
$this->queryBuilder->from(
$this->getTableName($from),
@@ -697,23 +402,6 @@ class QueryBuilder implements IQueryBuilder {
return $this;
}
- /**
- * Creates and adds a join to the query.
- *
- * <code>
- * $qb = $conn->getQueryBuilder()
- * ->select('u.name')
- * ->from('users', 'u')
- * ->join('u', 'phonenumbers', 'p', 'p.is_primary = 1');
- * </code>
- *
- * @param string $fromAlias The alias that points to a from clause.
- * @param string $join The table name to join.
- * @param string $alias The alias of the join table.
- * @param string|ICompositeExpression|null $condition The condition for the join.
- *
- * @return $this This QueryBuilder instance.
- */
public function join($fromAlias, $join, $alias, $condition = null) {
$this->queryBuilder->join(
$this->quoteAlias($fromAlias),
@@ -725,23 +413,6 @@ class QueryBuilder implements IQueryBuilder {
return $this;
}
- /**
- * Creates and adds a join to the query.
- *
- * <code>
- * $qb = $conn->getQueryBuilder()
- * ->select('u.name')
- * ->from('users', 'u')
- * ->innerJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1');
- * </code>
- *
- * @param string $fromAlias The alias that points to a from clause.
- * @param string $join The table name to join.
- * @param string $alias The alias of the join table.
- * @param string|ICompositeExpression|null $condition The condition for the join.
- *
- * @return $this This QueryBuilder instance.
- */
public function innerJoin($fromAlias, $join, $alias, $condition = null) {
$this->queryBuilder->innerJoin(
$this->quoteAlias($fromAlias),
@@ -753,23 +424,6 @@ class QueryBuilder implements IQueryBuilder {
return $this;
}
- /**
- * Creates and adds a left join to the query.
- *
- * <code>
- * $qb = $conn->getQueryBuilder()
- * ->select('u.name')
- * ->from('users', 'u')
- * ->leftJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1');
- * </code>
- *
- * @param string $fromAlias The alias that points to a from clause.
- * @param string $join The table name to join.
- * @param string $alias The alias of the join table.
- * @param string|ICompositeExpression|null $condition The condition for the join.
- *
- * @return $this This QueryBuilder instance.
- */
public function leftJoin($fromAlias, $join, $alias, $condition = null) {
$this->queryBuilder->leftJoin(
$this->quoteAlias($fromAlias),
@@ -781,23 +435,6 @@ class QueryBuilder implements IQueryBuilder {
return $this;
}
- /**
- * Creates and adds a right join to the query.
- *
- * <code>
- * $qb = $conn->getQueryBuilder()
- * ->select('u.name')
- * ->from('users', 'u')
- * ->rightJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1');
- * </code>
- *
- * @param string $fromAlias The alias that points to a from clause.
- * @param string $join The table name to join.
- * @param string $alias The alias of the join table.
- * @param string|ICompositeExpression|null $condition The condition for the join.
- *
- * @return $this This QueryBuilder instance.
- */
public function rightJoin($fromAlias, $join, $alias, $condition = null) {
$this->queryBuilder->rightJoin(
$this->quoteAlias($fromAlias),
@@ -809,21 +446,6 @@ class QueryBuilder implements IQueryBuilder {
return $this;
}
- /**
- * Sets a new value for a column in a bulk update query.
- *
- * <code>
- * $qb = $conn->getQueryBuilder()
- * ->update('users', 'u')
- * ->set('u.password', md5('password'))
- * ->where('u.id = ?');
- * </code>
- *
- * @param string $key The column to set.
- * @param ILiteral|IParameter|IQueryFunction|string $value The value, expression, placeholder, etc.
- *
- * @return $this This QueryBuilder instance.
- */
public function set($key, $value) {
$this->queryBuilder->set(
$this->helper->quoteColumnName($key),
@@ -833,33 +455,6 @@ class QueryBuilder implements IQueryBuilder {
return $this;
}
- /**
- * Specifies one or more restrictions to the query result.
- * Replaces any previously specified restrictions, if any.
- *
- * <code>
- * $qb = $conn->getQueryBuilder()
- * ->select('u.name')
- * ->from('users', 'u')
- * ->where('u.id = ?');
- *
- * // You can optionally programmatically build and/or expressions
- * $qb = $conn->getQueryBuilder();
- *
- * $or = $qb->expr()->orx(
- * $qb->expr()->eq('u.id', 1),
- * $qb->expr()->eq('u.id', 2),
- * );
- *
- * $qb->update('users', 'u')
- * ->set('u.password', md5('password'))
- * ->where($or);
- * </code>
- *
- * @param mixed ...$predicates The restriction predicates.
- *
- * @return $this This QueryBuilder instance.
- */
public function where(...$predicates) {
if ($this->nonEmptyWhere && $this->systemConfig->getValue('debug', false)) {
// Only logging a warning, not throwing for now.
@@ -877,24 +472,6 @@ class QueryBuilder implements IQueryBuilder {
return $this;
}
- /**
- * Adds one or more restrictions to the query results, forming a logical
- * conjunction with any previously specified restrictions.
- *
- * <code>
- * $qb = $conn->getQueryBuilder()
- * ->select('u')
- * ->from('users', 'u')
- * ->where('u.username LIKE ?')
- * ->andWhere('u.is_active = 1');
- * </code>
- *
- * @param mixed ...$where The query restrictions.
- *
- * @return $this This QueryBuilder instance.
- *
- * @see where()
- */
public function andWhere(...$where) {
$this->nonEmptyWhere = true;
call_user_func_array(
@@ -905,24 +482,6 @@ class QueryBuilder implements IQueryBuilder {
return $this;
}
- /**
- * Adds one or more restrictions to the query results, forming a logical
- * disjunction with any previously specified restrictions.
- *
- * <code>
- * $qb = $conn->getQueryBuilder()
- * ->select('u.name')
- * ->from('users', 'u')
- * ->where('u.id = 1')
- * ->orWhere('u.id = 2');
- * </code>
- *
- * @param mixed ...$where The WHERE statement.
- *
- * @return $this This QueryBuilder instance.
- *
- * @see where()
- */
public function orWhere(...$where) {
$this->nonEmptyWhere = true;
call_user_func_array(
@@ -933,21 +492,6 @@ class QueryBuilder implements IQueryBuilder {
return $this;
}
- /**
- * Specifies a grouping over the results of the query.
- * Replaces any previously specified groupings, if any.
- *
- * <code>
- * $qb = $conn->getQueryBuilder()
- * ->select('u.name')
- * ->from('users', 'u')
- * ->groupBy('u.id');
- * </code>
- *
- * @param mixed ...$groupBys The grouping expression.
- *
- * @return $this This QueryBuilder instance.
- */
public function groupBy(...$groupBys) {
if (count($groupBys) === 1 && is_array($groupBys[0])) {
$groupBys = $groupBys[0];
@@ -961,21 +505,6 @@ class QueryBuilder implements IQueryBuilder {
return $this;
}
- /**
- * Adds a grouping expression to the query.
- *
- * <code>
- * $qb = $conn->getQueryBuilder()
- * ->select('u.name')
- * ->from('users', 'u')
- * ->groupBy('u.lastLogin');
- * ->addGroupBy('u.createdAt')
- * </code>
- *
- * @param mixed ...$groupBy The grouping expression.
- *
- * @return $this This QueryBuilder instance.
- */
public function addGroupBy(...$groupBy) {
call_user_func_array(
[$this->queryBuilder, 'addGroupBy'],
@@ -985,25 +514,6 @@ class QueryBuilder implements IQueryBuilder {
return $this;
}
- /**
- * Sets a value for a column in an insert query.
- *
- * <code>
- * $qb = $conn->getQueryBuilder()
- * ->insert('users')
- * ->values(
- * array(
- * 'name' => '?'
- * )
- * )
- * ->setValue('password', '?');
- * </code>
- *
- * @param string $column The column into which the value should be inserted.
- * @param IParameter|string $value The value that should be inserted into the column.
- *
- * @return $this This QueryBuilder instance.
- */
public function setValue($column, $value) {
$this->queryBuilder->setValue(
$this->helper->quoteColumnName($column),
@@ -1013,25 +523,6 @@ class QueryBuilder implements IQueryBuilder {
return $this;
}
- /**
- * Specifies values for an insert query indexed by column names.
- * Replaces any previous values, if any.
- *
- * <code>
- * $qb = $conn->getQueryBuilder()
- * ->insert('users')
- * ->values(
- * array(
- * 'name' => '?',
- * 'password' => '?'
- * )
- * );
- * </code>
- *
- * @param array $values The values to specify for the insert query indexed by column names.
- *
- * @return $this This QueryBuilder instance.
- */
public function values(array $values) {
$quotedValues = [];
foreach ($values as $key => $value) {
@@ -1043,14 +534,6 @@ class QueryBuilder implements IQueryBuilder {
return $this;
}
- /**
- * Specifies a restriction over the groups of the query.
- * Replaces any previous having restrictions, if any.
- *
- * @param mixed ...$having The restriction over the groups.
- *
- * @return $this This QueryBuilder instance.
- */
public function having(...$having) {
call_user_func_array(
[$this->queryBuilder, 'having'],
@@ -1060,14 +543,6 @@ class QueryBuilder implements IQueryBuilder {
return $this;
}
- /**
- * Adds a restriction over the groups of the query, forming a logical
- * conjunction with any existing having restrictions.
- *
- * @param mixed ...$having The restriction to append.
- *
- * @return $this This QueryBuilder instance.
- */
public function andHaving(...$having) {
call_user_func_array(
[$this->queryBuilder, 'andHaving'],
@@ -1077,14 +552,6 @@ class QueryBuilder implements IQueryBuilder {
return $this;
}
- /**
- * Adds a restriction over the groups of the query, forming a logical
- * disjunction with any existing having restrictions.
- *
- * @param mixed ...$having The restriction to add.
- *
- * @return $this This QueryBuilder instance.
- */
public function orHaving(...$having) {
call_user_func_array(
[$this->queryBuilder, 'orHaving'],
@@ -1094,15 +561,6 @@ class QueryBuilder implements IQueryBuilder {
return $this;
}
- /**
- * Specifies an ordering for the query results.
- * Replaces any previously specified orderings, if any.
- *
- * @param string|IQueryFunction|ILiteral|IParameter $sort The ordering expression.
- * @param string $order The ordering direction.
- *
- * @return $this This QueryBuilder instance.
- */
public function orderBy($sort, $order = null) {
$this->queryBuilder->orderBy(
$this->helper->quoteColumnName($sort),
@@ -1112,14 +570,6 @@ class QueryBuilder implements IQueryBuilder {
return $this;
}
- /**
- * Adds an ordering to the query results.
- *
- * @param string|ILiteral|IParameter|IQueryFunction $sort The ordering expression.
- * @param string $order The ordering direction.
- *
- * @return $this This QueryBuilder instance.
- */
public function addOrderBy($sort, $order = null) {
$this->queryBuilder->addOrderBy(
$this->helper->quoteColumnName($sort),
@@ -1129,41 +579,16 @@ class QueryBuilder implements IQueryBuilder {
return $this;
}
- /**
- * Gets a query part by its name.
- *
- * @param string $queryPartName
- *
- * @return mixed
- * @deprecated 30.0.0 This function is going to be removed with the next Doctrine/DBAL update
- * and we can not fix this in our wrapper. Please track the details you need, outside the object.
- */
public function getQueryPart($queryPartName) {
$this->logger->debug(IQueryBuilder::class . '::' . __FUNCTION__ . ' is deprecated and will be removed soon.', ['exception' => new \Exception('Deprecated call to ' . __METHOD__)]);
return $this->queryBuilder->getQueryPart($queryPartName);
}
- /**
- * Gets all query parts.
- *
- * @return array
- * @deprecated 30.0.0 This function is going to be removed with the next Doctrine/DBAL update
- * and we can not fix this in our wrapper. Please track the details you need, outside the object.
- */
public function getQueryParts() {
$this->logger->debug(IQueryBuilder::class . '::' . __FUNCTION__ . ' is deprecated and will be removed soon.', ['exception' => new \Exception('Deprecated call to ' . __METHOD__)]);
return $this->queryBuilder->getQueryParts();
}
- /**
- * Resets SQL parts.
- *
- * @param array|null $queryPartNames
- *
- * @return $this This QueryBuilder instance.
- * @deprecated 30.0.0 This function is going to be removed with the next Doctrine/DBAL update
- * and we can not fix this in our wrapper. Please create a new IQueryBuilder instead.
- */
public function resetQueryParts($queryPartNames = null) {
$this->logger->debug(IQueryBuilder::class . '::' . __FUNCTION__ . ' is deprecated and will be removed soon.', ['exception' => new \Exception('Deprecated call to ' . __METHOD__)]);
$this->queryBuilder->resetQueryParts($queryPartNames);
@@ -1171,15 +596,6 @@ class QueryBuilder implements IQueryBuilder {
return $this;
}
- /**
- * Resets a single SQL part.
- *
- * @param string $queryPartName
- *
- * @return $this This QueryBuilder instance.
- * @deprecated 30.0.0 This function is going to be removed with the next Doctrine/DBAL update
- * and we can not fix this in our wrapper. Please create a new IQueryBuilder instead.
- */
public function resetQueryPart($queryPartName) {
$this->logger->debug(IQueryBuilder::class . '::' . __FUNCTION__ . ' is deprecated and will be removed soon.', ['exception' => new \Exception('Deprecated call to ' . __METHOD__)]);
$this->queryBuilder->resetQueryPart($queryPartName);
@@ -1187,117 +603,22 @@ class QueryBuilder implements IQueryBuilder {
return $this;
}
- /**
- * Creates a new named parameter and bind the value $value to it.
- *
- * This method provides a shortcut for PDOStatement::bindValue
- * when using prepared statements.
- *
- * The parameter $value specifies the value that you want to bind. If
- * $placeholder is not provided bindValue() will automatically create a
- * placeholder for you. An automatic placeholder will be of the name
- * ':dcValue1', ':dcValue2' etc.
- *
- * For more information see {@link https://www.php.net/pdostatement-bindparam}
- *
- * Example:
- * <code>
- * $value = 2;
- * $q->eq( 'id', $q->bindValue( $value ) );
- * $stmt = $q->executeQuery(); // executed with 'id = 2'
- * </code>
- *
- * @license New BSD License
- * @link http://www.zetacomponents.org
- *
- * @param mixed $value
- * @param IQueryBuilder::PARAM_* $type
- * @param string $placeHolder The name to bind with. The string must start with a colon ':'.
- *
- * @return IParameter the placeholder name used.
- */
public function createNamedParameter($value, $type = IQueryBuilder::PARAM_STR, $placeHolder = null) {
return new Parameter($this->queryBuilder->createNamedParameter($value, $type, $placeHolder));
}
- /**
- * Creates a new positional parameter and bind the given value to it.
- *
- * Attention: If you are using positional parameters with the query builder you have
- * to be very careful to bind all parameters in the order they appear in the SQL
- * statement , otherwise they get bound in the wrong order which can lead to serious
- * bugs in your code.
- *
- * Example:
- * <code>
- * $qb = $conn->getQueryBuilder();
- * $qb->select('u.*')
- * ->from('users', 'u')
- * ->where('u.username = ' . $qb->createPositionalParameter('Foo', IQueryBuilder::PARAM_STR))
- * ->orWhere('u.username = ' . $qb->createPositionalParameter('Bar', IQueryBuilder::PARAM_STR))
- * </code>
- *
- * @param mixed $value
- * @param IQueryBuilder::PARAM_* $type
- *
- * @return IParameter
- */
public function createPositionalParameter($value, $type = IQueryBuilder::PARAM_STR) {
return new Parameter($this->queryBuilder->createPositionalParameter($value, $type));
}
- /**
- * Creates a new parameter
- *
- * Example:
- * <code>
- * $qb = $conn->getQueryBuilder();
- * $qb->select('u.*')
- * ->from('users', 'u')
- * ->where('u.username = ' . $qb->createParameter('name'))
- * ->setParameter('name', 'Bar', IQueryBuilder::PARAM_STR))
- * </code>
- *
- * @param string $name
- *
- * @return IParameter
- */
public function createParameter($name) {
return new Parameter(':' . $name);
}
- /**
- * Creates a new function
- *
- * Attention: Column names inside the call have to be quoted before hand
- *
- * Example:
- * <code>
- * $qb = $conn->getQueryBuilder();
- * $qb->select($qb->createFunction('COUNT(*)'))
- * ->from('users', 'u')
- * echo $qb->getSQL(); // SELECT COUNT(*) FROM `users` u
- * </code>
- * <code>
- * $qb = $conn->getQueryBuilder();
- * $qb->select($qb->createFunction('COUNT(`column`)'))
- * ->from('users', 'u')
- * echo $qb->getSQL(); // SELECT COUNT(`column`) FROM `users` u
- * </code>
- *
- * @param string $call
- *
- * @return IQueryFunction
- */
public function createFunction($call) {
return new QueryFunction($call);
}
- /**
- * Used to get the id of the last inserted element
- * @return int
- * @throws \BadMethodCallException When being called before an insert query has been run.
- */
public function getLastInsertId(): int {
if ($this->getType() === \Doctrine\DBAL\Query\QueryBuilder::INSERT && $this->lastInsertedTable) {
// lastInsertId() needs the prefix but no quotes
@@ -1308,12 +629,6 @@ class QueryBuilder implements IQueryBuilder {
throw new \BadMethodCallException('Invalid call to getLastInsertId without using insert() before.');
}
- /**
- * Returns the table name quoted and with database prefix as needed by the implementation
- *
- * @param string|IQueryFunction $table
- * @return string
- */
public function getTableName($table) {
if ($table instanceof IQueryFunction) {
return (string)$table;
@@ -1323,12 +638,6 @@ class QueryBuilder implements IQueryBuilder {
return $this->helper->quoteColumnName($table);
}
- /**
- * Returns the table name with database prefix as needed by the implementation
- *
- * @param string $table
- * @return string
- */
public function prefixTableName(string $table): string {
if ($this->automaticTablePrefix === false || str_starts_with($table, '*PREFIX*')) {
return $table;
@@ -1337,13 +646,6 @@ class QueryBuilder implements IQueryBuilder {
return '*PREFIX*' . $table;
}
- /**
- * Returns the column name quoted and with table alias prefix as needed by the implementation
- *
- * @param string $column
- * @param string $tableAlias
- * @return string
- */
public function getColumnName($column, $tableAlias = '') {
if ($tableAlias !== '') {
$tableAlias .= '.';