Fisharebest\Webtrees\DB\Drivers\DriverTrait

Complexity

Total Complexity

8

Size/Duplication

Total Lines	71
Duplicated Lines	0 %

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	quoteIdentifier()	0	5	1
A	quoteValue()	0	3	1
A	query()	0	34	6

<?php

/**
 * webtrees: online genealogy
 * Copyright (C) 2023 webtrees development team
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 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 General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */

declare(strict_types=1);

namespace Fisharebest\Webtrees\DB\Drivers;

use Fisharebest\Webtrees\DB\Expression;
use PDO;
use PDOException;
use RuntimeException;

use function is_bool;
use function is_int;

/**
 * Common functionality for all drivers.
 */
trait DriverTrait
{
    protected const IDENTIFIER_OPEN_QUOTE  = '"';
    protected const IDENTIFIER_CLOSE_QUOTE = '"';

    /**
     * @param string $identifier
     *
     * @return Expression
     */
    public function quoteIdentifier(string $identifier): Expression
    {
        $escaped = strtr($identifier, [static::IDENTIFIER_CLOSE_QUOTE => static::IDENTIFIER_CLOSE_QUOTE . static::IDENTIFIER_CLOSE_QUOTE]);

The constant Fisharebest\Webtrees\DB\Drivers\DriverTrait::IDENTIFIER_CLOSE_QUOTE was not found. Maybe you did not declare it correctly or list all dependencies?

        return new Expression(static::IDENTIFIER_OPEN_QUOTE . $escaped . static::IDENTIFIER_CLOSE_QUOTE);

The constant Fisharebest\Webtrees\DB\Drivers\DriverTrait::IDENTIFIER_OPEN_QUOTE was not found. Maybe you did not declare it correctly or list all dependencies?

    }

    /**
     * For quoting strings in DDL statements which cannot use placeholders. e.g. COMMENT 'foo' and DEFAULT 'bar'.
     *
     * @param string $value
     *
     * @return Expression
     */
    public function quoteValue(string $value): Expression
    {
        return new Expression($this->pdo->quote($value));
    }

    /**
     * Prepare, bind and execute a select query.
     *
     * @param string                            $sql
     * @param array<bool|int|float|string|null> $bindings
     *
     * @return array<object>
     */
    public function query(string $sql, array $bindings = []): array
    {
        try {
            $statement = $this->pdo->prepare($sql);
        } catch (PDOException) {
            $statement = false;
        }

        if ($statement === false) {
            throw new RuntimeException('Failed to prepare statement: ' . $sql);
        }

        foreach ($bindings as $param => $value) {
            $type = match (true) {
                $value === null => PDO::PARAM_NULL,
                is_bool($value) => PDO::PARAM_BOOL,
                is_int($value)  => PDO::PARAM_INT,
                default         => PDO::PARAM_STR,
            };

            if (is_int($param)) {
                // Positional parameters are numeric, starting at 1.
                $statement->bindValue($param + 1, $value, $type);
            } else {
                // Named parameters are (optionally) prefixed with a colon.
                $statement->bindValue(':' . $param, $value, $type);
            }
        }

        if ($statement->execute()) {
            return $statement->fetchAll(PDO::FETCH_OBJ);
        }

        throw new RuntimeException('Failed to execute statement: ' . $sql);
    }
}