Completed
Push — dev ( be8d0d...249ddf )
by James Ekow Abaka
01:51
created

ManyHaveManyRelationship   A

Complexity

Total Complexity 14

Size/Duplication

Total Lines 91
Duplicated Lines 9.89 %

Coupling/Cohesion

Components 1
Dependencies 4

Test Coverage

Coverage 58.18%

Importance

Changes 0
Metric Value
wmc 14
lcom 1
cbo 4
dl 9
loc 91
ccs 32
cts 55
cp 0.5818
rs 10
c 0
b 0
f 0

4 Methods

Rating   Name   Duplication   Size   Complexity  
B runSetup() 9 27 6
A preSave() 0 10 1
A prepareQuery() 0 28 4
A postSave() 0 16 3

How to fix   Duplicated Code   

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

1
<?php
2
3
/*
4
 * The MIT License
5
 *
6
 * Copyright 2014-2018 James Ekow Abaka Ainooson
7
 *
8
 * Permission is hereby granted, free of charge, to any person obtaining a copy
9
 * of this software and associated documentation files (the "Software"), to deal
10
 * in the Software without restriction, including without limitation the rights
11
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12
 * copies of the Software, and to permit persons to whom the Software is
13
 * furnished to do so, subject to the following conditions:
14
 *
15
 * The above copyright notice and this permission notice shall be included in
16
 * all copies or substantial portions of the Software.
17
 *
18
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24
 * THE SOFTWARE.
25
 */
26
27
namespace ntentan\nibii\relationships;
28
29
use ntentan\nibii\NibiiException;
30
use ntentan\nibii\ORMContext;
31
use ntentan\nibii\Relationship;
32
use ntentan\utils\Text;
33
34
class ManyHaveManyRelationship extends Relationship
35
{
36
    protected $type = self::MANY_HAVE_MANY;
37
    private $tempdata;
38
    private $junctionModelInstance;
39
40 4
    public function prepareQuery($data)
0 ignored issues
show
Documentation introduced by
The return type could not be reliably inferred; please add a @return annotation.

Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a @return annotation as described here.

Loading history...
41
    {
42 4
        $junctionModelClass = $this->options['junction_model'];
43 4
        $junctionModel = new $junctionModelClass();
44 4
        $filter = $junctionModel->fields($this->options['junction_foreign_key'])
45 4
                ->filterBy($this->options['junction_local_key'], $data[$this->options['local_key']])
46 4
                ->fetch();
47 4
        if ($filter->count() == 0) {
48
            return;
49
        }
50 4
        $foreignKeys = [];
51 4
        foreach ($filter->toArray() as $foreignItem) {
52 4
            $foreignKeys[] = $foreignItem[$this->options['junction_foreign_key']];
53
        }
54
55
        // @todo throw an exception when the data doesn't have the local key
56 4
        $query = $this->getQuery();
57 4
        if ($this->queryPrepared) {
58
            $query->setBoundData($this->options['foreign_key'], $foreignKeys);
59
        } else {
60 4
            $query = $this->getQuery()
61 4
                    ->setTable($this->getModelInstance()->getDBStoreInformation()['quoted_table'])
62 4
                    ->addFilter($this->options['foreign_key'], $foreignKeys);
63 4
            $this->queryPrepared = true;
64
        }
65
66 4
        return $query;
67
    }
68
69 4
    public function runSetup()
70
    {
71 4
        $context = ORMContext::getInstance();
72 4
        if (isset($this->options['through'])) {
73
            $junctionModelName = $context->getModelFactory()->getClassName($this->options['through']);
74
        } else {
75 4
            $junctionModelName = $context->getModelFactory()->getJunctionClassName($this->setupName, $this->options['model']);
76
        }
77 4
        $this->options['junction_model'] = $junctionModelName;
78
79 4
        $foreignModel = $context->load($this->options['model']);
80 4
        if ($this->options['foreign_key'] == null) {
81 4
            $this->options['foreign_key'] = $foreignModel->getDescription()->getPrimaryKey()[0];
82
        }
83
84 4 View Code Duplication
        if ($this->options['local_key'] == null) {
85 4
            $this->options['local_key'] = $this->setupPrimaryKey[0];
86
        }
87
88 4 View Code Duplication
        if (!isset($this->options['junction_local_key'])) {
89 4
            $this->options['junction_local_key'] = Text::singularize($this->setupTable).'_id';
90
        }
91
92 4 View Code Duplication
        if (!isset($this->options['junction_foreign_key'])) {
93 4
            $this->options['junction_foreign_key'] = Text::singularize($foreignModel->getDBStoreInformation()['table']).'_id';
94
        }
95 4
    }
96
97
    public function preSave(&$wrapper, $value)
98
    {
99
        $this->tempdata = $wrapper[$this->options['model']];
100
        $junctionModelClass = $this->options['junction_model'];
101
        $this->junctionModelInstance = new $junctionModelClass();
102
        $this->junctionModelInstance->delete([
103
            $this->options['junction_local_key'] => $wrapper[$this->options['local_key']],
104
        ]);
105
        unset($wrapper[$this->options['model']]);
106
    }
107
108
    public function postSave(&$wrapper)
109
    {
110
        $jointModelRecords = [];
111
        foreach ($this->tempdata as $relatedRecord) {
112
            $data = $relatedRecord->toArray();
0 ignored issues
show
Unused Code introduced by
$data is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
113
            if (!$relatedRecord->save()) {
114
                throw new NibiiException("Failed to save related model {$this->options['model']}");
115
            }
116
            $jointModelRecords[] = [
117
                $this->options['junction_local_key']   => $wrapper[$this->options['local_key']],
118
                $this->options['junction_foreign_key'] => $relatedRecord[$this->options['foreign_key']],
119
            ];
120
        }
121
        $this->junctionModelInstance->setData($jointModelRecords);
122
        $this->junctionModelInstance->save();
123
    }
124
}
125