nextcloud/tests/lib/DB/QueryBuilder/QuoteHelperTest.php

146 lines
3.6 KiB
PHP
Raw Normal View History

2015-07-07 18:30:26 +03:00
<?php
/**
* @author Joas Schilling <nickvergessen@owncloud.com>
*
* @copyright Copyright (c) 2015, ownCloud, Inc.
* @license AGPL-3.0
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
namespace Test\DB\QueryBuilder;
use OC\DB\QueryBuilder\Literal;
use OC\DB\QueryBuilder\Parameter;
use OC\DB\QueryBuilder\QuoteHelper;
use OCP\DB\QueryBuilder\ILiteral;
use OCP\DB\QueryBuilder\IParameter;
class QuoteHelperTest extends \Test\TestCase {
/** @var QuoteHelper */
protected $helper;
protected function setUp(): void {
2015-07-07 18:30:26 +03:00
parent::setUp();
$this->helper = new QuoteHelper();
}
public function dataQuoteColumnName() {
return [
['column', '`column`'],
[new Literal('literal'), 'literal'],
[new Literal(1), '1'],
[new Parameter(':param'), ':param'],
// (string) 'null' is Doctrines way to set columns to null
// See https://github.com/owncloud/core/issues/19314
['null', 'null'],
2015-07-07 18:30:26 +03:00
];
}
/**
* @dataProvider dataQuoteColumnName
* @param mixed $input
* @param string $expected
*/
public function testQuoteColumnName($input, $expected) {
$this->assertSame(
$expected,
$this->helper->quoteColumnName($input)
);
}
public function dataQuoteColumnNames() {
return [
// Single case
['d.column', '`d`.`column`'],
2015-07-07 18:30:26 +03:00
['column', '`column`'],
[new Literal('literal'), 'literal'],
[new Literal(1), '1'],
[new Parameter(':param'), ':param'],
// Array case
[['column'], ['`column`']],
[[new Literal('literal')], ['literal']],
[[new Literal(1)], ['1']],
[[new Parameter(':param')], [':param']],
// Array mixed cases
[['column1', 'column2'], ['`column1`', '`column2`']],
[['column', new Literal('literal')], ['`column`', 'literal']],
[['column', new Literal(1)], ['`column`', '1']],
[['column', new Parameter(':param')], ['`column`', ':param']],
];
}
/**
* @dataProvider dataQuoteColumnNames
* @param mixed $input
* @param string $expected
*/
public function testQuoteColumnNames($input, $expected) {
$this->assertSame(
$expected,
$this->helper->quoteColumnNames($input)
);
}
/**
* @param array|string|ILiteral|IParameter $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 $string string, Literal or Parameter
* @return string
*/
public function quoteColumnName($string) {
if ($string instanceof IParameter) {
return $string->getName();
}
if ($string instanceof ILiteral) {
return $string->getLiteral();
}
if ($string === null) {
return $string;
}
if (!is_string($string)) {
throw new \InvalidArgumentException('Only strings, Literals and Parameters are allowed');
}
if (substr_count($string, '.')) {
list($alias, $columnName) = explode('.', $string);
return '`' . $alias . '`.`' . $columnName . '`';
}
return '`' . $string . '`';
}
}