PDOConnection::isValidLastInsertIdOrSequenceNumber() - Code Metrics - Inspection of "Extract getSequenceNumber() from lastInsertId()" - doctrine/dbal - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#3759)

by Benjamin

created 2019-12-01 16:01 UTC

isValidLastInsertIdOrSequenceNumber() A

↳ Parent: PDOConnection

Complexity

Conditions	2
Paths	2

Size

Total Lines	4
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
eloc	1
dl	0
loc	4
ccs	0
cts	0
cp	0
rs	10
c	0
b	0
f	0
cc	2
nc	2
nop	1
crap	6

<?php

declare(strict_types=1);

namespace Doctrine\DBAL\Driver;

use PDO;
use function assert;

/**
 * PDO implementation of the Connection interface.
 *
 * Used by all PDO-based drivers.
 */
class PDOConnection implements ServerInfoAwareConnection
{
    /** @var PDO */
    private $connection;

    /**
     * @param array<int, mixed> $options
     *
     * @throws PDOException In case of an error.
     */
    public function __construct(string $dsn, string $username = '', string $password = '', array $options = [])
    {
        try {
            $this->connection = new PDO($dsn, $username, $password, $options);
            $this->connection->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
        } catch (\PDOException $exception) {
            throw PDOException::fromNativePDOException($exception);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function exec(string $statement) : int
    {
        try {
            return $this->connection->exec($statement);
        } catch (\PDOException $exception) {
            throw PDOException::fromNativePDOException($exception);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function getServerVersion() : string
    {
        return $this->connection->getAttribute(PDO::ATTR_SERVER_VERSION);
    }

    /**
     * {@inheritdoc}
     */
    public function prepare(string $sql) : Statement
    {
        try {
            return $this->createStatement(
                $this->connection->prepare($sql)
                /** @scrutinizer ignore-type */ $this->connection->prepare($sql)
            );
        } catch (\PDOException $exception) {
            throw PDOException::fromNativePDOException($exception);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function query(string $sql) : ResultStatement
    {
        try {
            $stmt = $this->connection->query($sql);
            assert($stmt instanceof \PDOStatement);

            return $this->createStatement($stmt);
        } catch (\PDOException $exception) {
            throw PDOException::fromNativePDOException($exception);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function quote(string $input) : string
    {
        return $this->connection->quote($input);
    }

    /**
     * {@inheritdoc}
     */
    public function lastInsertId() : string
    {
        try {
            $lastInsertId = (string) $this->connection->lastInsertId();
        } catch (\PDOException $exception) {
            throw PDOException::fromNativePDOException($exception);
        }

        if (! $this->isValidLastInsertIdOrSequenceNumber($lastInsertId)) {
            throw new PDOException('No identity value was generated by the last statement.');
        }

        return $lastInsertId;
    }

    /**
     * {@inheritdoc}
     */
    public function getSequenceNumber(string $name) : string
    {
        try {
            $sequenceNumber = (string) $this->connection->lastInsertId($name);
        } catch (\PDOException $exception) {
            throw PDOException::fromNativePDOException($exception);
        }

        if (! $this->isValidLastInsertIdOrSequenceNumber($sequenceNumber)) {
            throw new PDOException('No sequence with name "' . $name . '" found.');
        }

        return $sequenceNumber;
    }

    private function isValidLastInsertIdOrSequenceNumber(string $value) : bool
    {
        // pdo_mysql & pdo_sqlite return '0', pdo_sqlsrv returns ''
        return $value !== '0' && $value !== '';
    }

    /**
     * {@inheritdoc}
     */
    public function requiresQueryForServerVersion() : bool
    {
        return false;
    }

    /**
     * Creates a wrapped statement
     */
    protected function createStatement(\PDOStatement $stmt) : PDOStatement
    {
        return new PDOStatement($stmt);
    }

    /**
     * {@inheritDoc}
     */
    public function beginTransaction() : void
    {
        $this->connection->beginTransaction();
    }

    /**
     * {@inheritDoc}
     */
    public function commit() : void
    {
        $this->connection->commit();
    }

    /**
     * {@inheritDoc}
     */
    public function rollBack() : void
    {
        $this->connection->rollBack();
    }

    public function getWrappedConnection() : PDO
    {
        return $this->connection;
    }
}


doctrine / dbal

Pull Request — master (#3759)

isValidLastInsertIdOrSequenceNumber() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like