ResultSet::getTotalRows() - Code Metrics - Inspection of "Fix bug for simplexmlwriter, close #4" - belgattitude/soluble-flexstore - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c82e60...68cb49 )

by Sébastien

created 2016-02-27 22:29 UTC

ResultSet::getTotalRows() A

↳ Parent: ResultSet

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

<?php

namespace Soluble\FlexStore\ResultSet;

use Soluble\FlexStore\Source\AbstractSource;
use Soluble\FlexStore\Helper\Paginator;
use Soluble\FlexStore\Options\HydrationOptions;
use Soluble\FlexStore\Column\ColumnModel;
use ArrayObject;

class ResultSet extends AbstractResultSet
{
    /**
     *
     * @var Paginator
     */
    protected $paginator;

    /**
     *
     * @var integer
     */
    protected $totalRows;

    /**
     * @var AbstractSource
     */
    protected $source;

    /**
     *
     * @var HydrationOptions
     */
    protected $hydrationOptions;

    /**
     *
     * @var boolean
     */
    protected $hydrate_options_initialized = false;

    /**
     * @var ArrayObject
     */
    protected $hydration_formatters;

    /**
     * @var ArrayObject
     */
    protected $hydration_renderers;

    /**
     * @var ArrayObject|null
     */
    protected $hydrated_columns;



    /**
     * Return source column model
     *
     * @throws Exception\RuntimeException
     * @return ColumnModel
     */
    public function getColumnModel()
    {
        if ($this->source === null) {
            throw new Exception\RuntimeException(__METHOD__ . " Prior to get column model, a source must be set.");
        }
        $this->hydrate_options_initialized = false;
        return $this->source->getColumnModel();
    }

    /**
     *
     * @param AbstractSource $source
     * @return ResultSet
     */
    public function setSource(AbstractSource $source)
    {
        $this->source = $source;
        return $this;
    }

    /**
     *
     * @return AbstractSource
     */
    public function getSource()
    {
        return $this->source;
    }

    /**
     *
     * @param HydrationOptions $hydrationOptions
     * @return ResultSet
     */
    public function setHydrationOptions(HydrationOptions $hydrationOptions)
    {
        $this->hydrationOptions = $hydrationOptions;
        return $this;
    }

    /**
     *
     * @return HydrationOptions
     */
    public function getHydrationOptions()
    {
        return $this->hydrationOptions;
    }


    /**
     *
     * @return Paginator
     */
    public function getPaginator()
    {
        if ($this->paginator === null) {
            $this->paginator = new Paginator(
                $this->getTotalRows(),
                $this->getSource()->getOptions()->getLimit(),
                $this->getSource()->getOptions()->getOffset()
            );
        }
        return $this->paginator;
    }

    /**
     * Set the total rows
     * @param int $totalRows
     * @return ResultSet
     */
    public function setTotalRows($totalRows)
    {
        $this->totalRows = (int) $totalRows;
        return $this;
    }

    /**
     * @return int
     */
    public function getTotalRows()
    {
        return $this->totalRows;
    }

    /**
     *
     * @param ArrayObject|array $row
     * @return null
     */
//protected function initColumnModelHydration(ArrayObject $row)    
    protected function initColumnModelHydration(&$row)
    {
        $this->hydration_formatters = new ArrayObject();
        $this->hydration_renderers = new ArrayObject();
        $this->hydrated_columns = null;

        if ($this->source->hasColumnModel()) {
            $cm = $this->getColumnModel();

            // 1. Initialize columns hydrators
            if ($this->getHydrationOptions()->isFormattersEnabled()) {
                $formatters = $cm->getUniqueFormatters();
                if ($formatters->count() > 0) {
                    $this->hydration_formatters = $formatters;
                }
            }

            // 2. Initialize hydrated columns

            if ($this->getHydrationOptions()->isColumnExclusionEnabled()) {
                $columns = $cm->getColumns();

                // Performance:
                // Only if column model definition differs from originating
                // source row definition.
                $hydrated_columns = array_keys((array) $columns);
                $row_columns = array_keys((array) $row);
                if ($hydrated_columns != $row_columns) {
                    $this->hydrated_columns = new ArrayObject($hydrated_columns);
                }
            }

            // 3. Initialize row renderers
            if ($this->getHydrationOptions()->isRenderersEnabled()) {
                $this->hydration_renderers = $cm->getRowRenderers();
            }
        }
        $this->hydrate_options_initialized = true;
    }

    /**
     * Return the current row as an array|ArrayObject.
     * If setLimitColumns() have been set, will only return
     * the limited columns.
     *
     * @throws Exception\UnknownColumnException
     * @return array|ArrayObject|null
     */
    public function current()
    {
        $row = $this->zfResultSet->current();
        if ($row === null) {
            return;
        }

        if (!$this->hydrate_options_initialized) {
            $this->initColumnModelHydration($row);
        }


        // 1. Row renderers
        foreach ($this->hydration_renderers as $renderer) {
            $renderer->apply($row);
        }

        // 2. Formatters
        foreach ($this->hydration_formatters as $formatters) {
            foreach ($formatters['columns'] as $column) {
                $row[$column] = $formatters['formatter']->format($row[$column], $row);
            }
        }

        // 3. Process column hydration
        if ($this->hydrated_columns !== null) {
            $d = new ArrayObject();
            foreach ($this->hydrated_columns as $column) {
                $d->offsetSet($column, isset($row[$column]) ? $row[$column] : null);
            }
            $row->exchangeArray($d);
        }

        if ($this->returnType === self::TYPE_ARRAY) {
            return (array) $row;
        }
        return $row;
    }

    /**
     * Cast result set to array of arrays
     *
     * @return array
     * @throws Exception\RuntimeException if any row is not castable to an array
     */
    public function toArray()
    {
        $return = [];
        foreach ($this as $row) {
            if (is_array($row)) {
                $return[] = $row;
            } elseif (method_exists($row, 'toArray')) {
                $return[] = $row->toArray();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            } elseif (method_exists($row, 'getArrayCopy')) {
                $return[] = $row->getArrayCopy();
            } else {
                throw new Exception\RuntimeException(
                    __METHOD__ . ': Rows as part of this DataSource, with type ' . gettype($row) . ' cannot be cast to an array'
                );
            }
        }
        return $return;
    }

    /**
     * Iterator: is pointer valid?
     *
     * @return bool
     */
    public function valid()
    {
        $valid =  $this->zfResultSet->valid();
        if (!$valid) {
            $this->hydrate_options_initialized = false;
        }
        return $valid;
    }

    /**
     * Iterator: rewind
     *
     * @return void
     */
    public function rewind()
    {
        $this->hydrate_options_initialized = false;
        $this->zfResultSet->rewind();
    }
}


1		<?php
2
3		namespace Soluble\FlexStore\ResultSet;
4
5		use Soluble\FlexStore\Source\AbstractSource;
6		use Soluble\FlexStore\Helper\Paginator;
7		use Soluble\FlexStore\Options\HydrationOptions;
8		use Soluble\FlexStore\Column\ColumnModel;
9		use ArrayObject;
10
11		class ResultSet extends AbstractResultSet
12		{
13		/**
14		*
15		* @var Paginator
16		*/
17		protected $paginator;
18
19		/**
20		*
21		* @var integer
22		*/
23		protected $totalRows;
24
25		/**
26		* @var AbstractSource
27		*/
28		protected $source;
29
30		/**
31		*
32		* @var HydrationOptions
33		*/
34		protected $hydrationOptions;
35
36		/**
37		*
38		* @var boolean
39		*/
40		protected $hydrate_options_initialized = false;
41
42		/**
43		* @var ArrayObject
44		*/
45		protected $hydration_formatters;
46
47		/**
48		* @var ArrayObject
49		*/
50		protected $hydration_renderers;
51
52		/**
53		* @var ArrayObject\|null
54		*/
55		protected $hydrated_columns;
56
57
58
59		/**
60		* Return source column model
61		*
62		* @throws Exception\RuntimeException
63		* @return ColumnModel
64		*/
65	10	public function getColumnModel()
66		{
67	10	if ($this->source === null) {
68	1	throw new Exception\RuntimeException(__METHOD__ . " Prior to get column model, a source must be set.");
69		}
70	9	$this->hydrate_options_initialized = false;
71	9	return $this->source->getColumnModel();
72		}
73
74		/**
75		*
76		* @param AbstractSource $source
77		* @return ResultSet
78		*/
79	39	public function setSource(AbstractSource $source)
80		{
81	39	$this->source = $source;
82	39	return $this;
83		}
84
85		/**
86		*
87		* @return AbstractSource
88		*/
89	9	public function getSource()
90		{
91	9	return $this->source;
92		}
93
94		/**
95		*
96		* @param HydrationOptions $hydrationOptions
97		* @return ResultSet
98		*/
99	39	public function setHydrationOptions(HydrationOptions $hydrationOptions)
100		{
101	39	$this->hydrationOptions = $hydrationOptions;
102	39	return $this;
103		}
104
105		/**
106		*
107		* @return HydrationOptions
108		*/
109	9	public function getHydrationOptions()
110	9	{
111	9	return $this->hydrationOptions;
112		}
113
114
115		/**
116		*
117		* @return Paginator
118		*/
119	2	public function getPaginator()
120		{
121	2	if ($this->paginator === null) {
122	2	$this->paginator = new Paginator(
123	2	$this->getTotalRows(),
124	2	$this->getSource()->getOptions()->getLimit(),
125	2	$this->getSource()->getOptions()->getOffset()
126	2	);
127	1	}
128	1	return $this->paginator;
129		}
130
131		/**
132		* Set the total rows
133		* @param int $totalRows
134		* @return ResultSet
135		*/
136	39	public function setTotalRows($totalRows)
137		{
138	39	$this->totalRows = (int) $totalRows;
139	39	return $this;
140		}
141
142		/**
143		* @return int
144		*/
145	13	public function getTotalRows()
146		{
147	13	return $this->totalRows;
148		}
149
150		/**
151		*
152		* @param ArrayObject\|array $row
153		* @return null
154		*/
155		//protected function initColumnModelHydration(ArrayObject $row)
156	26	protected function initColumnModelHydration(&$row)
157		{
158	26	$this->hydration_formatters = new ArrayObject();
159	26	$this->hydration_renderers = new ArrayObject();
160	26	$this->hydrated_columns = null;
161
162	26	if ($this->source->hasColumnModel()) {
163	9	$cm = $this->getColumnModel();
164
165		// 1. Initialize columns hydrators
166	9	if ($this->getHydrationOptions()->isFormattersEnabled()) {
167	9	$formatters = $cm->getUniqueFormatters();
168	9	if ($formatters->count() > 0) {
169	2	$this->hydration_formatters = $formatters;
170	2	}
171	9	}
172
173		// 2. Initialize hydrated columns
174
175	9	if ($this->getHydrationOptions()->isColumnExclusionEnabled()) {
176	9	$columns = $cm->getColumns();
177
178		// Performance:
179		// Only if column model definition differs from originating
180		// source row definition.
181	9	$hydrated_columns = array_keys((array) $columns);
182	9	$row_columns = array_keys((array) $row);
183	9	if ($hydrated_columns != $row_columns) {
184	5	$this->hydrated_columns = new ArrayObject($hydrated_columns);
185	5	}
186	9	}
187
188		// 3. Initialize row renderers
189	9	if ($this->getHydrationOptions()->isRenderersEnabled()) {
190	9	$this->hydration_renderers = $cm->getRowRenderers();
191	9	}
192	9	}
193	26	$this->hydrate_options_initialized = true;
194	26	}
195
196		/**
197		* Return the current row as an array\|ArrayObject.
198		* If setLimitColumns() have been set, will only return
199		* the limited columns.
200		*
201		* @throws Exception\UnknownColumnException
202		* @return array\|ArrayObject\|null
203		*/
204	26	public function current()
205		{
206	26	$row = $this->zfResultSet->current();
207	26	if ($row === null) {
208		return;
209		}
210
211	26	if (!$this->hydrate_options_initialized) {
212	26	$this->initColumnModelHydration($row);
213	26	}
214
215
216		// 1. Row renderers
217	26	foreach ($this->hydration_renderers as $renderer) {
218	5	$renderer->apply($row);
219	25	}
220
221		// 2. Formatters
222	25	foreach ($this->hydration_formatters as $formatters) {
223	2	foreach ($formatters['columns'] as $column) {
224	2	$row[$column] = $formatters['formatter']->format($row[$column], $row);
225	2	}
226	25	}
227
228		// 3. Process column hydration
229	25	if ($this->hydrated_columns !== null) {
230	4	$d = new ArrayObject();
231	4	foreach ($this->hydrated_columns as $column) {
232	4	$d->offsetSet($column, isset($row[$column]) ? $row[$column] : null);
233	4	}
234	4	$row->exchangeArray($d);
235	4	}
236
237	25	if ($this->returnType === self::TYPE_ARRAY) {
238		return (array) $row;
239		}
240	25	return $row;
241		}
242
243		/**
244		* Cast result set to array of arrays
245		*
246		* @return array
247		* @throws Exception\RuntimeException if any row is not castable to an array
248		*/
249	25	public function toArray()
250		{
251	25	$return = [];
252	25	foreach ($this as $row) {
253	23	if (is_array($row)) {
254	1	$return[] = $row;
255	23	} elseif (method_exists($row, 'toArray')) {
256		$return[] = $row->toArray();
		0 ignored issues – show Bug introduced 2016-01-12 16:33 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `ArrayObject` as the method `toArray()` does only exist in the following sub-classes of `ArrayObject`: `Zend\Stdlib\Parameters`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
257	22	} elseif (method_exists($row, 'getArrayCopy')) {
258	22	$return[] = $row->getArrayCopy();
259	22	} else {
260		throw new Exception\RuntimeException(
261		__METHOD__ . ': Rows as part of this DataSource, with type ' . gettype($row) . ' cannot be cast to an array'
262		);
263		}
264	24	}
265	24	return $return;
266		}
267
268		/**
269		* Iterator: is pointer valid?
270		*
271		* @return bool
272		*/
273	25	public function valid()
274		{
275	25	$valid = $this->zfResultSet->valid();
276	25	if (!$valid) {
277	24	$this->hydrate_options_initialized = false;
278	24	}
279	25	return $valid;
280		}
281
282		/**
283		* Iterator: rewind
284		*
285		* @return void
286		*/
287	25	public function rewind()
288		{
289	25	$this->hydrate_options_initialized = false;
290	25	$this->zfResultSet->rewind();
291	25	}
292		}
293

belgattitude / soluble-flexstore

Push — master ( c82e60...68cb49 )

ResultSet::getTotalRows() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like