aboutsummaryrefslogtreecommitdiffstats
path: root/lib/private/DB/QueryBuilder/QuoteHelper.php
blob: 7ce4b359638d48d622fa7c40fb0ddd308cdd6be4 (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
<?php

/**
 * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
 * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
 * SPDX-License-Identifier: AGPL-3.0-only
 */
namespace OC\DB\QueryBuilder;

use OCP\DB\QueryBuilder\ILiteral;
use OCP\DB\QueryBuilder\IParameter;
use OCP\DB\QueryBuilder\IQueryFunction;

class QuoteHelper {
	/**
	 * @param array|string|ILiteral|IParameter|IQueryFunction $strings string, Literal or Parameter
	 * @return array|string
	 */
	public function quoteColumnNames($strings) {
		if (!is_array($strings)) {
			return $this->quoteColumnName($strings);
		}

		$return = [];
		foreach ($strings as $string) {
			$return[] = $this->quoteColumnName($string);
		}

		return $return;
	}

	/**
	 * @param string|ILiteral|IParameter|IQueryFunction $string string, Literal or Parameter
	 * @return string
	 */
	public function quoteColumnName($string) {
		if ($string instanceof IParameter || $string instanceof ILiteral || $string instanceof IQueryFunction) {
			return (string)$string;
		}

		if ($string === null || $string === 'null' || $string === '*') {
			return $string;
		}

		if (!is_string($string)) {
			throw new \InvalidArgumentException('Only strings, Literals and Parameters are allowed');
		}

		$string = str_replace(' AS ', ' as ', $string);
		if (substr_count($string, ' as ')) {
			return implode(' as ', array_map([$this, 'quoteColumnName'], explode(' as ', $string, 2)));
		}

		if (substr_count($string, '.')) {
			[$alias, $columnName] = explode('.', $string, 2);

			if ($columnName === '*') {
				return '`' . $alias . '`.*';
			}

			return '`' . $alias . '`.`' . $columnName . '`';
		}

		return '`' . $string . '`';
	}
}