Completed
Push — master ( a30571...7a668c )
by James Ekow Abaka
02:45
created

ManyHaveManyRelationship   A

Complexity

Total Complexity 17

Size/Duplication

Total Lines 93
Duplicated Lines 10.75 %

Coupling/Cohesion

Components 1
Dependencies 6

Test Coverage

Coverage 58.18%

Importance

Changes 7
Bugs 0 Features 0
Metric Value
wmc 17
c 7
b 0
f 0
lcom 1
cbo 6
dl 10
loc 93
ccs 32
cts 55
cp 0.5818
rs 10

4 Methods

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

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 2015 ekow.
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\utils\Text;
30
use ntentan\nibii\NibiiException;
31
use ntentan\nibii\Relationship;
32
use ntentan\nibii\ORMContext;
33
34
class ManyHaveManyRelationship extends Relationship
35
{
36
37
    protected $type = self::MANY_HAVE_MANY;
38
    private $tempdata;
39
    private $junctionModelInstance;
40
41 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...
42
    {
43 4
        $junctionModelClass = $this->options['junction_model'];
44 4
        $junctionModel = new $junctionModelClass();
45 4
        $filter = $junctionModel->fields($this->options['junction_foreign_key'])
46 4
                ->filterBy($this->options['junction_local_key'], $data[$this->options['local_key']])
47 4
                ->fetch();
48 4
        if ($filter->count() == 0) {
49
            return null;
50
        }
51 4
        $foreignKeys = [];
52 4
        foreach ($filter->toArray() as $foreignItem) {
53 4
            $foreignKeys[] = $foreignItem[$this->options['junction_foreign_key']];
54
        }
55
56
        // @todo throw an exception when the data doesn't have the local key
57 4
        $query = $this->getQuery();
58 4
        if ($this->queryPrepared) {
59
            $query->setBoundData($this->options['foreign_key'], $foreignKeys);
60
        } else {
61 4
            $query = $this->getQuery()
62 4
                    ->setTable($this->getModelInstance()->getDBStoreInformation()['quoted_table'])
63 4
                    ->addFilter($this->options['foreign_key'], $foreignKeys);
64 4
            $this->queryPrepared = true;
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']);
0 ignored issues
show
Bug introduced by
The method getClassName() does not seem to exist on object<ntentan\nibii\int...\ModelFactoryInterface>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
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
        $this->junctionModelInstance = $this->container->resolve($this->options['junction_model']);
0 ignored issues
show
Bug introduced by
The property container does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
101
        $this->junctionModelInstance->delete([
102
            $this->options['junction_local_key'] => $wrapper[$this->options['local_key']]
103
        ]);
104
        unset($wrapper[$this->options['model']]);
105
    }
106
107
    public function postSave(&$wrapper)
108
    {
109
        $jointModelRecords = [];
110
        foreach ($this->tempdata as $relatedRecord) {
111
            $data = $relatedRecord->toArray();
112
            if (!isset($data[$this->options['foreign_key']]) || (isset($data[$this->options['foreign_key']]) && count($data) > 1)) {
113
                if (!$relatedRecord->save()) {
114
                    throw new NibiiException("Failed to save related model {$this->options['model']}");
115
                }
116
            }
117
            $jointModelRecords[] = [
118
                $this->options['junction_local_key'] => $wrapper[$this->options['local_key']],
119
                $this->options['junction_foreign_key'] => $relatedRecord[$this->options['foreign_key']]
120
            ];
121
        }
122
        $this->junctionModelInstance->setData($jointModelRecords);
123
        $this->junctionModelInstance->save();
124
    }
125
126
}
127