Symfony Profiler

<?php
/**
* Pimcore
*
* This source file is available under two different licenses:
* - GNU General Public License version 3 (GPLv3)
* - Pimcore Commercial License (PCL)
* Full copyright and license information is available in
* LICENSE.md which is distributed with this source code.
*
* @copyright Copyright (c) Pimcore GmbH (http://www.pimcore.org)
* @license http://www.pimcore.org/license GPLv3 and PCL
*/
namespace Pimcore\Db;
use Doctrine\DBAL\Cache\CacheException;
use Doctrine\DBAL\Cache\QueryCacheProfile;
use Doctrine\DBAL\Driver\Exception as DriverException;
use Doctrine\DBAL\Driver\Result;
use Doctrine\DBAL\Driver\ResultStatement;
use Doctrine\DBAL\Exception as DBALException;
use Pimcore\Model\Element\ValidationException;
/**
* @property \Doctrine\DBAL\Driver\Connection $_conn
*
* @deprecated will be removed in Pimcore 11
*/
trait PimcoreExtensionsTrait
{
/**
* Specifies whether the connection automatically quotes identifiers.
* If true, the methods insert(), update() apply identifier quoting automatically.
* If false, developer must quote identifiers themselves by calling quoteIdentifier().
*
* @var bool
*/
protected $autoQuoteIdentifiers = true;
/**
* @var array
*/
private static array $tablePrimaryKeyCache = [];
/**
* @see \Doctrine\DBAL\Connection::executeQuery
*
* @return ResultStatement
*
* @throws DBALException
*/
public function query(...$params)
{
trigger_deprecation(
'pimcore/pimcore',
'10.5.0',
sprintf('%s is deprecated and will be removed in Pimcore 11. Use Doctrine\DBAL\Connection::executeQuery() instead.', __METHOD__)
);
// compatibility layer for additional parameters in the 2nd argument
// eg. $db->query("UPDATE myTest SET date = ? WHERE uri = ?", [time(), $uri]);
if (func_num_args() === 2) {
if (is_array($params[1])) {
return parent::executeQuery($params[0], $params[1]);
}
}
if (count($params) > 0) {
$params[0] = $this->normalizeQuery($params[0], [], true);
}
return parent::executeQuery(...$params);
}
/**
* @see \Doctrine\DBAL\Connection::executeQuery
*
* @param string $query The SQL query to execute.
* @param array $params The parameters to bind to the query, if any.
* @param array $types The types the previous parameters are in.
* @param QueryCacheProfile|null $qcp The query cache profile, optional.
*
* @return ResultStatement The executed statement.
*
* @throws DBALException
*/
public function executeQuery($query, array $params = [], $types = [], QueryCacheProfile $qcp = null)
{
list($query, $params) = $this->normalizeQuery($query, $params);
return parent::executeQuery($query, $params, $types, $qcp);
}
/**
* @deprecated
* @see \Doctrine\DBAL\Connection::executeUpdate
*
* @param string $query The SQL query.
* @param array $params The query parameters.
* @param array $types The parameter types.
*
* @return int The number of affected rows.
*
* @throws DBALException
*/
public function executeUpdate($query, array $params = [], array $types = [])
{
trigger_deprecation(
'pimcore/pimcore',
'10.5.0',
sprintf('%s is deprecated and will be removed in Pimcore 11. Use Doctrine\DBAL\Connection::executeStatement() instead.', __METHOD__)
);
list($query, $params) = $this->normalizeQuery($query, $params);
return parent::executeStatement($query, $params, $types);
}
/**
* @see \Doctrine\DBAL\Connection::executeCacheQuery
*
* @param string $query The SQL query to execute.
* @param array $params The parameters to bind to the query, if any.
* @param array $types The types the previous parameters are in.
* @param QueryCacheProfile $qcp The query cache profile.
*
* @return ResultStatement
*
* @throws CacheException
*/
public function executeCacheQuery($query, $params, $types, QueryCacheProfile $qcp)
{
list($query, $params) = $this->normalizeQuery($query, $params);
return parent::executeCacheQuery($query, $params, $types, $qcp);
}
/**
* @param string $query
* @param array $params
* @param bool $onlyQuery
*
* @return array|string
*/
private function normalizeQuery($query, array $params = [], $onlyQuery = false)
{
if ($onlyQuery) {
return $query;
}
return [$query, $params];
}
/**
* @see \Doctrine\DBAL\Connection::update
*
* @param string $tableExpression The expression of the table to update quoted or unquoted.
* @param array $data An associative array containing column-value pairs.
* @param array $identifier The update criteria. An associative array containing column-value pairs.
* @param array $types Types of the merged $data and $identifier arrays in that order.
*
* @return int The number of affected rows.
*
* @throws DBALException
*/
public function update($tableExpression, array $data, array $identifier, array $types = [])
{
$data = $this->quoteDataIdentifiers($data);
$identifier = $this->quoteDataIdentifiers($identifier);
return parent::update($tableExpression, $data, $identifier, $types);
}
/**
* @see \Doctrine\DBAL\Connection::insert
*
* @param string $tableExpression The expression of the table to insert data into, quoted or unquoted.
* @param array $data An associative array containing column-value pairs.
* @param array $types Types of the inserted data.
*
* @return int The number of affected rows.
*
* @throws DBALException
*/
public function insert($tableExpression, array $data, array $types = [])
{
$data = $this->quoteDataIdentifiers($data);
return parent::insert($tableExpression, $data, $types);
}
/**
* Deletes table rows based on a custom WHERE clause.
*
* @deprecated
*
* @param string $table The table to update.
* @param string $where DELETE WHERE clause(s).
*
* @return int The number of affected rows.
*
* @throws DBALException
*/
public function deleteWhere($table, $where = '')
{
trigger_deprecation(
'pimcore/pimcore',
'10.5.0',
sprintf('%s is deprecated and will be removed in Pimcore 11. Use Doctrine\DBAL\Connection::executeStatement() instead.', __METHOD__)
);
$sql = 'DELETE FROM ' . $table;
if ($where) {
$sql .= ' WHERE ' . $where;
}
return $this->executeStatement($sql);
}
/**
* Updates table rows with specified data based on a custom WHERE clause.
*
* @deprecated
*
* @param string $table The table to update.
* @param array $data Column-value pairs.
* @param string $where UPDATE WHERE clause(s).
*
* @return int The number of affected rows.
*
* @throws DBALException
*/
public function updateWhere($table, array $data, $where = '')
{
trigger_deprecation(
'pimcore/pimcore',
'10.5.0',
sprintf('%s is deprecated and will be removed in Pimcore 11. Use Doctrine\DBAL\Connection::executeStatement() instead.', __METHOD__)
);
$set = [];
$paramValues = [];
foreach ($data as $columnName => $value) {
$set[] = $this->quoteIdentifier($columnName) . ' = ?';
$paramValues[] = $value;
}
$sql = 'UPDATE ' . $table . ' SET ' . implode(', ', $set);
if ($where) {
$sql .= ' WHERE ' . $where;
}
return $this->executeStatement($sql, $paramValues);
}
/**
* Fetches the first row of the SQL result.
*
* @deprecated
*
* @param string $sql
* @param array|scalar $params
* @param array $types
*
* @return mixed
*
* @throws DBALException
*/
public function fetchRow($sql, $params = [], $types = [])
{
trigger_deprecation(
'pimcore/pimcore',
'10.5.0',
sprintf('%s is deprecated and will be removed in Pimcore 11. Use Doctrine\DBAL\Connection::fetchAssociative() instead.', __METHOD__)
);
$params = $this->prepareParams($params);
return $this->fetchAssociative($sql, $params, $types);
}
/**
* Fetches the first column of all SQL result rows as an array.
*
* @deprecated
*
* @param string $sql
* @param array|scalar $params
* @param array $types
*
* @return array
*
* @throws DBALException
* @throws DriverException
*/
public function fetchCol($sql, $params = [], $types = [])
{
trigger_deprecation(
'pimcore/pimcore',
'10.5.0',
sprintf('%s is deprecated and will be removed in Pimcore 11. Use Doctrine\DBAL\Connection::fetchFirstColumn() instead.', __METHOD__)
);
$params = $this->prepareParams($params);
// unfortunately Mysqli driver doesn't support \PDO::FETCH_COLUMN, so we have to do it manually
$stmt = $this->executeQuery($sql, $params, $types);
$data = [];
if ($stmt instanceof Result) {
$row = $stmt->fetchOne();
while (false !== $row) {
$data[] = $row;
$row = $stmt->fetchOne();
}
$stmt->free();
}
return $data;
}
/**
* Fetches the first column of the first row of the SQL result.
*
* @param string $sql
* @param array|scalar $params
* @param array $types
*
* @return mixed
*
* @throws DBALException
*/
public function fetchOne($sql, $params = [], $types = [])
{
$params = $this->prepareParams($params);
// unfortunately Mysqli driver doesn't support \PDO::FETCH_COLUMN, so we have to use $this->fetchColumn() instead
return parent::fetchOne($sql, $params, $types);
}
/**
* Fetches all SQL result rows as an array of key-value pairs.
*
* The first column is the key, the second column is the
* value.
*
* @deprecated
*
* @param string $sql
* @param array $params
* @param array $types
*
* @return array
*
* @throws DBALException
* @throws DriverException
*/
public function fetchPairs($sql, array $params = [], $types = [])
{
trigger_deprecation(
'pimcore/pimcore',
'10.5.0',
sprintf('%s is deprecated and will be removed in Pimcore 11. Use Pimcore\Db\Helper::fetchPairs() instead.', __METHOD__)
);
$params = $this->prepareParams($params);
$stmt = $this->executeQuery($sql, $params, $types);
$data = [];
if ($stmt instanceof Result) {
while ($row = $stmt->fetchNumeric()) {
$data[$row[0]] = $row[1];
}
}
return $data;
}
/**
* @deprecated
*
* @param string $table
* @param array $data
*
* @return int
*
* @throws DBALException
*/
public function insertOrUpdate($table, array $data)
{
trigger_deprecation(
'pimcore/pimcore',
'10.5.0',
sprintf('%s is deprecated and will be removed in Pimcore 11. Use Pimcore\Db\Helper::upsert() instead.', __METHOD__)
);
// get the field name of the primary key
$fieldsPrimaryKey = self::$tablePrimaryKeyCache[$table] ??= $this->getPrimaryKeyColumns($table);
// extract and quote col names from the array keys
$i = 0;
$bind = [];
$cols = [];
$vals = [];
$set = [];
foreach ($data as $col => $val) {
$cols[] = $this->quoteIdentifier($col);
$bind[':col' . $i] = $val;
$vals[] = ':col' . $i;
if (!($val === null && in_array($col, $fieldsPrimaryKey))) {
$set[] = sprintf('%s = %s', $this->quoteIdentifier($col), ':col' . $i);
}
$i++;
}
$sql = sprintf(
'INSERT INTO %s (%s) VALUES (%s) ON DUPLICATE KEY UPDATE %s;',
$this->quoteIdentifier($table),
implode(', ', $cols),
implode(', ', $vals),
implode(', ', $set)
);
return $this->executeStatement($sql, $bind);
}
/**
* Quotes a value and places into a piece of text at a placeholder.
*
* The placeholder is a question-mark; all placeholders will be replaced
* with the quoted value. For example:
*
* <code>
* $text = "WHERE date < ?";
* $date = "2005-01-02";
* $safe = $sql->quoteInto($text, $date);
* // $safe = "WHERE date < '2005-01-02'"
* </code>
*
* @deprecated
*
* @param string $text The text with a placeholder.
* @param mixed $value The value to quote.
* @param string|null $type OPTIONAL SQL datatype
* @param int|null $count OPTIONAL count of placeholders to replace
*
* @return string An SQL-safe quoted value placed into the original text.
*/
public function quoteInto($text, $value, $type = null, $count = null)
{
trigger_deprecation(
'pimcore/pimcore',
'10.5.0',
sprintf('%s is deprecated and will be removed in Pimcore 11. Use Pimcore\Db\Helper::quoteInto() instead.', __METHOD__)
);
if ($count === null) {
return str_replace('?', $this->quote($value, $type), $text);
}
return implode($this->quote($value, $type), explode('?', $text, $count + 1));
}
/**
* Quote a column identifier and alias.
*
* @deprecated
*
* @param string|array $ident The identifier or expression.
* @param string|null $alias An alias for the column.
*
* @return string The quoted identifier and alias.
*/
public function quoteColumnAs($ident, $alias = null)
{
trigger_deprecation(
'pimcore/pimcore',
'10.5.0',
sprintf('%s is deprecated and will be removed in Pimcore 11. Use Doctrine\DBAL\Connection::quoteIdentifier() instead.', __METHOD__)
);
return $this->_quoteIdentifierAs($ident, $alias);
}
/**
* Quote a table identifier and alias.
*
* @deprecated
*
* @param string|array $ident The identifier or expression.
* @param string|null $alias An alias for the table.
*
* @return string The quoted identifier and alias.
*/
public function quoteTableAs($ident, $alias = null)
{
trigger_deprecation(
'pimcore/pimcore',
'10.5.0',
sprintf('%s is deprecated and will be removed in Pimcore 11.', __METHOD__)
);
return $this->_quoteIdentifierAs($ident, $alias);
}
/**
* Quote an identifier and an optional alias.
*
* @deprecated
*
* @param string|array $ident The identifier or expression.
* @param string|null $alias An optional alias.
* @param bool $auto If true, heed the AUTO_QUOTE_IDENTIFIERS config option.
* @param string $as The string to add between the identifier/expression and the alias.
*
* @return string The quoted identifier and alias.
*/
protected function _quoteIdentifierAs($ident, $alias = null, $auto = false, $as = ' AS ')
{
if (is_string($ident)) {
$ident = explode('.', $ident);
}
if (is_array($ident)) {
$segments = [];
foreach ($ident as $segment) {
$segments[] = $this->_quoteIdentifier($segment, $auto);
}
if ($alias !== null && end($ident) == $alias) {
$alias = null;
}
$quoted = implode('.', $segments);
} else {
$quoted = $this->_quoteIdentifier($ident, $auto);
}
if ($alias !== null) {
$quoted .= $as . $this->_quoteIdentifier($alias, $auto);
}
return $quoted;
}
/**
* Quote an identifier.
*
* @deprecated
*
* @param string $value The identifier or expression.
* @param bool $auto If true, heed the AUTO_QUOTE_IDENTIFIERS config option.
*
* @return string The quoted identifier and alias.
*/
protected function _quoteIdentifier($value, $auto = false)
{
if ($auto === false) {
$q = '`';
return $q . str_replace((string) $q, "$q$q", $value) . $q;
}
return $value;
}
/**
* Adds an adapter-specific LIMIT clause to the SELECT statement.
*
* @deprecated
*
* @param string $sql
* @param int $count
* @param int $offset OPTIONAL
*
* @throws \Exception
*
* @return string
*/
public function limit($sql, $count, $offset = 0)
{
trigger_deprecation(
'pimcore/pimcore',
'10.5.0',
sprintf('%s is deprecated and will be removed in Pimcore 11.', __METHOD__)
);
$count = (int) $count;
if ($count <= 0) {
throw new \Exception("LIMIT argument count=$count is not valid");
}
$offset = (int) $offset;
if ($offset < 0) {
throw new \Exception("LIMIT argument offset=$offset is not valid");
}
$sql .= " LIMIT $count";
if ($offset > 0) {
$sql .= " OFFSET $offset";
}
return $sql;
}
/**
* @deprecated
*
* @param string $sql
* @param array $exclusions
*
* @return ResultStatement|null
*
* @throws ValidationException
*/
public function queryIgnoreError($sql, $exclusions = [])
{
trigger_deprecation(
'pimcore/pimcore',
'10.5.0',
sprintf('%s is deprecated and will be removed in Pimcore 11. Use Pimcore\Db\Helper::queryIgnoreError() instead.', __METHOD__)
);
try {
return $this->executeQuery($sql);
} catch (\Exception $e) {
foreach ($exclusions as $exclusion) {
if ($e instanceof $exclusion) {
throw new ValidationException($e->getMessage(), 0, $e);
}
}
// we simply ignore the error
}
return null;
}
/**
* @deprecated
*
* @param array|scalar $params
*
* @return array
*/
protected function prepareParams($params)
{
if (!is_array($params)) {
trigger_deprecation(
'pimcore/pimcore',
'10.5.0',
'DB query params must be an array in Pimcore 11.'
);
$params = [$params];
}
return $params;
}
/**
* @deprecated
*
* @param array $data
*
* @return array
*/
protected function quoteDataIdentifiers($data)
{
if (!$this->autoQuoteIdentifiers) {
return $data;
}
$newData = [];
foreach ($data as $key => $value) {
$newData[$this->quoteIdentifier($key)] = $value;
}
return $newData;
}
/**
* @deprecated
*
* @param bool $autoQuoteIdentifiers
*/
public function setAutoQuoteIdentifiers($autoQuoteIdentifiers)
{
$this->autoQuoteIdentifiers = $autoQuoteIdentifiers;
}
/**
* @deprecated
*
* @param string $table
* @param string $idColumn
* @param string $where
*/
public function selectAndDeleteWhere($table, $idColumn = 'id', $where = '')
{
trigger_deprecation(
'pimcore/pimcore',
'10.5.0',
sprintf('%s is deprecated and will be removed in Pimcore 11. Use Pimcore\Db\Helper::selectAndDeleteWhere() instead.', __METHOD__)
);
$sql = 'SELECT ' . $this->quoteIdentifier($idColumn) . ' FROM ' . $table;
if ($where) {
$sql .= ' WHERE ' . $where;
}
$idsForDeletion = $this->fetchFirstColumn($sql);
if (!empty($idsForDeletion)) {
$chunks = array_chunk($idsForDeletion, 1000);
foreach ($chunks as $chunk) {
$idString = implode(',', array_map([$this, 'quote'], $chunk));
$this->deleteWhere($table, $idColumn . ' IN (' . $idString . ')');
}
}
}
/**
* @deprecated
*
* @param string $like
*
* @return string
*/
public function escapeLike(string $like): string
{
trigger_deprecation(
'pimcore/pimcore',
'10.5.0',
sprintf('%s is deprecated and will be removed in Pimcore 11. Use Pimcore\Db\Helper::escapeLike() instead.', __METHOD__)
);
return str_replace(['_', '%'], ['\\_', '\\%'], $like);
}
/**
* @param string $table
*
* @return string[]
*/
private function getPrimaryKeyColumns(string $table): array
{
try {
return $this->getSchemaManager()->listTableDetails($table)->getPrimaryKeyColumns();
} catch (DBALException) {
return [];
}
}
}

vendor/pimcore/pimcore/lib/Db/PimcoreExtensionsTrait.php line 88