SQLAnywhereConnection::quote() - Code Metrics - Inspection of "[WIP] [3.0] Rework driver exceptions" - doctrine/dbal - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions
Pull Request — develop (#3367)

by Benjamin
created 2018-12-01 17:48 UTC
SQLAnywhereConnection::quote() A

↳ Parent: SQLAnywhereConnection
Complexity

Conditions	3
Paths	2
Size

Total Lines	7
Code Lines	3
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	12
Importance

Changes
Metric	Value
eloc	3
dl	0
loc	7
ccs	0
cts	6
cp	0
rs	10
c	0
b	0
f	0
cc	3
nc	2
nop	2
crap	12
<?php

namespace Doctrine\DBAL\Driver\SQLAnywhere;

use Doctrine\DBAL\Driver\Connection;
use Doctrine\DBAL\Driver\DriverException;
use Doctrine\DBAL\Driver\ResultStatement;
use Doctrine\DBAL\Driver\ServerInfoAwareConnection;
use Doctrine\DBAL\Driver\Statement as DriverStatement;
use Doctrine\DBAL\ParameterType;
use InvalidArgumentException;
use function assert;
use function is_float;
use function is_int;
use function is_resource;
use function is_string;
use function sasql_affected_rows;

use function sasql_commit;

use function sasql_connect;

use function sasql_error;

use function sasql_errorcode;

use function sasql_escape_string;

use function sasql_insert_id;

use function sasql_pconnect;

use function sasql_real_query;

use function sasql_rollback;

use function sasql_set_option;


/**
 * SAP Sybase SQL Anywhere implementation of the Connection interface.
 */
class SQLAnywhereConnection implements Connection, ServerInfoAwareConnection
{
    /** @var resource The SQL Anywhere connection resource. */
    private $connection;

    /**
     * Connects to database with given connection string.
     *
     * @param string $dsn        The connection string.
     * @param bool   $persistent Whether or not to establish a persistent connection.
     *
     * @throws DriverException
     */
    public function __construct($dsn, $persistent = false)
    {
        $this->connection = $persistent ? @sasql_pconnect($dsn) : @sasql_connect($dsn);
        $this->connection = $persistent ? @/** @scrutinizer ignore-call */ sasql_pconnect($dsn) : @sasql_connect($dsn);

        if (! is_resource($this->connection)) {
            throw self::exceptionFromSQLAnywhereError();
        }

        // Disable PHP warnings on error.
        if (! sasql_set_option($this->connection, 'verbose_errors', false)) {
        if (! /** @scrutinizer ignore-call */ sasql_set_option($this->connection, 'verbose_errors', false)) {
            throw self::exceptionFromSQLAnywhereError($this->connection);
        }

        // Enable auto committing by default.
        if (! sasql_set_option($this->connection, 'auto_commit', 'on')) {
            throw self::exceptionFromSQLAnywhereError($this->connection);
        }

        // Enable exact, non-approximated row count retrieval.
        if (! sasql_set_option($this->connection, 'row_counts', true)) {
            throw self::exceptionFromSQLAnywhereError($this->connection);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function beginTransaction()
    {
        if (! sasql_set_option($this->connection, 'auto_commit', 'off')) {
        if (! /** @scrutinizer ignore-call */ sasql_set_option($this->connection, 'auto_commit', 'off')) {
            throw self::exceptionFromSQLAnywhereError($this->connection);
        }

        return true;
    }

    /**
     * {@inheritdoc}
     */
    public function commit()
    {
        if (! sasql_commit($this->connection)) {
        if (! /** @scrutinizer ignore-call */ sasql_commit($this->connection)) {
            throw self::exceptionFromSQLAnywhereError($this->connection);
        }

        $this->endTransaction();

        return true;
    }

    /**
     * {@inheritdoc}
     */
    public function errorCode()
    {
        return sasql_errorcode($this->connection);
        return /** @scrutinizer ignore-call */ sasql_errorcode($this->connection);
    }

    /**
     * {@inheritdoc}
     */
    public function errorInfo()
    {
        return sasql_error($this->connection);
        return /** @scrutinizer ignore-call */ sasql_error($this->connection);
    }

    /**
     * {@inheritdoc}
     */
    public function exec(string $statement) : int
    {
        if (sasql_real_query($this->connection, $statement) === false) {
        if (/** @scrutinizer ignore-call */ sasql_real_query($this->connection, $statement) === false) {
            throw self::exceptionFromSQLAnywhereError($this->connection);
        }

        return sasql_affected_rows($this->connection);
        return /** @scrutinizer ignore-call */ sasql_affected_rows($this->connection);
    }

    /**
     * {@inheritdoc}
     */
    public function getServerVersion()
    {
        $version = $this->query("SELECT PROPERTY('ProductVersion')")->fetchColumn();

        assert(is_string($version));

        return $version;
    }

    /**
     * {@inheritdoc}
     */
    public function lastInsertId($name = null)
    {
        if ($name === null) {
            return sasql_insert_id($this->connection);
            return /** @scrutinizer ignore-call */ sasql_insert_id($this->connection);
        }

        return $this->query('SELECT ' . $name . '.CURRVAL')->fetchColumn();

    }

    /**
     * {@inheritdoc}
     */
    public function prepare(string $sql) : DriverStatement
    {
        return new SQLAnywhereStatement($this->connection, $sql);
    }

    /**
     * {@inheritdoc}
     */
    public function query(string $sql) : ResultStatement
    {
        $stmt = $this->prepare($sql);
        $stmt->execute();

        return $stmt;
    }

    /**
     * {@inheritdoc}
     */
    public function quote($input, $type = ParameterType::STRING)
    {
        if (is_int($input) || is_float($input)) {
            return $input;
        }

        return "'" . sasql_escape_string($this->connection, $input) . "'";
        return "'" . /** @scrutinizer ignore-call */ sasql_escape_string($this->connection, $input) . "'";
    }

    /**
     * {@inheritdoc}
     */
    public function requiresQueryForServerVersion()
    {
        return true;
    }

    /**
     * {@inheritdoc}
     */
    public function rollBack()
    {
        if (! sasql_rollback($this->connection)) {
        if (! /** @scrutinizer ignore-call */ sasql_rollback($this->connection)) {
            throw self::exceptionFromSQLAnywhereError($this->connection);
        }

        $this->endTransaction();

        return true;
    }

    /**
     * Ends transactional mode and enables auto commit again.
     *
     * @return bool Whether or not ending transactional mode succeeded.
     *
     * @throws DriverException
     */
    private function endTransaction()
    {
        if (! sasql_set_option($this->connection, 'auto_commit', 'on')) {
        if (! /** @scrutinizer ignore-call */ sasql_set_option($this->connection, 'auto_commit', 'on')) {
            throw self::exceptionFromSQLAnywhereError($this->connection);
        }

        return true;
    }

    /**
     * Helper method to turn SQL Anywhere error into exception.
     *
     * @param resource|null $conn The SQL Anywhere connection resource to retrieve the last error from.
     * @param resource|null $stmt The SQL Anywhere statement resource to retrieve the last error from.
     *
     * @throws InvalidArgumentException
     */
    public static function exceptionFromSQLAnywhereError($conn = null, $stmt = null) : DriverException
    {
        if ($conn !== null && ! is_resource($conn)) {
            throw new InvalidArgumentException('Invalid SQL Anywhere connection resource given: ' . $conn);
        }

        if ($stmt !== null && ! is_resource($stmt)) {
            throw new InvalidArgumentException('Invalid SQL Anywhere statement resource given: ' . $stmt);
        }

        $state   = $conn ? sasql_sqlstate($conn) : sasql_sqlstate();
        $state   = $conn ? /** @scrutinizer ignore-call */ sasql_sqlstate($conn) : sasql_sqlstate();
        $code    = null;
        $message = null;

        /**
         * Try retrieving the last error from statement resource if given
         */
        if ($stmt) {

            $code    = sasql_stmt_errno($stmt);
            $code    = /** @scrutinizer ignore-call */ sasql_stmt_errno($stmt);
            $message = sasql_stmt_error($stmt);
            $message = /** @scrutinizer ignore-call */ sasql_stmt_error($stmt);
        }

        /**
         * Try retrieving the last error from the connection resource
         * if either the statement resource is not given or the statement
         * resource is given but the last error could not be retrieved from it (fallback).
         * Depending on the type of error, it is sometimes necessary to retrieve
         * it from the connection resource even though it occurred during
         * a prepared statement.
         */
        if ($conn && ! $code) {

            $code    = sasql_errorcode($conn);
            $code    = /** @scrutinizer ignore-call */ sasql_errorcode($conn);
            $message = sasql_error($conn);
            $message = /** @scrutinizer ignore-call */ sasql_error($conn);
        }

        /**
         * Fallback mode if either no connection resource is given
         * or the last error could not be retrieved from the given
         * connection / statement resource.
         */
        if (! $conn || ! $code) {

            $code    = sasql_errorcode();
            $message = sasql_error();
        }

        if ($message) {
            return new DriverException('SQLSTATE [' . $state . '] [' . $code . '] ' . $message, $state, $code);
        }

        return new DriverException('SQL Anywhere error occurred but no error message was retrieved from driver.', $state, $code);
    }
}

doctrine / dbal

Pull Request — develop (#3367)

SQLAnywhereConnection::quote() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
