Query::first() - Code Metrics - Inspection of "Add deprecated method to make CMS tests work" - sminnee/silverstripe-framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — generators ( 866370...5c61bd )

by Sam

created 2017-06-28 23:49 UTC

Query::first() A

↳ Parent: Query

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	0
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php

namespace SilverStripe\ORM\Connect;

use SilverStripe\Core\Convert;
use Iterator;

/**
 * Abstract query-result class.
 * Once again, this should be subclassed by an actual database implementation.  It will only
 * ever be constructed by a subclass of SS_Database.  The result of a database query - an iteratable object
 * that's returned by DB::SS_Query
 *
 * Primarily, the SS_Query class takes care of the iterator plumbing, letting the subclasses focusing
 * on providing the specific data-access methods that are required: {@link nextRecord()}, {@link numRecords()}
 * and {@link seek()}
 */
abstract class Query implements \IteratorAggregate
{

    /**
     * Return an array containing all the values from a specific column. If no column is set, then the first will be
     * returned
     *
     * @param string $column
     * @return array
     */
    public function column($column = null)
    {
        $result = [];

        foreach ($this as $record) {
            if ($column) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
                $result[] = $record[$column];
            } else {
                $result[] = $record[key($record)];
            }
        }

        return $result;
    }

    /**
     * Return an array containing all values in the leftmost column, where the keys are the
     * same as the values.
     *
     * @return array
     */
    public function keyedColumn()

    {
        $column = [];

        foreach ($this as $record) {
            $val = $record[key($record)];
            $column[$val] = $val;
        }
        return $column;
    }

    /**
     * Return a map from the first column to the second column.
     *
     * @return array
     */
    public function map()

    {
        $column = array();
        foreach ($this as $record) {
            $key = reset($record);
            $val = next($record);
            $column[$key] = $val;
        }
        return $column;
    }

    /**
     * Returns the first record in the result
     *
     * @return array
     */
    public function record()
    {
        return $this->getIterator()->current();

    }

    /**
     * @deprecated Use record() instead
     * @return array
     */
    public function first()
    {
        return $this->record();
    }

    /**
     * Returns the first column of the first record.
     *
     * @return string
     */
    public function value()
    {
        $record = $this->record();
        if ($record) {

            return $record[key($record)];
        }
        return null;
    }

    /**
     * Return an HTML table containing the full result-set
     *
     * @return string
     */
    public function table()
    {
        $first = true;
        $result = "<table>\n";

        foreach ($this as $record) {
            if ($first) {
                $result .= "<tr>";
                foreach ($record as $k => $v) {
                    $result .= "<th>" . Convert::raw2xml($k) . "</th> ";
                }
                $result .= "</tr> \n";
            }

            $result .= "<tr>";
            foreach ($record as $k => $v) {
                $result .= "<td>" . Convert::raw2xml($v) . "</td> ";
            }
            $result .= "</tr> \n";

            $first = false;
        }
        $result .= "</table>\n";

        if ($first) {
            return "No records found";
        }
        return $result;
    }

    /**
     * Return the next record in the query result.
     *
     * @return array
     */
    abstract public function getIterator();

    /**
     * Return the total number of items in the query result.
     *
     * @return int
     */
    abstract public function numRecords();
}


1		<?php
2
3		namespace SilverStripe\ORM\Connect;
4
5		use SilverStripe\Core\Convert;
6		use Iterator;
7
8		/**
9		* Abstract query-result class.
10		* Once again, this should be subclassed by an actual database implementation. It will only
11		* ever be constructed by a subclass of SS_Database. The result of a database query - an iteratable object
12		* that's returned by DB::SS_Query
13		*
14		* Primarily, the SS_Query class takes care of the iterator plumbing, letting the subclasses focusing
15		* on providing the specific data-access methods that are required: {@link nextRecord()}, {@link numRecords()}
16		* and {@link seek()}
17		*/
18		abstract class Query implements \IteratorAggregate
19		{
20
21		/**
22		* Return an array containing all the values from a specific column. If no column is set, then the first will be
23		* returned
24		*
25		* @param string $column
26		* @return array
27		*/
28		public function column($column = null)
29		{
30		$result = [];
31
32		foreach ($this as $record) {
33		if ($column) {
		0 ignored issues – show Bug Best Practice introduced 2016-07-11 00:17 UTC by Report Bug Copy Issue Report The expression `$column` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
34		$result[] = $record[$column];
35		} else {
36		$result[] = $record[key($record)];
37		}
38		}
39
40		return $result;
41		}
42
43		/**
44		* Return an array containing all values in the leftmost column, where the keys are the
45		* same as the values.
46		*
47		* @return array
48		*/
49	View Code Duplication	public function keyedColumn()
		0 ignored issues – show Duplication introduced 2016-07-11 00:17 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
50		{
51		$column = [];
52
53		foreach ($this as $record) {
54		$val = $record[key($record)];
55		$column[$val] = $val;
56		}
57		return $column;
58		}
59
60		/**
61		* Return a map from the first column to the second column.
62		*
63		* @return array
64		*/
65	View Code Duplication	public function map()
		0 ignored issues – show Duplication introduced 2016-07-11 00:17 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
66		{
67		$column = array();
68		foreach ($this as $record) {
69		$key = reset($record);
70		$val = next($record);
71		$column[$key] = $val;
72		}
73		return $column;
74		}
75
76		/**
77		* Returns the first record in the result
78		*
79		* @return array
80		*/
81		public function record()
82		{
83		return $this->getIterator()->current();
		0 ignored issues – show Bug introduced 2017-01-17 02:29 UTC by Report Bug Copy Issue Report The method `current` cannot be called on `$this->getIterator()` (of type `array`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
84		}
85
86		/**
87		* @deprecated Use record() instead
88		* @return array
89		*/
90		public function first()
91		{
92		return $this->record();
93		}
94
95		/**
96		* Returns the first column of the first record.
97		*
98		* @return string
99		*/
100		public function value()
101		{
102		$record = $this->record();
103		if ($record) {
		0 ignored issues – show Bug Best Practice introduced 2016-09-09 23:25 UTC by Report Bug Copy Issue Report The expression `$record` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
104		return $record[key($record)];
105		}
106		return null;
107		}
108
109		/**
110		* Return an HTML table containing the full result-set
111		*
112		* @return string
113		*/
114		public function table()
115		{
116		$first = true;
117		$result = "<table>\n";
118
119		foreach ($this as $record) {
120		if ($first) {
121		$result .= "<tr>";
122		foreach ($record as $k => $v) {
123		$result .= "<th>" . Convert::raw2xml($k) . "</th> ";
124		}
125		$result .= "</tr> \n";
126		}
127
128		$result .= "<tr>";
129		foreach ($record as $k => $v) {
130		$result .= "<td>" . Convert::raw2xml($v) . "</td> ";
131		}
132		$result .= "</tr> \n";
133
134		$first = false;
135		}
136		$result .= "</table>\n";
137
138		if ($first) {
139		return "No records found";
140		}
141		return $result;
142		}
143
144		/**
145		* Return the next record in the query result.
146		*
147		* @return array
148		*/
149		abstract public function getIterator();
150
151		/**
152		* Return the total number of items in the query result.
153		*
154		* @return int
155		*/
156		abstract public function numRecords();
157		}
158

sminnee / silverstripe-framework

Push — generators ( 866370...5c61bd )

Query::first() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like