SQLSrvConnection::exceptionFromSqlSrvErrors() - 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-11-30 00:59 UTC

SQLSrvConnection::exceptionFromSqlSrvErrors() A

↳ Parent: SQLSrvConnection

Complexity

Conditions	5
Paths	10

Size

Total Lines	25
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	30

Importance

Changes

Metric	Value
eloc	14
dl	0
loc	25
ccs	0
cts	0
cp	0
rs	9.4888
c	0
b	0
f	0
cc	5
nc	10
nop	0
crap	30

<?php

namespace Doctrine\DBAL\Driver\SQLSrv;

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 const SQLSRV_ERR_ERRORS;
use function rtrim;
use function sqlsrv_begin_transaction;
use function sqlsrv_commit;
use function sqlsrv_configure;
use function sqlsrv_connect;
use function sqlsrv_errors;
use function sqlsrv_query;
use function sqlsrv_rollback;
use function sqlsrv_rows_affected;
use function sqlsrv_server_info;
use function str_replace;

/**
 * SQL Server implementation for the Connection interface.
 */
class SQLSrvConnection implements Connection, ServerInfoAwareConnection
{
    /** @var resource */
    protected $conn;

    /** @var LastInsertId */
    protected $lastInsertId;

    /**
     * @param string  $serverName
     * @param mixed[] $connectionOptions
     *
     * @throws DriverException
     */
    public function __construct($serverName, $connectionOptions)
    {
        if (! sqlsrv_configure('WarningsReturnAsErrors', 0)) {
            throw self::exceptionFromSqlSrvErrors();
        }

        $this->conn = sqlsrv_connect($serverName, $connectionOptions);
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
        if (! $this->conn) {
            throw self::exceptionFromSqlSrvErrors();
        }
        $this->lastInsertId = new LastInsertId();
    }

    /**
     * {@inheritdoc}
     */
    public function getServerVersion()
    {
        $serverInfo = sqlsrv_server_info($this->conn);

        return $serverInfo['SQLServerVersion'];
    }

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

    /**
     * {@inheritDoc}
     */
    public function prepare(string $sql) : DriverStatement
    {
        return new SQLSrvStatement($this->conn, $sql, $this->lastInsertId);
    }

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

        return $stmt;
    }

    /**
     * {@inheritDoc}
     */
    public function quote(string $value) : string
    {
        return "'" . str_replace("'", "''", $value) . "'";
    }

    /**
     * {@inheritDoc}
     */
    public function exec(string $statement) : int
    {
        $stmt = sqlsrv_query($this->conn, $statement);

        if ($stmt === false) {
            throw self::exceptionFromSqlSrvErrors();
        }

        return sqlsrv_rows_affected($stmt);
    }

    /**
     * {@inheritDoc}
     */
    public function lastInsertId(?string $name = null) : string
    {
        if ($name !== null) {
            $stmt = $this->prepare('SELECT CONVERT(VARCHAR(MAX), current_value) FROM sys.sequences WHERE name = ?');
            $stmt->execute([$name]);
        } else {
            $stmt = $this->query('SELECT @@IDENTITY');
        }

        $result = $stmt->fetchColumn();

        if ($name !== null) {
            if ($result === false) {
                throw DriverException::noSuchSequence($name);
            }
        } else {
            if ($result === null) {
                throw DriverException::noInsertId();
            }
        }

        return (string) $result;
    }

    /**
     * {@inheritDoc}
     */
    public function beginTransaction() : void
    {
        if (! sqlsrv_begin_transaction($this->conn)) {
            throw self::exceptionFromSqlSrvErrors();
        }
    }

    /**
     * {@inheritDoc}
     */
    public function commit() : void
    {
        if (! sqlsrv_commit($this->conn)) {
            throw self::exceptionFromSqlSrvErrors();
        }
    }

    /**
     * {@inheritDoc}
     */
    public function rollBack() : void
    {
        if (! sqlsrv_rollback($this->conn)) {
            throw self::exceptionFromSqlSrvErrors();
        }
    }

    /**
     * {@inheritDoc}
     */
    public function errorCode()
    {
        $errors = sqlsrv_errors(SQLSRV_ERR_ERRORS);
        if ($errors) {
            return $errors[0]['code'];
        }

        return false;
interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
    }

    /**
     * {@inheritDoc}
     */
    public function errorInfo()
    {
        return sqlsrv_errors(SQLSRV_ERR_ERRORS);
    }

    /**
     * Helper method to turn sql server errors into exception.
     */
    public static function exceptionFromSqlSrvErrors() : DriverException
    {
        $errors    = sqlsrv_errors(SQLSRV_ERR_ERRORS);
        $message   = '';
        $sqlState  = null;
        $errorCode = null;

        foreach ($errors as $error) {
            $message .= 'SQLSTATE [' . $error['SQLSTATE'] . ', ' . $error['code'] . ']: ' . $error['message'] . "\n";

            if ($sqlState === null) {
                $sqlState = $error['SQLSTATE'];
            }

            if ($errorCode !== null) {
                continue;
            }

            $errorCode = $error['code'];
        }
        if (! $message) {
            $message = 'SQL Server error occurred but no error message was retrieved from driver.';
        }

        return new DriverException(rtrim($message), $sqlState, $errorCode);
    }
}


1		<?php
2
3		namespace Doctrine\DBAL\Driver\SQLSrv;
4
5		use Doctrine\DBAL\Driver\Connection;
6		use Doctrine\DBAL\Driver\DriverException;
7		use Doctrine\DBAL\Driver\ResultStatement;
8		use Doctrine\DBAL\Driver\ServerInfoAwareConnection;
9		use Doctrine\DBAL\Driver\Statement as DriverStatement;
10		use const SQLSRV_ERR_ERRORS;
11		use function rtrim;
12		use function sqlsrv_begin_transaction;
13		use function sqlsrv_commit;
14		use function sqlsrv_configure;
15		use function sqlsrv_connect;
16		use function sqlsrv_errors;
17		use function sqlsrv_query;
18		use function sqlsrv_rollback;
19		use function sqlsrv_rows_affected;
20		use function sqlsrv_server_info;
21		use function str_replace;
22
23		/**
24		* SQL Server implementation for the Connection interface.
25		*/
26		class SQLSrvConnection implements Connection, ServerInfoAwareConnection
27		{
28		/** @var resource */
29		protected $conn;
30
31		/** @var LastInsertId */
32		protected $lastInsertId;
33
34		/**
35		* @param string $serverName
36		* @param mixed[] $connectionOptions
37		*
38		* @throws DriverException
39		*/
40		public function __construct($serverName, $connectionOptions)
41		{
42	26	if (! sqlsrv_configure('WarningsReturnAsErrors', 0)) {
43		throw self::exceptionFromSqlSrvErrors();
44	26	}
45
46		$this->conn = sqlsrv_connect($serverName, $connectionOptions);
		0 ignored issues – show Documentation Bug introduced 2017-11-30 20:31 UTC by Report Bug Copy Issue Report It seems like `sqlsrv_connect($serverName, $connectionOptions)` can also be of type `false`. However, the property `$conn` is declared as type `resource`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
47		if (! $this->conn) {
48	26	throw self::exceptionFromSqlSrvErrors();
49	26	}
50	1	$this->lastInsertId = new LastInsertId();
51		}
52	26
53	26	/**
54		* {@inheritdoc}
55		*/
56		public function getServerVersion()
57		{
58	23	$serverInfo = sqlsrv_server_info($this->conn);
59
60	23	return $serverInfo['SQLServerVersion'];
61		}
62	23
63		/**
64		* {@inheritdoc}
65		*/
66		public function requiresQueryForServerVersion()
67		{
68	24	return false;
69		}
70	24
71		/**
72		* {@inheritDoc}
73		*/
74		public function prepare(string $sql) : DriverStatement
75		{
76	242	return new SQLSrvStatement($this->conn, $sql, $this->lastInsertId);
77		}
78	242
79		/**
80		* {@inheritDoc}
81		*/
82		public function query(string $sql) : ResultStatement
83		{
84	179	$stmt = $this->prepare($sql);
85		$stmt->execute();
86	179
87	179	return $stmt;
88		}
89	179
90		/**
91		* {@inheritDoc}
92		*/
93		public function quote(string $value) : string
94		{
95	8	return "'" . str_replace("'", "''", $value) . "'";
96		}
97	8
98	2	/**
99	7	* {@inheritDoc}
100		*/
101		public function exec(string $statement) : int
102		{
103	7	$stmt = sqlsrv_query($this->conn, $statement);
104
105		if ($stmt === false) {
106		throw self::exceptionFromSqlSrvErrors();
107		}
108
109	160	return sqlsrv_rows_affected($stmt);
110		}
111	160
112		/**
113	160	* {@inheritDoc}
114	101	*/
115		public function lastInsertId(?string $name = null) : string
116		{
117	135	if ($name !== null) {
118		$stmt = $this->prepare('SELECT CONVERT(VARCHAR(MAX), current_value) FROM sys.sequences WHERE name = ?');
119		$stmt->execute([$name]);
120		} else {
121		$stmt = $this->query('SELECT @@IDENTITY');
122		}
123	3
124		$result = $stmt->fetchColumn();
125	3
126	1	if ($name !== null) {
127	1	if ($result === false) {
128		throw DriverException::noSuchSequence($name);
129	2	}
130		} else {
131		if ($result === null) {
132	3	throw DriverException::noInsertId();
133		}
134		}
135
136		return (string) $result;
137		}
138	15
139		/**
140	15	* {@inheritDoc}
141		*/
142		public function beginTransaction() : void
143	15	{
144		if (! sqlsrv_begin_transaction($this->conn)) {
145		throw self::exceptionFromSqlSrvErrors();
146		}
147		}
148	6
149		/**
150	6	* {@inheritDoc}
151		*/
152		public function commit() : void
153	6	{
154		if (! sqlsrv_commit($this->conn)) {
155		throw self::exceptionFromSqlSrvErrors();
156		}
157		}
158	10
159		/**
160	10	* {@inheritDoc}
161		*/
162		public function rollBack() : void
163	10	{
164		if (! sqlsrv_rollback($this->conn)) {
165		throw self::exceptionFromSqlSrvErrors();
166		}
167		}
168
169		/**
170		* {@inheritDoc}
171		*/
172		public function errorCode()
173		{
174		$errors = sqlsrv_errors(SQLSRV_ERR_ERRORS);
175		if ($errors) {
176		return $errors[0]['code'];
177		}
178
179		return false;
		0 ignored issues – show Bug Best Practice introduced 2017-11-18 19:58 UTC by Report Bug Copy Issue Report The expression `return false` returns the type `false` which is incompatible with the return type mandated by `Doctrine\DBAL\Driver\Connection::errorCode()` of `null\|string`. In the issue above, the returned value is violating the contract defined by the mentioned interface. Let's take a look at an example: interface HasName { /** @return string / public function getName(); } class Name { public $name; } class User implements HasName { /* @return string\|Name */ public function getName() { return new Name('foo'); // This is a violation of the ``HasName`` interface // which only allows a string value to be returned. } } Loading history...
180		}
181
182		/**
183		* {@inheritDoc}
184		*/
185		public function errorInfo()
186		{
187		return sqlsrv_errors(SQLSRV_ERR_ERRORS);
188		}
189
190		/**
191		* Helper method to turn sql server errors into exception.
192		*/
193		public static function exceptionFromSqlSrvErrors() : DriverException
194		{
195		$errors = sqlsrv_errors(SQLSRV_ERR_ERRORS);
196		$message = '';
197		$sqlState = null;
198		$errorCode = null;
199
200		foreach ($errors as $error) {
201		$message .= 'SQLSTATE [' . $error['SQLSTATE'] . ', ' . $error['code'] . ']: ' . $error['message'] . "\n";
202
203		if ($sqlState === null) {
204		$sqlState = $error['SQLSTATE'];
205		}
206
207		if ($errorCode !== null) {
208		continue;
209		}
210
211		$errorCode = $error['code'];
212		}
213		if (! $message) {
214		$message = 'SQL Server error occurred but no error message was retrieved from driver.';
215		}
216
217		return new DriverException(rtrim($message), $sqlState, $errorCode);
218		}
219		}
220

doctrine / dbal

Pull Request — develop (#3367)

SQLSrvConnection::exceptionFromSqlSrvErrors() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like