SQLSrvConnection::errorInfo() - Code Metrics - Inspection of "DBAL 3.0: suggestions to improve the Driver\Connec..." - doctrine/dbal - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — develop (#3335)

unknown

created 2018-11-25 17:09 UTC

SQLSrvConnection::errorInfo() A

↳ Parent: SQLSrvConnection

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php

namespace Doctrine\DBAL\Driver\SQLSrv;

use Doctrine\DBAL\Driver\Connection;
use Doctrine\DBAL\Driver\ResultStatement;
use Doctrine\DBAL\Driver\ServerInfoAwareConnection;
use Doctrine\DBAL\Driver\Statement as DriverStatement;
use const SQLSRV_ERR_ERRORS;
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 SQLSrvException
     */
    public function __construct($serverName, $connectionOptions)
    {
        if (! sqlsrv_configure('WarningsReturnAsErrors', 0)) {
            throw SQLSrvException::fromSqlSrvErrors();
        }

        $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 SQLSrvException::fromSqlSrvErrors();
        }
        $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 SQLSrvException::fromSqlSrvErrors();
        }

        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 ($result === false) {
            if ($name !== null) {
                $message = 'No sequence with name "' . $name . '" found.';
            } else {
                $message = 'No identity value was generated by the last statement.';
            }

            throw new SQLSrvException($message);
        }

        return (string) $result;
    }

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

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

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

    /**
     * {@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);
    }
}


1		<?php
2
3		namespace Doctrine\DBAL\Driver\SQLSrv;
4
5		use Doctrine\DBAL\Driver\Connection;
6		use Doctrine\DBAL\Driver\ResultStatement;
7		use Doctrine\DBAL\Driver\ServerInfoAwareConnection;
8		use Doctrine\DBAL\Driver\Statement as DriverStatement;
9		use const SQLSRV_ERR_ERRORS;
10		use function sqlsrv_begin_transaction;
11		use function sqlsrv_commit;
12		use function sqlsrv_configure;
13		use function sqlsrv_connect;
14		use function sqlsrv_errors;
15		use function sqlsrv_query;
16		use function sqlsrv_rollback;
17		use function sqlsrv_rows_affected;
18		use function sqlsrv_server_info;
19		use function str_replace;
20
21		/**
22		* SQL Server implementation for the Connection interface.
23		*/
24		class SQLSrvConnection implements Connection, ServerInfoAwareConnection
25		{
26		/** @var resource */
27		protected $conn;
28
29		/** @var LastInsertId */
30		protected $lastInsertId;
31
32		/**
33		* @param string $serverName
34		* @param mixed[] $connectionOptions
35		*
36		* @throws SQLSrvException
37		*/
38	25	public function __construct($serverName, $connectionOptions)
39		{
40	25	if (! sqlsrv_configure('WarningsReturnAsErrors', 0)) {
41		throw SQLSrvException::fromSqlSrvErrors();
42		}
43
44	25	$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...
45	25	if (! $this->conn) {
46	1	throw SQLSrvException::fromSqlSrvErrors();
47		}
48	25	$this->lastInsertId = new LastInsertId();
49	25	}
50
51		/**
52		* {@inheritdoc}
53		*/
54	22	public function getServerVersion()
55		{
56	22	$serverInfo = sqlsrv_server_info($this->conn);
57
58	22	return $serverInfo['SQLServerVersion'];
59		}
60
61		/**
62		* {@inheritdoc}
63		*/
64	23	public function requiresQueryForServerVersion()
65		{
66	23	return false;
67		}
68
69		/**
70		* {@inheritDoc}
71		*/
72	242	public function prepare(string $sql) : DriverStatement
73		{
74	242	return new SQLSrvStatement($this->conn, $sql, $this->lastInsertId);
75		}
76
77		/**
78		* {@inheritDoc}
79		*/
80	179	public function query(string $sql) : ResultStatement
81		{
82	179	$stmt = $this->prepare($sql);
83	179	$stmt->execute();
84
85	179	return $stmt;
86		}
87
88		/**
89		* {@inheritDoc}
90		*/
91	7	public function quote(string $value) : string
92		{
93	7	return "'" . str_replace("'", "''", $value) . "'";
94		}
95
96		/**
97		* {@inheritDoc}
98		*/
99	160	public function exec(string $statement) : int
100		{
101	160	$stmt = sqlsrv_query($this->conn, $statement);
102
103	160	if ($stmt === false) {
104	101	throw SQLSrvException::fromSqlSrvErrors();
105		}
106
107	135	return sqlsrv_rows_affected($stmt);
108		}
109
110		/**
111		* {@inheritDoc}
112		*/
113	3	public function lastInsertId(?string $name = null) : string
114		{
115	3	if ($name !== null) {
116	1	$stmt = $this->prepare('SELECT CONVERT(VARCHAR(MAX), current_value) FROM sys.sequences WHERE name = ?');
117	1	$stmt->execute([$name]);
118		} else {
119	2	$stmt = $this->query('SELECT @@IDENTITY');
120		}
121
122	3	$result = $stmt->fetchColumn();
123
124	3	if ($result === false) {
125		if ($name !== null) {
126		$message = 'No sequence with name "' . $name . '" found.';
127		} else {
128		$message = 'No identity value was generated by the last statement.';
129		}
130
131		throw new SQLSrvException($message);
132		}
133
134	3	return (string) $result;
135		}
136
137		/**
138		* {@inheritDoc}
139		*/
140	15	public function beginTransaction() : void
141		{
142	15	if (! sqlsrv_begin_transaction($this->conn)) {
143		throw SQLSrvException::fromSqlSrvErrors();
144		}
145	15	}
146
147		/**
148		* {@inheritDoc}
149		*/
150	6	public function commit() : void
151		{
152	6	if (! sqlsrv_commit($this->conn)) {
153		throw SQLSrvException::fromSqlSrvErrors();
154		}
155	6	}
156
157		/**
158		* {@inheritDoc}
159		*/
160	10	public function rollBack() : void
161		{
162	10	if (! sqlsrv_rollback($this->conn)) {
163		throw SQLSrvException::fromSqlSrvErrors();
164		}
165	10	}
166
167		/**
168		* {@inheritDoc}
169		*/
170		public function errorCode()
171		{
172		$errors = sqlsrv_errors(SQLSRV_ERR_ERRORS);
173		if ($errors) {
174		return $errors[0]['code'];
175		}
176
177		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...
178		}
179
180		/**
181		* {@inheritDoc}
182		*/
183		public function errorInfo()
184		{
185		return sqlsrv_errors(SQLSRV_ERR_ERRORS);
186		}
187		}
188

doctrine / dbal

Pull Request — develop (#3335)

SQLSrvConnection::errorInfo() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like