DoctrineDbalExecutorResult::getSingleScalarResultOrDefault() - Code Metrics - Inspection of "Fixed issue with DoctrineDbalExecutorResult::getSi..." - RunOpenCode/query-resources-loader-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 1dc55d...71bc2f )

by Nikola

created 2017-11-09 23:02 UTC

getSingleScalarResultOrDefault() A

↳ Parent: DoctrineDbalExecutorResult

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
dl	0
loc	8
ccs	4
cts	4
cp	1
rs	9.4285
c	1
b	0
f	0
cc	2
eloc	5
nc	2
nop	1
crap	2

<?php
/*
 * This file is part of the QueryResourcesLoaderBundle, an RunOpenCode project.
 *
 * (c) 2017 RunOpenCode.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace RunOpenCode\Bundle\QueryResourcesLoader\Executor;

use Doctrine\DBAL\Driver\Statement;
use RunOpenCode\Bundle\QueryResourcesLoader\Exception\NonUniqueResultException;
use RunOpenCode\Bundle\QueryResourcesLoader\Exception\NoResultException;

/**
 * Class DoctrineDbalExecutorResult
 *
 * Doctrine Dbal executor result statement wrapper that provides you with useful methods when fetching results from
 * SELECT statement.
 *
 * @package RunOpenCode\Bundle\QueryResourcesLoader\Executor
 */
final class DoctrineDbalExecutorResult implements \IteratorAggregate, Statement
{
    /**
     * @var Statement
     */
    private $statement;

    /**
     * DoctrineDbalExecutorResult constructor.
     *
     * @param Statement $statement Wrapped statement.
     */
    public function __construct(Statement $statement)
    {
        $this->statement = $statement;
    }

    /**
     * Get single scalar result.
     *
     * @return mixed A single scalar value.
     *
     * @throws NoResultException
     * @throws NonUniqueResultException
     */
    public function getSingleScalarResult()
    {
        $scalar = $this->statement->fetchColumn(0);

        if (false === $scalar) {
            throw new NoResultException('Expected on result for given query.');
        }

        if (false !== $this->statement->fetch()) {
            throw new NonUniqueResultException('Expected only one result for given query.');
        }

        return $scalar;
    }

    /**
     * Get single scalar result or default value if there are no results of executed
     * SELECT statement.
     *
     * @param mixed $default A default single scalar value.
     * @return mixed A single scalar value.
     */
    public function getSingleScalarResultOrDefault($default)
    {
        try {
            return $this->getSingleScalarResult();
        } catch (NoResultException $e) {
            return $default;
        }
    }

    /**
     * Get single scalar result or NULL value if there are no results of executed
     * SELECT statement.
     *
     * @return mixed|null A single scalar value.
     */
    public function getSingleScalarResultOrNull()
    {
        return $this->getSingleScalarResultOrDefault(null);
    }

    /**
     * Get collection of scalar values.
     *
     * @return array A collection of scalar values.
     */
    public function getScalarResult()
    {
        $result = [];

        while ($val = $this->statement->fetchColumn()) {
            $result[] = $val;
        }

        return $result;
    }

    /**
     * Get collection of scalar vales, or default value if collection is empty.
     *
     * @param mixed $default A default value.
     * @return array|mixed A collection of scalar values or default value.
     */
    public function getScalarResultOrDefault($default)
    {
        $result = $this->getScalarResult();

        if (0 === count($result)) {
            return $default;
        }

        return $result;
    }

    /**
     * Get collection of scalar vales, or NULL value if collection is empty.
     *
     * @return array|mixed A collection of NULL value.
     */
    public function getScalarResultOrNull()
    {
        return $this->getScalarResultOrDefault(null);
    }

    /**
     * Get single (first) row result from result set.
     *
     * @return array A single (first) row of result set.
     *
     * @throws NoResultException
     * @throws NonUniqueResultException
     */
    public function getSingleRowResult()
    {
        $row = $this->statement->fetch(\PDO::FETCH_BOTH);

        if (false === $row) {
            throw new NoResultException('Expected on result for given query.');
        }

        if (false !== $this->statement->fetch()) {
            throw new NonUniqueResultException('Expected only ine result for given query.');
        }

        return $row;
    }

    /**
     * Get single (first) row result from result set or default value if result set is empty.
     *
     * @param mixed $default Default value if result set is empty.
     * @return array|mixed A single (first) row of result set.
     *
     * @throws NoResultException
     * @throws NonUniqueResultException
     */
    public function getSingleRowOrDefault($default)
    {
        try {
            return $this->getSingleRowResult();
        } catch (NoResultException $e) {
            return $default;
        }
    }

    /**
     * Get single (first) row result from result set or NULL value if result set is empty.
     *
     * @return array A single (first) row of result set.
     *
     * @throws NoResultException
     * @throws NonUniqueResultException
     */
    public function getSingleRowOrNull()
    {
        return $this->getSingleRowOrDefault(null);
    }

    /**
     * {@inheritdoc}
     */
    public function closeCursor()
    {
        return $this->statement->closeCursor();
    }

    /**
     * {@inheritdoc}
     */
    public function columnCount()
    {
        return $this->statement->columnCount();
    }

    /**
     * {@inheritdoc}
     */
    public function setFetchMode($fetchMode, $arg2 = null, $arg3 = null)
    {
        return $this->statement->setFetchMode($fetchMode, $arg2, $arg3);
    }

    /**
     * {@inheritdoc}
     */
    public function fetch($fetchMode = null, $cursorOrientation = \PDO::FETCH_ORI_NEXT, $cursorOffset = 0)
    {
        return $this->statement->fetch($fetchMode, $cursorOrientation, $cursorOffset);
    }

    /**
     * {@inheritdoc}
     */
    public function fetchAll($fetchMode = null, $fetchArgument = null, $ctorArgs = null)
    {
        return $this->statement->fetchAll($fetchMode, $fetchArgument, $ctorArgs);
    }

    /**
     * {@inheritdoc}
     */
    public function fetchColumn($columnIndex = 0)
    {
        return $this->statement->fetchColumn($columnIndex);
    }

    /**
     * {@inheritdoc}
     */
    public function bindValue($param, $value, $type = null)
    {
        return $this->statement->bindValue($param, $value, $type);
    }

    /**
     * {@inheritdoc}
     */
    public function bindParam($column, &$variable, $type = null, $length = null)
    {
        return $this->statement->bindParam($column, $variable, $type, $length);
    }

    /**
     * {@inheritdoc}
     */
    public function errorCode()
    {
        return $this->statement->errorCode();
    }

    /**
     * {@inheritdoc}
     */
    public function errorInfo()
    {
        return $this->statement->errorInfo();
    }

    /**
     * {@inheritdoc}
     */
    public function execute($params = null)
    {
        return $this->statement->execute($params);
    }

    /**
     * {@inheritdoc}
     */
    public function rowCount()
    {
        return $this->statement->rowCount();
    }

    /**
     * {@inheritdoc}
     */
    public function __get($name)
    {
        return $this->statement->{$name};
    }

    /**
     * {@inheritdoc}
     */
    public function __set($name, $value)
    {
        $this->statement->{$name} = $value;
    }

    /**
     * {@inheritdoc}
     */
    public function __isset($name)
    {
        return isset($this->statement[$name]);
    }

    /**
     * {@inheritdoc}
     */
    public function __call($name, $arguments)
    {
        return call_user_func_array(array($this->statement, $name), $arguments);
    }

    /**
     * {@inheritdoc}
     */
    public function getIterator()
    {
        while (false !== ($row = $this->statement->fetch(\PDO::FETCH_BOTH))) {
            yield $row;
        }
    }
}


1		<?php
2		/*
3		* This file is part of the QueryResourcesLoaderBundle, an RunOpenCode project.
4		*
5		* (c) 2017 RunOpenCode.
6		*
7		* For the full copyright and license information, please view the LICENSE
8		* file that was distributed with this source code.
9		*/
10		namespace RunOpenCode\Bundle\QueryResourcesLoader\Executor;
11
12		use Doctrine\DBAL\Driver\Statement;
13		use RunOpenCode\Bundle\QueryResourcesLoader\Exception\NonUniqueResultException;
14		use RunOpenCode\Bundle\QueryResourcesLoader\Exception\NoResultException;
15
16		/**
17		* Class DoctrineDbalExecutorResult
18		*
19		* Doctrine Dbal executor result statement wrapper that provides you with useful methods when fetching results from
20		* SELECT statement.
21		*
22		* @package RunOpenCode\Bundle\QueryResourcesLoader\Executor
23		*/
24		final class DoctrineDbalExecutorResult implements \IteratorAggregate, Statement
25		{
26		/**
27		* @var Statement
28		*/
29		private $statement;
30
31		/**
32		* DoctrineDbalExecutorResult constructor.
33		*
34		* @param Statement $statement Wrapped statement.
35		*/
36	15	public function __construct(Statement $statement)
37		{
38	15	$this->statement = $statement;
39	15	}
40
41		/**
42		* Get single scalar result.
43		*
44		* @return mixed A single scalar value.
45		*
46		* @throws NoResultException
47		* @throws NonUniqueResultException
48		*/
49	5	public function getSingleScalarResult()
50		{
51	5	$scalar = $this->statement->fetchColumn(0);
52
53	5	if (false === $scalar) {
54	3	throw new NoResultException('Expected on result for given query.');
55		}
56
57	2	if (false !== $this->statement->fetch()) {
58	1	throw new NonUniqueResultException('Expected only one result for given query.');
59		}
60
61	1	return $scalar;
62		}
63
64		/**
65		* Get single scalar result or default value if there are no results of executed
66		* SELECT statement.
67		*
68		* @param mixed $default A default single scalar value.
69		* @return mixed A single scalar value.
70		*/
71	2	public function getSingleScalarResultOrDefault($default)
72		{
73		try {
74	2	return $this->getSingleScalarResult();
75	2	} catch (NoResultException $e) {
76	2	return $default;
77		}
78		}
79
80		/**
81		* Get single scalar result or NULL value if there are no results of executed
82		* SELECT statement.
83		*
84		* @return mixed\|null A single scalar value.
85		*/
86	1	public function getSingleScalarResultOrNull()
87		{
88	1	return $this->getSingleScalarResultOrDefault(null);
89		}
90
91		/**
92		* Get collection of scalar values.
93		*
94		* @return array A collection of scalar values.
95		*/
96	3	public function getScalarResult()
97		{
98	3	$result = [];
99
100	3	while ($val = $this->statement->fetchColumn()) {
101	1	$result[] = $val;
102		}
103
104	3	return $result;
105		}
106
107		/**
108		* Get collection of scalar vales, or default value if collection is empty.
109		*
110		* @param mixed $default A default value.
111		* @return array\|mixed A collection of scalar values or default value.
112		*/
113	2	public function getScalarResultOrDefault($default)
114		{
115	2	$result = $this->getScalarResult();
116
117	2	if (0 === count($result)) {
118	2	return $default;
119		}
120
121		return $result;
122		}
123
124		/**
125		* Get collection of scalar vales, or NULL value if collection is empty.
126		*
127		* @return array\|mixed A collection of NULL value.
128		*/
129	1	public function getScalarResultOrNull()
130		{
131	1	return $this->getScalarResultOrDefault(null);
132		}
133
134		/**
135		* Get single (first) row result from result set.
136		*
137		* @return array A single (first) row of result set.
138		*
139		* @throws NoResultException
140		* @throws NonUniqueResultException
141		*/
142	5	public function getSingleRowResult()
143		{
144	5	$row = $this->statement->fetch(\PDO::FETCH_BOTH);
145
146	5	if (false === $row) {
147	3	throw new NoResultException('Expected on result for given query.');
148		}
149
150	2	if (false !== $this->statement->fetch()) {
151	1	throw new NonUniqueResultException('Expected only ine result for given query.');
152		}
153
154	1	return $row;
155		}
156
157		/**
158		* Get single (first) row result from result set or default value if result set is empty.
159		*
160		* @param mixed $default Default value if result set is empty.
161		* @return array\|mixed A single (first) row of result set.
162		*
163		* @throws NoResultException
164		* @throws NonUniqueResultException
165		*/
166	2	public function getSingleRowOrDefault($default)
167		{
168		try {
169	2	return $this->getSingleRowResult();
170	2	} catch (NoResultException $e) {
171	2	return $default;
172		}
173		}
174
175		/**
176		* Get single (first) row result from result set or NULL value if result set is empty.
177		*
178		* @return array A single (first) row of result set.
179		*
180		* @throws NoResultException
181		* @throws NonUniqueResultException
182		*/
183	1	public function getSingleRowOrNull()
184		{
185	1	return $this->getSingleRowOrDefault(null);
186		}
187
188		/**
189		* {@inheritdoc}
190		*/
191		public function closeCursor()
192		{
193		return $this->statement->closeCursor();
194		}
195
196		/**
197		* {@inheritdoc}
198		*/
199		public function columnCount()
200		{
201		return $this->statement->columnCount();
202		}
203
204		/**
205		* {@inheritdoc}
206		*/
207		public function setFetchMode($fetchMode, $arg2 = null, $arg3 = null)
208		{
209		return $this->statement->setFetchMode($fetchMode, $arg2, $arg3);
210		}
211
212		/**
213		* {@inheritdoc}
214		*/
215		public function fetch($fetchMode = null, $cursorOrientation = \PDO::FETCH_ORI_NEXT, $cursorOffset = 0)
216		{
217		return $this->statement->fetch($fetchMode, $cursorOrientation, $cursorOffset);
218		}
219
220		/**
221		* {@inheritdoc}
222		*/
223		public function fetchAll($fetchMode = null, $fetchArgument = null, $ctorArgs = null)
224		{
225		return $this->statement->fetchAll($fetchMode, $fetchArgument, $ctorArgs);
226		}
227
228		/**
229		* {@inheritdoc}
230		*/
231		public function fetchColumn($columnIndex = 0)
232		{
233		return $this->statement->fetchColumn($columnIndex);
234		}
235
236		/**
237		* {@inheritdoc}
238		*/
239		public function bindValue($param, $value, $type = null)
240		{
241		return $this->statement->bindValue($param, $value, $type);
242		}
243
244		/**
245		* {@inheritdoc}
246		*/
247		public function bindParam($column, &$variable, $type = null, $length = null)
248		{
249		return $this->statement->bindParam($column, $variable, $type, $length);
250		}
251
252		/**
253		* {@inheritdoc}
254		*/
255		public function errorCode()
256		{
257		return $this->statement->errorCode();
258		}
259
260		/**
261		* {@inheritdoc}
262		*/
263		public function errorInfo()
264		{
265		return $this->statement->errorInfo();
266		}
267
268		/**
269		* {@inheritdoc}
270		*/
271		public function execute($params = null)
272		{
273		return $this->statement->execute($params);
274		}
275
276		/**
277		* {@inheritdoc}
278		*/
279		public function rowCount()
280		{
281		return $this->statement->rowCount();
282		}
283
284		/**
285		* {@inheritdoc}
286		*/
287		public function __get($name)
288		{
289		return $this->statement->{$name};
290		}
291
292		/**
293		* {@inheritdoc}
294		*/
295		public function __set($name, $value)
296		{
297		$this->statement->{$name} = $value;
298		}
299
300		/**
301		* {@inheritdoc}
302		*/
303		public function __isset($name)
304		{
305		return isset($this->statement[$name]);
306		}
307
308		/**
309		* {@inheritdoc}
310		*/
311		public function __call($name, $arguments)
312		{
313		return call_user_func_array(array($this->statement, $name), $arguments);
314		}
315
316		/**
317		* {@inheritdoc}
318		*/
319		public function getIterator()
320		{
321		while (false !== ($row = $this->statement->fetch(\PDO::FETCH_BOTH))) {
322		yield $row;
323		}
324		}
325		}
326

RunOpenCode / query-resources-loader-bundle

Push — master ( 1dc55d...71bc2f )

getSingleScalarResultOrDefault() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like