DBALException::invalidColumnIndex() - Code Metrics - Inspection of "Statement::fetchColumn() will throw an exception i..." - doctrine/dbal - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — develop (#3417)

by Sergei

created 2018-12-27 20:53 UTC

DBALException::invalidColumnIndex() A

↳ Parent: DBALException

Complexity

Conditions	2
Paths	1

Size

Total Lines	7
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

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

<?php

namespace Doctrine\DBAL;

use Doctrine\DBAL\Driver\DriverException as DriverExceptionInterface;
use Doctrine\DBAL\Driver\ExceptionConverterDriver;
use Doctrine\DBAL\Exception\DriverException;
use Doctrine\DBAL\Platforms\AbstractPlatform;
use Exception;
use Throwable;
use function array_map;
use function bin2hex;
use function get_class;
use function gettype;
use function implode;
use function is_object;
use function is_resource;
use function is_string;
use function json_encode;
use function sprintf;
use function str_split;

class DBALException extends Exception
{
    /**
     * @param string $method
     *
     * @return \Doctrine\DBAL\DBALException
     */
    public static function notSupported($method)
    {
        return new self(sprintf("Operation '%s' is not supported by platform.", $method));
    }

    public static function invalidPlatformSpecified() : self
    {
        return new self(
            "Invalid 'platform' option specified, need to give an instance of " . AbstractPlatform::class . '.'
        );
    }

    /**
     * @param mixed $invalidPlatform
     */
    public static function invalidPlatformType($invalidPlatform) : self
    {
        if (is_object($invalidPlatform)) {
            return new self(
                sprintf(
                    "Option 'platform' must be a subtype of '%s', instance of '%s' given",
                    AbstractPlatform::class,
                    get_class($invalidPlatform)
                )
            );
        }

        return new self(
            sprintf(
                "Option 'platform' must be an object and subtype of '%s'. Got '%s'",
                AbstractPlatform::class,
                gettype($invalidPlatform)
            )
        );
    }

    /**
     * Returns a new instance for an invalid specified platform version.
     *
     * @param string $version        The invalid platform version given.
     * @param string $expectedFormat The expected platform version format.
     *
     * @return DBALException
     */
    public static function invalidPlatformVersionSpecified($version, $expectedFormat)
    {
        return new self(
            sprintf(
                'Invalid platform version "%s" specified. ' .
                'The platform version has to be specified in the format: "%s".',
                $version,
                $expectedFormat
            )
        );
    }

    /**
     * @return \Doctrine\DBAL\DBALException
     */
    public static function invalidPdoInstance()
    {
        return new self(
            "The 'pdo' option was used in DriverManager::getConnection() but no " .
            'instance of PDO was given.'
        );
    }

    /**
     * @param string|null $url The URL that was provided in the connection parameters (if any).
     *
     * @return \Doctrine\DBAL\DBALException
     */
    public static function driverRequired($url = null)
    {
        if ($url) {
            return new self(
                sprintf(
                    "The options 'driver' or 'driverClass' are mandatory if a connection URL without scheme " .
                    'is given to DriverManager::getConnection(). Given URL: %s',
                    $url
                )
            );
        }

        return new self("The options 'driver' or 'driverClass' are mandatory if no PDO " .
            'instance is given to DriverManager::getConnection().');
    }

    /**
     * @param string   $unknownDriverName
     * @param string[] $knownDrivers
     *
     * @return \Doctrine\DBAL\DBALException
     */
    public static function unknownDriver($unknownDriverName, array $knownDrivers)
    {
        return new self("The given 'driver' " . $unknownDriverName . ' is unknown, ' .
            'Doctrine currently supports only the following drivers: ' . implode(', ', $knownDrivers));
    }

    /**
     * @param Exception $driverEx
     * @param string    $sql
     * @param mixed[]   $params
     *
     * @return \Doctrine\DBAL\DBALException
     */
    public static function driverExceptionDuringQuery(Driver $driver, Throwable $driverEx, $sql, array $params = [])
    {
        $msg = "An exception occurred while executing '" . $sql . "'";
        if ($params) {
            $msg .= ' with params ' . self::formatParameters($params);
        }
        $msg .= ":\n\n" . $driverEx->getMessage();

        return static::wrapException($driver, $driverEx, $msg);
    }

    /**
     * @param Exception $driverEx
     *
     * @return \Doctrine\DBAL\DBALException
     */
    public static function driverException(Driver $driver, Throwable $driverEx)
    {
        return static::wrapException($driver, $driverEx, 'An exception occurred in driver: ' . $driverEx->getMessage());
    }

    /**
     * @param Exception $driverEx
     *
     * @return \Doctrine\DBAL\DBALException
     */
    private static function wrapException(Driver $driver, Throwable $driverEx, $msg)
    {
        if ($driverEx instanceof DriverException) {
            return $driverEx;
        }
        if ($driver instanceof ExceptionConverterDriver && $driverEx instanceof DriverExceptionInterface) {
            return $driver->convertException($msg, $driverEx);
        }

        return new self($msg, 0, $driverEx);
    }

    /**
     * Returns a human-readable representation of an array of parameters.
     * This properly handles binary data by returning a hex representation.
     *
     * @param mixed[] $params
     *
     * @return string
     */
    private static function formatParameters(array $params)
    {
        return '[' . implode(', ', array_map(static function ($param) {
            if (is_resource($param)) {
                return (string) $param;
            }

            $json = @json_encode($param);

            if (! is_string($json) || $json === 'null' && is_string($param)) {

                // JSON encoding failed, this is not a UTF-8 string.
                return '"\x' . implode('\x', str_split(bin2hex($param), 2)) . '"';
            }

            return $json;
        }, $params)) . ']';
    }

    /**
     * @param string $wrapperClass
     *
     * @return \Doctrine\DBAL\DBALException
     */
    public static function invalidWrapperClass($wrapperClass)
    {
        return new self("The given 'wrapperClass' " . $wrapperClass . ' has to be a ' .
            'subtype of \Doctrine\DBAL\Connection.');
    }

    /**
     * @param string $driverClass
     *
     * @return \Doctrine\DBAL\DBALException
     */
    public static function invalidDriverClass($driverClass)
    {
        return new self("The given 'driverClass' " . $driverClass . ' has to implement the ' . Driver::class . ' interface.');
    }

    /**
     * @param string $tableName
     *
     * @return \Doctrine\DBAL\DBALException
     */
    public static function invalidTableName($tableName)
    {
        return new self('Invalid table name specified: ' . $tableName);
    }

    /**
     * @param string $tableName
     *
     * @return \Doctrine\DBAL\DBALException
     */
    public static function noColumnsSpecifiedForTable($tableName)
    {
        return new self('No columns specified for table ' . $tableName);
    }

    /**
     * @return \Doctrine\DBAL\DBALException
     */
    public static function limitOffsetInvalid()
    {
        return new self('Invalid Offset in Limit Query, it has to be larger than or equal to 0.');
    }

    /**
     * @param string $name
     *
     * @return \Doctrine\DBAL\DBALException
     */
    public static function typeExists($name)
    {
        return new self('Type ' . $name . ' already exists.');
    }

    /**
     * @param string $name
     *
     * @return \Doctrine\DBAL\DBALException
     */
    public static function unknownColumnType($name)
    {
        return new self('Unknown column type "' . $name . '" requested. Any Doctrine type that you use has ' .
            'to be registered with \Doctrine\DBAL\Types\Type::addType(). You can get a list of all the ' .
            'known types with \Doctrine\DBAL\Types\Type::getTypesMap(). If this error occurs during database ' .
            'introspection then you might have forgotten to register all database types for a Doctrine Type. Use ' .
            'AbstractPlatform#registerDoctrineTypeMapping() or have your custom types implement ' .
            'Type#getMappedDatabaseTypes(). If the type name is empty you might ' .
            'have a problem with the cache or forgot some mapping information.');
    }

    /**
     * @param string $name
     *
     * @return \Doctrine\DBAL\DBALException
     */
    public static function typeNotFound($name)
    {
        return new self('Type to be overwritten ' . $name . ' does not exist.');
    }

    public static function invalidColumnIndex(int $index, int $count) : self
    {
        return new self(sprintf(
            'Invalid column index %d. The statement result contains %d column%s.',
            $index,
            $count,
            $count === 1 ? '' : 's'
        ));
    }
}


1		<?php
2
3		namespace Doctrine\DBAL;
4
5		use Doctrine\DBAL\Driver\DriverException as DriverExceptionInterface;
6		use Doctrine\DBAL\Driver\ExceptionConverterDriver;
7		use Doctrine\DBAL\Exception\DriverException;
8		use Doctrine\DBAL\Platforms\AbstractPlatform;
9		use Exception;
10		use Throwable;
11		use function array_map;
12		use function bin2hex;
13		use function get_class;
14		use function gettype;
15		use function implode;
16		use function is_object;
17		use function is_resource;
18		use function is_string;
19		use function json_encode;
20		use function sprintf;
21		use function str_split;
22
23		class DBALException extends Exception
24		{
25		/**
26		* @param string $method
27		*
28		* @return \Doctrine\DBAL\DBALException
29		*/
30	691	public static function notSupported($method)
31		{
32	691	return new self(sprintf("Operation '%s' is not supported by platform.", $method));
33		}
34
35		public static function invalidPlatformSpecified() : self
36		{
37		return new self(
38		"Invalid 'platform' option specified, need to give an instance of " . AbstractPlatform::class . '.'
39		);
40		}
41
42		/**
43		* @param mixed $invalidPlatform
44		*/
45	69	public static function invalidPlatformType($invalidPlatform) : self
46		{
47	69	if (is_object($invalidPlatform)) {
48	46	return new self(
49	46	sprintf(
50	46	"Option 'platform' must be a subtype of '%s', instance of '%s' given",
51	46	AbstractPlatform::class,
52	46	get_class($invalidPlatform)
53		)
54		);
55		}
56
57	23	return new self(
58	23	sprintf(
59	23	"Option 'platform' must be an object and subtype of '%s'. Got '%s'",
60	23	AbstractPlatform::class,
61	23	gettype($invalidPlatform)
62		)
63		);
64		}
65
66		/**
67		* Returns a new instance for an invalid specified platform version.
68		*
69		* @param string $version The invalid platform version given.
70		* @param string $expectedFormat The expected platform version format.
71		*
72		* @return DBALException
73		*/
74	230	public static function invalidPlatformVersionSpecified($version, $expectedFormat)
75		{
76	230	return new self(
77	230	sprintf(
78		'Invalid platform version "%s" specified. ' .
79	230	'The platform version has to be specified in the format: "%s".',
80	230	$version,
81	230	$expectedFormat
82		)
83		);
84		}
85
86		/**
87		* @return \Doctrine\DBAL\DBALException
88		*/
89	23	public static function invalidPdoInstance()
90		{
91	23	return new self(
92		"The 'pdo' option was used in DriverManager::getConnection() but no " .
93	23	'instance of PDO was given.'
94		);
95		}
96
97		/**
98		* @param string\|null $url The URL that was provided in the connection parameters (if any).
99		*
100		* @return \Doctrine\DBAL\DBALException
101		*/
102	115	public static function driverRequired($url = null)
103		{
104	115	if ($url) {
105	92	return new self(
106	92	sprintf(
107		"The options 'driver' or 'driverClass' are mandatory if a connection URL without scheme " .
108	92	'is given to DriverManager::getConnection(). Given URL: %s',
109	92	$url
110		)
111		);
112		}
113
114	23	return new self("The options 'driver' or 'driverClass' are mandatory if no PDO " .
115	23	'instance is given to DriverManager::getConnection().');
116		}
117
118		/**
119		* @param string $unknownDriverName
120		* @param string[] $knownDrivers
121		*
122		* @return \Doctrine\DBAL\DBALException
123		*/
124	23	public static function unknownDriver($unknownDriverName, array $knownDrivers)
125		{
126	23	return new self("The given 'driver' " . $unknownDriverName . ' is unknown, ' .
127	23	'Doctrine currently supports only the following drivers: ' . implode(', ', $knownDrivers));
128		}
129
130		/**
131		* @param Exception $driverEx
132		* @param string $sql
133		* @param mixed[] $params
134		*
135		* @return \Doctrine\DBAL\DBALException
136		*/
137	3174	public static function driverExceptionDuringQuery(Driver $driver, Throwable $driverEx, $sql, array $params = [])
138		{
139	3174	$msg = "An exception occurred while executing '" . $sql . "'";
140	3174	if ($params) {
141	261	$msg .= ' with params ' . self::formatParameters($params);
142		}
143	3174	$msg .= ":\n\n" . $driverEx->getMessage();
144
145	3174	return static::wrapException($driver, $driverEx, $msg);
146		}
147
148		/**
149		* @param Exception $driverEx
150		*
151		* @return \Doctrine\DBAL\DBALException
152		*/
153	70	public static function driverException(Driver $driver, Throwable $driverEx)
154		{
155	70	return static::wrapException($driver, $driverEx, 'An exception occurred in driver: ' . $driverEx->getMessage());
156		}
157
158		/**
159		* @param Exception $driverEx
160		*
161		* @return \Doctrine\DBAL\DBALException
162		*/
163	3244	private static function wrapException(Driver $driver, Throwable $driverEx, $msg)
164		{
165	3244	if ($driverEx instanceof DriverException) {
166	23	return $driverEx;
167		}
168	3221	if ($driver instanceof ExceptionConverterDriver && $driverEx instanceof DriverExceptionInterface) {
169	2800	return $driver->convertException($msg, $driverEx);
170		}
171
172	421	return new self($msg, 0, $driverEx);
173		}
174
175		/**
176		* Returns a human-readable representation of an array of parameters.
177		* This properly handles binary data by returning a hex representation.
178		*
179		* @param mixed[] $params
180		*
181		* @return string
182		*/
183	261	private static function formatParameters(array $params)
184		{
185		return '[' . implode(', ', array_map(static function ($param) {
186	261	if (is_resource($param)) {
187	23	return (string) $param;
188		}
189
190	238	$json = @json_encode($param);
191
192	238	if (! is_string($json) \|\| $json === 'null' && is_string($param)) {
		0 ignored issues – show introduced 2018-10-20 23:33 UTC by Report Bug Copy Issue Report The condition `is_string($json)` is always `true`. Loading history...
193		// JSON encoding failed, this is not a UTF-8 string.
194	23	return '"\x' . implode('\x', str_split(bin2hex($param), 2)) . '"';
195		}
196
197	238	return $json;
198	261	}, $params)) . ']';
199		}
200
201		/**
202		* @param string $wrapperClass
203		*
204		* @return \Doctrine\DBAL\DBALException
205		*/
206	23	public static function invalidWrapperClass($wrapperClass)
207		{
208	23	return new self("The given 'wrapperClass' " . $wrapperClass . ' has to be a ' .
209	23	'subtype of \Doctrine\DBAL\Connection.');
210		}
211
212		/**
213		* @param string $driverClass
214		*
215		* @return \Doctrine\DBAL\DBALException
216		*/
217	23	public static function invalidDriverClass($driverClass)
218		{
219	23	return new self("The given 'driverClass' " . $driverClass . ' has to implement the ' . Driver::class . ' interface.');
220		}
221
222		/**
223		* @param string $tableName
224		*
225		* @return \Doctrine\DBAL\DBALException
226		*/
227	23	public static function invalidTableName($tableName)
228		{
229	23	return new self('Invalid table name specified: ' . $tableName);
230		}
231
232		/**
233		* @param string $tableName
234		*
235		* @return \Doctrine\DBAL\DBALException
236		*/
237	276	public static function noColumnsSpecifiedForTable($tableName)
238		{
239	276	return new self('No columns specified for table ' . $tableName);
240		}
241
242		/**
243		* @return \Doctrine\DBAL\DBALException
244		*/
245		public static function limitOffsetInvalid()
246		{
247		return new self('Invalid Offset in Limit Query, it has to be larger than or equal to 0.');
248		}
249
250		/**
251		* @param string $name
252		*
253		* @return \Doctrine\DBAL\DBALException
254		*/
255		public static function typeExists($name)
256		{
257		return new self('Type ' . $name . ' already exists.');
258		}
259
260		/**
261		* @param string $name
262		*
263		* @return \Doctrine\DBAL\DBALException
264		*/
265		public static function unknownColumnType($name)
266		{
267		return new self('Unknown column type "' . $name . '" requested. Any Doctrine type that you use has ' .
268		'to be registered with \Doctrine\DBAL\Types\Type::addType(). You can get a list of all the ' .
269		'known types with \Doctrine\DBAL\Types\Type::getTypesMap(). If this error occurs during database ' .
270		'introspection then you might have forgotten to register all database types for a Doctrine Type. Use ' .
271		'AbstractPlatform#registerDoctrineTypeMapping() or have your custom types implement ' .
272		'Type#getMappedDatabaseTypes(). If the type name is empty you might ' .
273		'have a problem with the cache or forgot some mapping information.');
274		}
275
276		/**
277		* @param string $name
278		*
279		* @return \Doctrine\DBAL\DBALException
280		*/
281	276	public static function typeNotFound($name)
282		{
283	276	return new self('Type to be overwritten ' . $name . ' does not exist.');
284		}
285
286		public static function invalidColumnIndex(int $index, int $count) : self
287		{
288		return new self(sprintf(
289		'Invalid column index %d. The statement result contains %d column%s.',
290		$index,
291		$count,
292		$count === 1 ? '' : 's'
293		));
294		}
295		}
296

doctrine / dbal

Pull Request — develop (#3417)

DBALException::invalidColumnIndex() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like