ModelDescription   A
last analyzed

Complexity

Total Complexity 22

Size/Duplication

Total Lines 139
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 3

Test Coverage

Coverage 97.22%

Importance

Changes 0
Metric Value
wmc 22
lcom 1
cbo 3
dl 0
loc 139
ccs 70
cts 72
cp 0.9722
rs 10
c 0
b 0
f 0

9 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 38 5
A appendConstraints() 0 13 3
B getRelationshipDetails() 0 27 7
A createRelationships() 0 11 2
A getRelationships() 0 4 1
A getPrimaryKey() 0 4 1
A getAutoPrimaryKey() 0 4 1
A getFields() 0 4 1
A getUniqueKeys() 0 4 1
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;
28
29
class ModelDescription
30
{
31
    private $fields = [];
32
    private $primaryKey = [];
33
    private $uniqueKeys = [];
34
    private $autoPrimaryKey = false;
35
36
    /**
37
     * @var array<Relationship>
38
     */
39
    private $relationships = [];
40
    private $table;
41
    private $schema;
42
    private $name;
43
44
    /**
45
     * @param RecordWrapper $model
46
     */
47 28
    public function __construct($model)
48
    {
49 28
        $context = ORMContext::getInstance();
50 28
        $dbInformation = $model->getDBStoreInformation();
51 28
        $this->table = $dbInformation['table'];
52 28
        $this->schema = $dbInformation['schema'];
53 28
        $this->name = $context->getModelName((new \ReflectionClass($model))->getName());
54 28
        $relationships = $model->getRelationships();
55 28
        $adapter = $model->getAdapter();
56 28
        $schema = array_values(
57 28
            $context->getDbContext()->getDriver()->describeTable(
58 28
                $dbInformation['unquoted_table']
59
            )
60 28
        )[0];
61 28
        $this->autoPrimaryKey = $schema['auto_increment'];
62
63 28
        foreach ($schema['columns'] as $field => $details) {
64 28
            $this->fields[$field] = [
65 28
                'type'     => $adapter->mapDataTypes($details['type']),
66 28
                'required' => !$details['nulls'],
67 28
                'default'  => $details['default'],
68 28
                'name'     => $field,
69
            ];
70 28
            if (isset($details['default'])) {
71 22
                $this->fields[$field]['default'] = $details['default'];
72
            }
73 28
            if (isset($details['length'])) {
74 28
                $this->fields[$field]['length'] = $details['length'];
75
            }
76
        }
77
78 28
        $this->appendConstraints($schema['primary_key'], $this->primaryKey, true);
79 28
        $this->appendConstraints($schema['unique_keys'], $this->uniqueKeys);
80
81 28
        foreach ($relationships as $type => $relations) {
82 28
            $this->createRelationships($type, $relations);
83
        }
84 28
    }
85
86 28
    private function appendConstraints($constraints, &$key, $flat = false)
87
    {
88 28
        foreach ($constraints as $constraint) {
89 28
            if ($flat) {
90 28
                $key = $constraint['columns'];
91 28
                break;
92
            } else {
93 16
                $key[] = [
94 16
                    'fields' => $constraint['columns'],
95
                ];
96
            }
97
        }
98 28
    }
99
100 28
    private function getRelationshipDetails($relationship)
101
    {
102 28
        $relationshipDetails = [];
0 ignored issues
show
Unused Code introduced by
$relationshipDetails 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...
103 28
        if (is_string($relationship)) {
104
            $relationshipDetails = [
105 20
                'model'       => $relationship,
106 20
                'name'        => $relationship,
107 20
                'foreign_key' => '',
108 20
                'local_key'   => '',
109
            ];
110 8
        } elseif (is_array($relationship)) {
111
            $relationshipDetails = [
112 8
                'model'       => $relationship[0],
113 8
                'name'        => isset($relationship['as']) ? $relationship['as'] : $relationship[0],
114 8
                'foreign_key' => isset($relationship['foreign_key']) ? $relationship['foreign_key'] : '',
115 8
                'local_key'   => isset($relationship['local_key']) ? $relationship['local_key'] : '',
116
            ];
117
        } else {
118
            return;
119
        }
120 28
        $relationshipDetails['local_table'] = $this->table;
121 28
        if (isset($relationship['through'])) {
122
            $relationshipDetails['through'] = $relationship['through'];
123
        }
124
125 28
        return $relationshipDetails;
126
    }
127
128 28
    private function createRelationships($type, $relationships)
129
    {
130 28
        foreach ($relationships as $relationship) {
131 28
            $relationship = $this->getRelationshipDetails($relationship);
132 28
            $class = "\\ntentan\\nibii\\relationships\\{$type}Relationship";
133 28
            $relationshipObject = new $class();
134 28
            $relationshipObject->setOptions($relationship);
135 28
            $relationshipObject->setup($this->name, $this->schema, $this->table, $this->primaryKey);
136 28
            $this->relationships[$relationship['name']] = $relationshipObject;
137
        }
138 28
    }
139
140
    /**
141
     * @return array<Relationship>
142
     */
143 26
    public function getRelationships()
144
    {
145 26
        return $this->relationships;
146
    }
147
148 24
    public function getPrimaryKey()
149
    {
150 24
        return $this->primaryKey;
151
    }
152
153 10
    public function getAutoPrimaryKey()
154
    {
155 10
        return $this->autoPrimaryKey;
156
    }
157
158 10
    public function getFields()
159
    {
160 10
        return $this->fields;
161
    }
162
163 10
    public function getUniqueKeys()
164
    {
165 10
        return $this->uniqueKeys;
166
    }
167
}
168