DB2Statement::bindValue() - Code Metrics - Inspection of "Move phpcs from Travis to GitHub Actions" - doctrine/dbal - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — 2.10.x (#3979)

by Ben

created 2020-05-05 21:13 UTC

DB2Statement::bindValue() A

↳ Parent: DB2Statement

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	3
crap	2

<?php

namespace Doctrine\DBAL\Driver\IBMDB2;

use Doctrine\DBAL\Driver\Statement;
use Doctrine\DBAL\Driver\StatementIterator;
use Doctrine\DBAL\FetchMode;
use Doctrine\DBAL\ParameterType;
use IteratorAggregate;
use PDO;
use ReflectionClass;
use ReflectionObject;
use ReflectionProperty;
use stdClass;
use function array_change_key_case;
use function db2_bind_param;
use function db2_execute;
use function db2_fetch_array;
use function db2_fetch_assoc;
use function db2_fetch_both;
use function db2_fetch_object;
use function db2_free_result;
use function db2_num_fields;
use function db2_num_rows;
use function db2_stmt_error;
use function db2_stmt_errormsg;
use function error_get_last;
use function fclose;
use function func_get_args;
use function func_num_args;
use function fwrite;
use function gettype;
use function is_object;
use function is_resource;
use function is_string;
use function ksort;
use function sprintf;
use function stream_copy_to_stream;
use function stream_get_meta_data;
use function strtolower;
use function tmpfile;
use const CASE_LOWER;
use const DB2_BINARY;
use const DB2_CHAR;
use const DB2_LONG;
use const DB2_PARAM_FILE;
use const DB2_PARAM_IN;

class DB2Statement implements IteratorAggregate, Statement
{
    /** @var resource */
    private $stmt;

    /** @var mixed[] */
    private $bindParam = [];

    /**
     * Map of LOB parameter positions to the tuples containing reference to the variable bound to the driver statement
     * and the temporary file handle bound to the underlying statement
     *
     * @var mixed[][]
     */
    private $lobs = [];

    /** @var string Name of the default class to instantiate when fetching class instances. */
    private $defaultFetchClass = '\stdClass';

    /** @var mixed[] Constructor arguments for the default class to instantiate when fetching class instances. */
    private $defaultFetchClassCtorArgs = [];

    /** @var int */
    private $defaultFetchMode = FetchMode::MIXED;

    /**
     * Indicates whether the statement is in the state when fetching results is possible
     *
     * @var bool
     */
    private $result = false;

    /**
     * @param resource $stmt
     */
    public function __construct($stmt)
    {
        $this->stmt = $stmt;
    }

    /**
     * {@inheritdoc}
     */
    public function bindValue($param, $value, $type = ParameterType::STRING)
    {
        return $this->bindParam($param, $value, $type);
    }

    /**
     * {@inheritdoc}
     */
    public function bindParam($column, &$variable, $type = ParameterType::STRING, $length = null)
    {
        switch ($type) {
            case ParameterType::INTEGER:
                $this->bind($column, $variable, DB2_PARAM_IN, DB2_LONG);
                break;

            case ParameterType::LARGE_OBJECT:
                if (isset($this->lobs[$column])) {
                    [, $handle] = $this->lobs[$column];
                    fclose($handle);
                }

                $handle = $this->createTemporaryFile();
                $path   = stream_get_meta_data($handle)['uri'];

                $this->bind($column, $path, DB2_PARAM_FILE, DB2_BINARY);

                $this->lobs[$column] = [&$variable, $handle];
                break;

            default:
                $this->bind($column, $variable, DB2_PARAM_IN, DB2_CHAR);
                break;
        }

        return true;
    }

    /**
     * @param int   $position Parameter position
     * @param mixed $variable
     *
     * @throws DB2Exception
     */
    private function bind($position, &$variable, int $parameterType, int $dataType) : void
    {
        $this->bindParam[$position] =& $variable;

        if (! db2_bind_param($this->stmt, $position, 'variable', $parameterType, $dataType)) {
            throw new DB2Exception(db2_stmt_errormsg());
        }
    }

    /**
     * {@inheritdoc}
     */
    public function closeCursor()
    {
        $this->bindParam = [];

        if (! db2_free_result($this->stmt)) {
            return false;
        }

        $this->result = false;

        return true;
    }

    /**
     * {@inheritdoc}
     */
    public function columnCount()
    {
        return db2_num_fields($this->stmt) ?: 0;
    }

    /**
     * {@inheritdoc}
     */
    public function errorCode()
    {
        return db2_stmt_error();
    }

    /**
     * {@inheritdoc}
     */
    public function errorInfo()
    {
        return [
            db2_stmt_errormsg(),
            db2_stmt_error(),
        ];
    }

    /**
     * {@inheritdoc}
     */
    public function execute($params = null)
    {
        if ($params === null) {
            ksort($this->bindParam);

            $params = [];

            foreach ($this->bindParam as $column => $value) {
                $params[] = $value;
            }
        }

        foreach ($this->lobs as [$source, $target]) {
            if (is_resource($source)) {
                $this->copyStreamToStream($source, $target);

                continue;
            }

            $this->writeStringToStream($source, $target);
        }

        $retval = db2_execute($this->stmt, $params);

        foreach ($this->lobs as [, $handle]) {
            fclose($handle);
        }

        $this->lobs = [];

        if ($retval === false) {
            throw new DB2Exception(db2_stmt_errormsg());
        }

        $this->result = true;

        return $retval;
    }

    /**
     * {@inheritdoc}
     */
    public function setFetchMode($fetchMode, $arg2 = null, $arg3 = null)
    {
        $this->defaultFetchMode          = $fetchMode;
        $this->defaultFetchClass         = $arg2 ?: $this->defaultFetchClass;
        $this->defaultFetchClassCtorArgs = $arg3 ? (array) $arg3 : $this->defaultFetchClassCtorArgs;

        return true;
    }

    /**
     * {@inheritdoc}
     */
    public function getIterator()
    {
        return new StatementIterator($this);
    }

    /**
     * {@inheritdoc}
     */
    public function fetch($fetchMode = null, $cursorOrientation = PDO::FETCH_ORI_NEXT, $cursorOffset = 0)
    {
        // do not try fetching from the statement if it's not expected to contain result
        // in order to prevent exceptional situation
        if (! $this->result) {
            return false;
        }

        $fetchMode = $fetchMode ?: $this->defaultFetchMode;
        switch ($fetchMode) {
            case FetchMode::COLUMN:
                return $this->fetchColumn();

            case FetchMode::MIXED:
                return db2_fetch_both($this->stmt);

            case FetchMode::ASSOCIATIVE:
                return db2_fetch_assoc($this->stmt);

            case FetchMode::CUSTOM_OBJECT:
                $className = $this->defaultFetchClass;
                $ctorArgs  = $this->defaultFetchClassCtorArgs;

                if (func_num_args() >= 2) {
                    $args      = func_get_args();
                    $className = $args[1];
                    $ctorArgs  = $args[2] ?? [];
                }

                $result = db2_fetch_object($this->stmt);

                if ($result instanceof stdClass) {
                    $result = $this->castObject($result, $className, $ctorArgs);
                }

                return $result;

            case FetchMode::NUMERIC:
                return db2_fetch_array($this->stmt);

            case FetchMode::STANDARD_OBJECT:
                return db2_fetch_object($this->stmt);

            default:
                throw new DB2Exception('Given Fetch-Style ' . $fetchMode . ' is not supported.');
        }
    }

    /**
     * {@inheritdoc}
     */
    public function fetchAll($fetchMode = null, $fetchArgument = null, $ctorArgs = null)
    {
        $rows = [];

        switch ($fetchMode) {
            case FetchMode::CUSTOM_OBJECT:
                while (($row = $this->fetch(...func_get_args())) !== false) {
                    $rows[] = $row;
                }

                break;

            case FetchMode::COLUMN:
                while (($row = $this->fetchColumn()) !== false) {
                    $rows[] = $row;
                }

                break;

            default:
                while (($row = $this->fetch($fetchMode)) !== false) {
                    $rows[] = $row;
                }
        }

        return $rows;
    }

    /**
     * {@inheritdoc}
     */
    public function fetchColumn($columnIndex = 0)
    {
        $row = $this->fetch(FetchMode::NUMERIC);

        if ($row === false) {
            return false;
        }

        return $row[$columnIndex] ?? null;
    }

    /**
     * {@inheritdoc}
     */
    public function rowCount()
    {
        return @db2_num_rows($this->stmt) ? : 0;
    }

    /**
     * Casts a stdClass object to the given class name mapping its' properties.
     *
     * @param stdClass      $sourceObject     Object to cast from.
     * @param string|object $destinationClass Name of the class or class instance to cast to.
     * @param mixed[]       $ctorArgs         Arguments to use for constructing the destination class instance.
     *
     * @return object
     *
     * @throws DB2Exception
     */
    private function castObject(stdClass $sourceObject, $destinationClass, array $ctorArgs = [])
    {
        if (! is_string($destinationClass)) {
            if (! is_object($destinationClass)) {
                throw new DB2Exception(sprintf(
                    'Destination class has to be of type string or object, %s given.',
                    gettype($destinationClass)
                ));
            }
        } else {
            $destinationClass = new ReflectionClass($destinationClass);
            $destinationClass = $destinationClass->newInstanceArgs($ctorArgs);
        }

        $sourceReflection           = new ReflectionObject($sourceObject);
        $destinationClassReflection = new ReflectionObject($destinationClass);
        /** @var ReflectionProperty[] $destinationProperties */
        $destinationProperties = array_change_key_case($destinationClassReflection->getProperties(), CASE_LOWER);

        foreach ($sourceReflection->getProperties() as $sourceProperty) {
            $sourceProperty->setAccessible(true);

            $name  = $sourceProperty->getName();
            $value = $sourceProperty->getValue($sourceObject);

            // Try to find a case-matching property.
            if ($destinationClassReflection->hasProperty($name)) {
                $destinationProperty = $destinationClassReflection->getProperty($name);

                $destinationProperty->setAccessible(true);
                $destinationProperty->setValue($destinationClass, $value);

                continue;
            }

            $name = strtolower($name);

            // Try to find a property without matching case.
            // Fallback for the driver returning either all uppercase or all lowercase column names.
            if (isset($destinationProperties[$name])) {
                $destinationProperty = $destinationProperties[$name];

                $destinationProperty->setAccessible(true);
                $destinationProperty->setValue($destinationClass, $value);

                continue;
            }

            $destinationClass->$name = $value;
        }

        return $destinationClass;
    }

    /**
     * @return resource
     *
     * @throws DB2Exception
     */
    private function createTemporaryFile()
    {
        $handle = @tmpfile();

        if ($handle === false) {
            throw new DB2Exception('Could not create temporary file: ' . error_get_last()['message']);
        }

        return $handle;
    }

    /**
     * @param resource $source
     * @param resource $target
     *
     * @throws DB2Exception
     */
    private function copyStreamToStream($source, $target) : void
    {
        if (@stream_copy_to_stream($source, $target) === false) {
            throw new DB2Exception('Could not copy source stream to temporary file: ' . error_get_last()['message']);
        }
    }

    /**
     * @param resource $target
     *
     * @throws DB2Exception
     */
    private function writeStringToStream(string $string, $target) : void
    {
        if (@fwrite($target, $string) === false) {
            throw new DB2Exception('Could not write string to temporary file: ' . error_get_last()['message']);
        }
    }
}


1			<?php
2
3			namespace Doctrine\DBAL\Driver\IBMDB2;
4
5			use Doctrine\DBAL\Driver\Statement;
6			use Doctrine\DBAL\Driver\StatementIterator;
7			use Doctrine\DBAL\FetchMode;
8			use Doctrine\DBAL\ParameterType;
9			use IteratorAggregate;
10			use PDO;
11			use ReflectionClass;
12			use ReflectionObject;
13			use ReflectionProperty;
14			use stdClass;
15			use function array_change_key_case;
16			use function db2_bind_param;
17			use function db2_execute;
18			use function db2_fetch_array;
19			use function db2_fetch_assoc;
20			use function db2_fetch_both;
21			use function db2_fetch_object;
22			use function db2_free_result;
23			use function db2_num_fields;
24			use function db2_num_rows;
25			use function db2_stmt_error;
26			use function db2_stmt_errormsg;
27			use function error_get_last;
28			use function fclose;
29			use function func_get_args;
30			use function func_num_args;
31			use function fwrite;
32			use function gettype;
33			use function is_object;
34			use function is_resource;
35			use function is_string;
36			use function ksort;
37			use function sprintf;
38			use function stream_copy_to_stream;
39			use function stream_get_meta_data;
40			use function strtolower;
41			use function tmpfile;
42			use const CASE_LOWER;
43			use const DB2_BINARY;
44			use const DB2_CHAR;
45			use const DB2_LONG;
46			use const DB2_PARAM_FILE;
47			use const DB2_PARAM_IN;
48
49			class DB2Statement implements IteratorAggregate, Statement
50			{
51			/** @var resource */
52			private $stmt;
53
54			/** @var mixed[] */
55			private $bindParam = [];
56
57			/**
58			* Map of LOB parameter positions to the tuples containing reference to the variable bound to the driver statement
59			* and the temporary file handle bound to the underlying statement
60			*
61			* @var mixed[][]
62			*/
63			private $lobs = [];
64
65			/** @var string Name of the default class to instantiate when fetching class instances. */
66			private $defaultFetchClass = '\stdClass';
67
68			/** @var mixed[] Constructor arguments for the default class to instantiate when fetching class instances. */
69			private $defaultFetchClassCtorArgs = [];
70
71			/** @var int */
72			private $defaultFetchMode = FetchMode::MIXED;
73
74			/**
75			* Indicates whether the statement is in the state when fetching results is possible
76			*
77			* @var bool
78			*/
79			private $result = false;
80
81			/**
82			* @param resource $stmt
83			*/
84			public function __construct($stmt)
85			{
86			$this->stmt = $stmt;
87			}
88
89			/**
90			* {@inheritdoc}
91			*/
92			public function bindValue($param, $value, $type = ParameterType::STRING)
93			{
94			return $this->bindParam($param, $value, $type);
95			}
96
97			/**
98			* {@inheritdoc}
99			*/
100			public function bindParam($column, &$variable, $type = ParameterType::STRING, $length = null)
101			{
102			switch ($type) {
103			case ParameterType::INTEGER:
104			$this->bind($column, $variable, DB2_PARAM_IN, DB2_LONG);
105			break;
106
107			case ParameterType::LARGE_OBJECT:
108			if (isset($this->lobs[$column])) {
109			[, $handle] = $this->lobs[$column];
110			fclose($handle);
111			}
112
113			$handle = $this->createTemporaryFile();
114			$path = stream_get_meta_data($handle)['uri'];
115
116			$this->bind($column, $path, DB2_PARAM_FILE, DB2_BINARY);
117
118			$this->lobs[$column] = [&$variable, $handle];
119			break;
120
121			default:
122			$this->bind($column, $variable, DB2_PARAM_IN, DB2_CHAR);
123			break;
124			}
125
126			return true;
127			}
128
129			/**
130			* @param int $position Parameter position
131			* @param mixed $variable
132			*
133			* @throws DB2Exception
134			*/
135			private function bind($position, &$variable, int $parameterType, int $dataType) : void
136			{
137			$this->bindParam[$position] =& $variable;
138
139			if (! db2_bind_param($this->stmt, $position, 'variable', $parameterType, $dataType)) {
140			throw new DB2Exception(db2_stmt_errormsg());
141			}
142			}
143
144			/**
145			* {@inheritdoc}
146			*/
147			public function closeCursor()
148			{
149			$this->bindParam = [];
150
151			if (! db2_free_result($this->stmt)) {
152			return false;
153			}
154
155			$this->result = false;
156
157			return true;
158			}
159
160			/**
161			* {@inheritdoc}
162			*/
163			public function columnCount()
164			{
165			return db2_num_fields($this->stmt) ?: 0;
166			}
167
168			/**
169			* {@inheritdoc}
170			*/
171			public function errorCode()
172			{
173			return db2_stmt_error();
174			}
175
176			/**
177			* {@inheritdoc}
178			*/
179			public function errorInfo()
180			{
181			return [
182			db2_stmt_errormsg(),
183			db2_stmt_error(),
184			];
185			}
186
187			/**
188			* {@inheritdoc}
189			*/
190			public function execute($params = null)
191			{
192			if ($params === null) {
193			ksort($this->bindParam);
194
195			$params = [];
196
197			foreach ($this->bindParam as $column => $value) {
198			$params[] = $value;
199			}
200			}
201
202			foreach ($this->lobs as [$source, $target]) {
203			if (is_resource($source)) {
204			$this->copyStreamToStream($source, $target);
205
206			continue;
207			}
208
209			$this->writeStringToStream($source, $target);
210			}
211
212			$retval = db2_execute($this->stmt, $params);
213
214			foreach ($this->lobs as [, $handle]) {
215			fclose($handle);
216			}
217
218			$this->lobs = [];
219
220			if ($retval === false) {
221			throw new DB2Exception(db2_stmt_errormsg());
222			}
223
224			$this->result = true;
225
226			return $retval;
227			}
228
229			/**
230			* {@inheritdoc}
231			*/
232			public function setFetchMode($fetchMode, $arg2 = null, $arg3 = null)
233			{
234			$this->defaultFetchMode = $fetchMode;
235			$this->defaultFetchClass = $arg2 ?: $this->defaultFetchClass;
236			$this->defaultFetchClassCtorArgs = $arg3 ? (array) $arg3 : $this->defaultFetchClassCtorArgs;
237
238			return true;
239			}
240
241			/**
242			* {@inheritdoc}
243			*/
244			public function getIterator()
245			{
246			return new StatementIterator($this);
247			}
248
249			/**
250			* {@inheritdoc}
251			*/
252			public function fetch($fetchMode = null, $cursorOrientation = PDO::FETCH_ORI_NEXT, $cursorOffset = 0)
253			{
254			// do not try fetching from the statement if it's not expected to contain result
255			// in order to prevent exceptional situation
256			if (! $this->result) {
257			return false;
258			}
259
260			$fetchMode = $fetchMode ?: $this->defaultFetchMode;
261			switch ($fetchMode) {
262			case FetchMode::COLUMN:
263			return $this->fetchColumn();
264
265			case FetchMode::MIXED:
266			return db2_fetch_both($this->stmt);
267
268			case FetchMode::ASSOCIATIVE:
269			return db2_fetch_assoc($this->stmt);
270
271			case FetchMode::CUSTOM_OBJECT:
272			$className = $this->defaultFetchClass;
273			$ctorArgs = $this->defaultFetchClassCtorArgs;
274
275			if (func_num_args() >= 2) {
276			$args = func_get_args();
277			$className = $args[1];
278			$ctorArgs = $args[2] ?? [];
279			}
280
281			$result = db2_fetch_object($this->stmt);
282
283			if ($result instanceof stdClass) {
284			$result = $this->castObject($result, $className, $ctorArgs);
285			}
286
287			return $result;
288
289			case FetchMode::NUMERIC:
290			return db2_fetch_array($this->stmt);
291
292			case FetchMode::STANDARD_OBJECT:
293			return db2_fetch_object($this->stmt);
294
295			default:
296			throw new DB2Exception('Given Fetch-Style ' . $fetchMode . ' is not supported.');
297			}
298			}
299
300			/**
301			* {@inheritdoc}
302			*/
303			public function fetchAll($fetchMode = null, $fetchArgument = null, $ctorArgs = null)
304			{
305			$rows = [];
306
307			switch ($fetchMode) {
308			case FetchMode::CUSTOM_OBJECT:
309			while (($row = $this->fetch(...func_get_args())) !== false) {
310			$rows[] = $row;
311			}
312
313			break;
314
315			case FetchMode::COLUMN:
316			while (($row = $this->fetchColumn()) !== false) {
317			$rows[] = $row;
318			}
319
320			break;
321
322			default:
323			while (($row = $this->fetch($fetchMode)) !== false) {
324			$rows[] = $row;
325			}
326			}
327
328			return $rows;
329			}
330
331			/**
332			* {@inheritdoc}
333			*/
334			public function fetchColumn($columnIndex = 0)
335			{
336			$row = $this->fetch(FetchMode::NUMERIC);
337
338			if ($row === false) {
339			return false;
340			}
341
342			return $row[$columnIndex] ?? null;
343			}
344
345			/**
346			* {@inheritdoc}
347			*/
348			public function rowCount()
349			{
350			return @db2_num_rows($this->stmt) ? : 0;
351			}
352
353			/**
354			* Casts a stdClass object to the given class name mapping its' properties.
355			*
356			* @param stdClass $sourceObject Object to cast from.
357			* @param string\|object $destinationClass Name of the class or class instance to cast to.
358			* @param mixed[] $ctorArgs Arguments to use for constructing the destination class instance.
359			*
360			* @return object
361			*
362			* @throws DB2Exception
363			*/
364			private function castObject(stdClass $sourceObject, $destinationClass, array $ctorArgs = [])
365			{
366			if (! is_string($destinationClass)) {
367			if (! is_object($destinationClass)) {
368			throw new DB2Exception(sprintf(
369			'Destination class has to be of type string or object, %s given.',
370			gettype($destinationClass)
371			));
372			}
373			} else {
374			$destinationClass = new ReflectionClass($destinationClass);
375			$destinationClass = $destinationClass->newInstanceArgs($ctorArgs);
376			}
377
378			$sourceReflection = new ReflectionObject($sourceObject);
379			$destinationClassReflection = new ReflectionObject($destinationClass);
380			/** @var ReflectionProperty[] $destinationProperties */
381			$destinationProperties = array_change_key_case($destinationClassReflection->getProperties(), CASE_LOWER);
382
383			foreach ($sourceReflection->getProperties() as $sourceProperty) {
384			$sourceProperty->setAccessible(true);
385
386			$name = $sourceProperty->getName();
387			$value = $sourceProperty->getValue($sourceObject);
388
389			// Try to find a case-matching property.
390			if ($destinationClassReflection->hasProperty($name)) {
391			$destinationProperty = $destinationClassReflection->getProperty($name);
392
393			$destinationProperty->setAccessible(true);
394			$destinationProperty->setValue($destinationClass, $value);
395
396			continue;
397			}
398
399			$name = strtolower($name);
400
401			// Try to find a property without matching case.
402			// Fallback for the driver returning either all uppercase or all lowercase column names.
403			if (isset($destinationProperties[$name])) {
404			$destinationProperty = $destinationProperties[$name];
405
406			$destinationProperty->setAccessible(true);
407			$destinationProperty->setValue($destinationClass, $value);
408
409			continue;
410			}
411
412			$destinationClass->$name = $value;
413			}
414
415			return $destinationClass;
416			}
417
418			/**
419			* @return resource
420			*
421			* @throws DB2Exception
422			*/
423			private function createTemporaryFile()
424			{
425			$handle = @tmpfile();
426
427			if ($handle === false) {
428			throw new DB2Exception('Could not create temporary file: ' . error_get_last()['message']);
429			}
430
431			return $handle;
432			}
433
434			/**
435			* @param resource $source
436			* @param resource $target
437			*
438			* @throws DB2Exception
439			*/
440			private function copyStreamToStream($source, $target) : void
441			{
442			if (@stream_copy_to_stream($source, $target) === false) {
443			throw new DB2Exception('Could not copy source stream to temporary file: ' . error_get_last()['message']);
444			}
445			}
446
447			/**
448			* @param resource $target
449			*
450			* @throws DB2Exception
451			*/
452			private function writeStringToStream(string $string, $target) : void
453			{
454			if (@fwrite($target, $string) === false) {
455			throw new DB2Exception('Could not write string to temporary file: ' . error_get_last()['message']);
456			}
457			}
458			}
459

doctrine / dbal

Pull Request — 2.10.x (#3979)

DB2Statement::bindValue() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like