HasOneOrMany::populateEagerQueryFromFkList() - Code Metrics - Inspection of "add support for namespace + inflect from table for..." - bytic/orm - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 0ba58c...dd341e )

by Gabriel

created 2018-02-22 09:52 UTC

HasOneOrMany::populateEagerQueryFromFkList() A

↳ Parent: HasOneOrMany

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

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

<?php

namespace Nip\Records\Relations;

use Nip\Database\Query\Select as Query;
use Nip\HelperBroker;
use Nip\Records\AbstractModels\Record as Record;
use Nip\Records\Collections\Associated as AssociatedCollection;
use Nip\Records\Collections\Collection;
use Nip\Records\Collections\Collection as RecordCollection;
use Nip\Records\Relations\Traits\HasCollectionResults;

/**
 * Class HasOneOrMany
 * @package Nip\Records\Relations
 */
abstract class HasOneOrMany extends Relation
{
    use HasCollectionResults;

    /**
     * @var string
     */
    protected $type = 'hasMany';

    /**
     * @return bool
     */
    public function save()
    {
        if ($this->hasResults()) {
            $collection = $this->getResults();
            foreach ($collection as $item) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
                $this->saveResult($item);
            }
        }
        return true;
    }

    /**
     * @return bool
     */
    public function hasResults()
    {
        return $this->isPopulated() && count($this->getResults()) > 0;
    }

    /**
     * @param Record $item
     */
    public function saveResult(Record $item)
    {
        $pk = $this->getManager()->getPrimaryKey();
        $fk = $this->getFK();
        $item->{$fk} = $this->getItem()->{$pk};
        $item->saveRecord();
    }

    public function initResults()
    {
        $query = $this->getQuery();
        $items = $this->getWith()->findByQuery($query);
        $collection = $this->newCollection();
        $this->populateCollection($collection, $items);
        $this->setResults($collection);
    }

    /**
     * @param RecordCollection $collection
     * @param Collection $items
     */
    public function populateCollection(RecordCollection $collection, $items)
    {
        foreach ($items as $item) {
            $collection->add($item);
        }
    }

    /** @noinspection PhpMissingParentCallCommonInspection
     * @inheritdoc
     */
    public function populateEagerQueryFromFkList($query, $fkList)
    {
        $query->where($this->getFK() . ' IN ?', $fkList);
        return $query;
    }

    /** @noinspection PhpMissingParentCallCommonInspection
     * @param RecordCollection $collection
     * @return array
     */
    public function getEagerFkList(RecordCollection $collection)
    {
        if ($collection->isEmpty()) {
            return [];
        }
        $key = $collection->getManager()->getPrimaryKey();
        $return = HelperBroker::get('Arrays')->pluck($collection, $key);
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.
    }
}

        return array_unique($return);
    }

    /**
     * @param array $dictionary
     * @param Collection $collection
     * @param Record $record
     * @return AssociatedCollection
     */
    public function getResultsFromCollectionDictionary($dictionary, $collection, $record)
    {
        $fk = $record->getManager()->getPrimaryKey();
        $pk = $record->{$fk};
        $collection = $this->newCollection();

        if ($dictionary[$pk]) {
            foreach ($dictionary[$pk] as $record) {
                $collection->add($record);
            }
        }
        return $collection;
    }

    /**
     * Build model dictionary keyed by the relation's foreign key.
     *
     * @param RecordCollection $collection
     * @return array
     */
    protected function buildDictionary(RecordCollection $collection)
    {
        $dictionary = [];
        $pk = $this->getDictionaryKey();
        foreach ($collection as $record) {
            $dictionary[$record->{$pk}][] = $record;
        }
        return $dictionary;
    }

    /**
     * @return string
     */
    protected function getDictionaryKey()
    {
        return $this->getFK();
    }
}


1		<?php
2
3		namespace Nip\Records\Relations;
4
5		use Nip\Database\Query\Select as Query;
6		use Nip\HelperBroker;
7		use Nip\Records\AbstractModels\Record as Record;
8		use Nip\Records\Collections\Associated as AssociatedCollection;
9		use Nip\Records\Collections\Collection;
10		use Nip\Records\Collections\Collection as RecordCollection;
11		use Nip\Records\Relations\Traits\HasCollectionResults;
12
13		/**
14		* Class HasOneOrMany
15		* @package Nip\Records\Relations
16		*/
17		abstract class HasOneOrMany extends Relation
18		{
19		use HasCollectionResults;
20
21		/**
22		* @var string
23		*/
24		protected $type = 'hasMany';
25
26		/**
27		* @return bool
28		*/
29		public function save()
30		{
31		if ($this->hasResults()) {
32		$collection = $this->getResults();
33		foreach ($collection as $item) {
		0 ignored issues – show Bug introduced 2018-02-13 15:12 UTC by Report Bug Copy Issue Report The expression `$collection` of type `object<Nip\Records\Colle...ect<Nip\Records\Record>` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
34		$this->saveResult($item);
35		}
36		}
37		return true;
38		}
39
40		/**
41		* @return bool
42		*/
43		public function hasResults()
44		{
45		return $this->isPopulated() && count($this->getResults()) > 0;
46		}
47
48		/**
49		* @param Record $item
50		*/
51	1	public function saveResult(Record $item)
52		{
53	1	$pk = $this->getManager()->getPrimaryKey();
54	1	$fk = $this->getFK();
55	1	$item->{$fk} = $this->getItem()->{$pk};
56	1	$item->saveRecord();
57	1	}
58
59		public function initResults()
60		{
61		$query = $this->getQuery();
62		$items = $this->getWith()->findByQuery($query);
63		$collection = $this->newCollection();
64		$this->populateCollection($collection, $items);
65		$this->setResults($collection);
66		}
67
68		/**
69		* @param RecordCollection $collection
70		* @param Collection $items
71		*/
72		public function populateCollection(RecordCollection $collection, $items)
73		{
74		foreach ($items as $item) {
75		$collection->add($item);
76		}
77		}
78
79		/** @noinspection PhpMissingParentCallCommonInspection
80		* @inheritdoc
81		*/
82	1	public function populateEagerQueryFromFkList($query, $fkList)
83		{
84	1	$query->where($this->getFK() . ' IN ?', $fkList);
85	1	return $query;
86		}
87
88		/** @noinspection PhpMissingParentCallCommonInspection
89		* @param RecordCollection $collection
90		* @return array
91		*/
92	1	public function getEagerFkList(RecordCollection $collection)
93		{
94	1	if ($collection->isEmpty()) {
95	1	return [];
96		}
97	1	$key = $collection->getManager()->getPrimaryKey();
98	1	$return = HelperBroker::get('Arrays')->pluck($collection, $key);
		0 ignored issues – show Bug introduced 2018-02-22 10:00 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Nip\Helpers\AbstractHelper` as the method `pluck()` does only exist in the following sub-classes of `Nip\Helpers\AbstractHelper`: `Nip_Helper_Arrays`. 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...
99
100	1	return array_unique($return);
101		}
102
103		/**
104		* @param array $dictionary
105		* @param Collection $collection
106		* @param Record $record
107		* @return AssociatedCollection
108		*/
109		public function getResultsFromCollectionDictionary($dictionary, $collection, $record)
110		{
111		$fk = $record->getManager()->getPrimaryKey();
112		$pk = $record->{$fk};
113		$collection = $this->newCollection();
114
115		if ($dictionary[$pk]) {
116		foreach ($dictionary[$pk] as $record) {
117		$collection->add($record);
118		}
119		}
120		return $collection;
121		}
122
123		/**
124		* Build model dictionary keyed by the relation's foreign key.
125		*
126		* @param RecordCollection $collection
127		* @return array
128		*/
129		protected function buildDictionary(RecordCollection $collection)
130		{
131		$dictionary = [];
132		$pk = $this->getDictionaryKey();
133		foreach ($collection as $record) {
134		$dictionary[$record->{$pk}][] = $record;
135		}
136		return $dictionary;
137		}
138
139		/**
140		* @return string
141		*/
142		protected function getDictionaryKey()
143		{
144		return $this->getFK();
145		}
146		}
147

bytic / orm

Push — master ( 0ba58c...dd341e )

HasOneOrMany::populateEagerQueryFromFkList() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like