Completed
Push — master ( 3f7c7b...59875d )
by Michal
02:57
created

MySqlDataManager   B

Complexity

Total Complexity 45

Size/Duplication

Total Lines 263
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 4

Test Coverage

Coverage 100%

Importance

Changes 0
Metric Value
wmc 45
lcom 1
cbo 4
dl 0
loc 263
rs 8.3673
c 0
b 0
f 0
ccs 3
cts 3
cp 1

16 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 4 1
B databases() 0 25 4
A getDatabaseNameColumn() 0 4 1
B tables() 0 40 4
A itemsCount() 0 5 1
A items() 0 17 3
B createWhere() 0 38 6
B createOrderBy() 0 16 5
A loadItem() 0 6 1
A deleteItem() 0 6 1
A deleteTable() 0 11 3
A deleteDatabase() 0 5 1
A selectDatabase() 0 6 1
A getPrimaryColumns() 0 15 4
B getColumns() 0 16 5
A execute() 0 19 4

How to fix   Complexity   

Complex Class

Complex classes like MySqlDataManager often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use MySqlDataManager, and based on these observations, apply Extract Interface, too.

1
<?php
2
3
namespace UniMan\Drivers\MySql;
4
5
use UniMan\Core\DataManager\AbstractDataManager;
6
use UniMan\Core\Exception\OperatorNotSupportedException;
7
use UniMan\Core\Utils\Filter;
8
use UniMan\Core\Utils\Multisort;
9
use InvalidArgumentException;
10
use Nette\Utils\Strings;
11
use PDO;
12
13
class MySqlDataManager extends AbstractDataManager
14
{
15
    private $columns = null;
16
17
    private $connection;
18
19
    private $database;
20
21
    /**
22
     * cache
23
     * @var array|null
24
     */
25
    private $databases = null;
26
27 6
    public function __construct(PDO $connection)
28
    {
29 6
        $this->connection = $connection;
30 6
    }
31
32
    public function databases(array $sorting = [])
33
    {
34
        if ($this->databases !== null) {
35
            return $this->databases;
36
        }
37
38
        $query = 'SELECT information_schema.SCHEMATA.*, count(information_schema.TABLES.TABLE_NAME) AS tables_count, SUM(information_schema.TABLES.DATA_LENGTH) AS size
39
FROM information_schema.SCHEMATA
40
LEFT JOIN information_schema.TABLES ON information_schema.SCHEMATA.SCHEMA_NAME = information_schema.TABLES.TABLE_SCHEMA
41
GROUP BY information_schema.SCHEMATA.SCHEMA_NAME
42
ORDER BY information_schema.SCHEMATA.SCHEMA_NAME';
43
44
        $databases = [];
45
        foreach ($this->connection->query($query)->fetchAll(PDO::FETCH_ASSOC) as $database) {
46
            $databases[$database['SCHEMA_NAME']] = [
47
                'database' => $database['SCHEMA_NAME'],
48
                'charset' => $database['DEFAULT_CHARACTER_SET_NAME'],
49
                'collation' => $database['DEFAULT_COLLATION_NAME'],
50
                'tables_count' => $database['tables_count'],
51
                'size' => $database['size'] ?: 0,
52
            ];
53
        }
54
        $this->databases = $databases;
55
        return Multisort::sort($databases, $sorting);
56
    }
57
58
    protected function getDatabaseNameColumn()
59
    {
60
        return 'database';
61
    }
62
63
    public function tables(array $sorting = [])
64
    {
65
        $tables = [
66
            MySqlDriver::TYPE_TABLE => [],
67
            MySqlDriver::TYPE_VIEW => [],
68
        ];
69
        $type = 'BASE TABLE';
70
        if ($this->database == 'information_schema') {
71
            $type = 'SYSTEM VIEW';
72
        }
73
74
        foreach ($this->connection->query("SELECT * FROM information_schema.TABLES WHERE TABLE_TYPE = '$type' AND TABLE_SCHEMA = '{$this->database}' ORDER BY TABLE_NAME")->fetchAll(PDO::FETCH_ASSOC) as $table) {
75
            $tables[MySqlDriver::TYPE_TABLE][$table['TABLE_NAME']] = [
76
                'table' => $table['TABLE_NAME'],
77
                'engine' => $table['ENGINE'],
78
                'collation' => $table['TABLE_COLLATION'],
79
                'data_length' => $table['DATA_LENGTH'],
80
                'index_length' => $table['INDEX_LENGTH'],
81
                'data_free' => $table['DATA_FREE'],
82
                'autoincrement' => $table['AUTO_INCREMENT'],
83
                'rows' => $table['TABLE_ROWS'],
84
            ];
85
        }
86
87
        foreach ($this->connection->query("SELECT * FROM information_schema.VIEWS WHERE TABLE_SCHEMA = '{$this->database}' ORDER BY TABLE_NAME")->fetchAll(PDO::FETCH_ASSOC) as $view) {
88
            $tables[MySqlDriver::TYPE_VIEW][$view['TABLE_NAME']] = [
89
                'view' => $view['TABLE_NAME'],
90
                'check_option' => $view['CHECK_OPTION'],
91
                'is_updatable' => $view['IS_UPDATABLE'],
92
                'definer' => $view['DEFINER'],
93
                'security_type' => $view['SECURITY_TYPE'],
94
                'character_set' => $view['CHARACTER_SET_CLIENT'],
95
                'collation' => $view['COLLATION_CONNECTION'],
96
            ];
97
        }
98
        return [
99
            MySqlDriver::TYPE_TABLE => Multisort::sort($tables[MySqlDriver::TYPE_TABLE], $sorting),
100
            MySqlDriver::TYPE_VIEW => Multisort::sort($tables[MySqlDriver::TYPE_VIEW], $sorting),
101
        ];
102
    }
103
104
    public function itemsCount($type, $table, array $filter = [])
105
    {
106
        $query = sprintf('SELECT count(*) FROM `%s`', $table) . $this->createWhere($filter);
107
        return $this->connection->query($query)->fetch(PDO::FETCH_COLUMN);
108
    }
109
110
    public function items($type, $table, $page, $onPage, array $filter = [], array $sorting = [])
111
    {
112
        $primaryColumns = $this->getPrimaryColumns($type, $table);
113
        $query = sprintf('SELECT * FROM `%s`', $table);
114
        $query .= $this->createWhere($filter);
115
        $query .= $this->createOrderBy($sorting);
116
        $query .= ' LIMIT ' . (($page - 1) * $onPage) . ', ' . $onPage;
117
        $items = [];
118
        foreach ($this->connection->query($query)->fetchAll(PDO::FETCH_ASSOC) as $item) {
119
            $pk = [];
120
            foreach ($primaryColumns as $primaryColumn) {
121
                $pk[] = $item[$primaryColumn];
122
            }
123
            $items[md5(implode('|', $pk))] = $item;
124
        }
125
        return $items;
126
    }
127
128
    private function createWhere(array $filter)
129
    {
130
        if (empty($filter)) {
131
            return '';
132
        }
133
134
        $operatorsMap = [
135
            Filter::OPERATOR_EQUAL => '= %s',
136
            Filter::OPERATOR_GREATER_THAN => '> %s',
137
            Filter::OPERATOR_GREATER_THAN_OR_EQUAL => '>= %s',
138
            Filter::OPERATOR_LESS_THAN => '< %s',
139
            Filter::OPERATOR_LESS_THAN_OR_EQUAL => '<= %s',
140
            Filter::OPERATOR_NOT_EQUAL => '!= %s',
141
            Filter::OPERATOR_CONTAINS => 'LIKE "%%%s%%"',
142
            Filter::OPERATOR_NOT_CONTAINS => 'NOT LIKE "%%%s%%"',
143
            Filter::OPERATOR_STARTS_WITH => 'LIKE "%s%%"',
144
            Filter::OPERATOR_ENDS_WITH => 'LIKE "%%%s"',
145
            Filter::OPERATOR_IS_NULL => 'IS NULL',
146
            Filter::OPERATOR_IS_NOT_NULL => 'IS NOT NULL',
147
            Filter::OPERATOR_IS_IN => 'IN (%s)',
148
            Filter::OPERATOR_IS_NOT_IN => 'NOT IN (%s)',
149
        ];
150
151
        $where = ' WHERE ';
152
        $whereParts = [];
153
        foreach ($filter as $filterPart) {
154
            foreach ($filterPart as $key => $filterSettings) {
155
                foreach ($filterSettings as $operator => $value) {
156
                    if (!isset($operatorsMap[$operator])) {
157
                        throw new OperatorNotSupportedException('Operator "' . $operator . '" is not supported.');
158
                    }
159
                    $whereParts[] = "`$key` " . sprintf($operatorsMap[$operator], $value);
160
                }
161
            }
162
        }
163
        $where .= implode(' AND ', $whereParts);
164
        return $where;
165
    }
166
167
    private function createOrderBy(array $sorting)
168
    {
169
        if (empty($sorting)) {
170
            return '';
171
        }
172
        $orderBy = ' ORDER BY ';
173
        $order = [];
174
        foreach ($sorting as $sort) {
175
            foreach ($sort as $key => $direction) {
176
                $direction = strtolower($direction) == 'asc' ? 'ASC' : 'DESC';
177
                $order[] = "`$key` $direction";
178
            }
179
        }
180
        $orderBy .= implode(', ', $order);
181
        return $orderBy;
182
    }
183
184
    public function loadItem($type, $table, $item)
185
    {
186
        $primaryColumns = $this->getPrimaryColumns($type, $table);
187
        $query = sprintf('SELECT * FROM `%s` WHERE md5(concat(%s)) = "%s"', $table, implode(', "|", ', $primaryColumns), $item);
188
        return $this->connection->query($query)->fetch(PDO::FETCH_ASSOC);
189
    }
190
191
    public function deleteItem($type, $table, $item)
192
    {
193
        $primaryColumns = $this->getPrimaryColumns($type, $table);
194
        $query = sprintf('DELETE FROM `%s` WHERE md5(concat(%s)) = "%s"', $table, implode(', "|", ', $primaryColumns), $item);
195
        return $this->connection->query($query);
0 ignored issues
show
Bug Best Practice introduced by
The return type of return $this->connection->query($query); (PDOStatement) is incompatible with the return type declared by the interface UniMan\Core\DataManager\...erInterface::deleteItem of type boolean|null.

If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.

Let’s take a look at an example:

class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}

Our function my_function expects a Post object, and outputs the author of the post. The base class Post returns a simple string and outputting a simple string will work just fine. However, the child class BlogPost which is a sub-type of Post instead decided to return an object, and is therefore violating the SOLID principles. If a BlogPost were passed to my_function, PHP would not complain, but ultimately fail when executing the strtoupper call in its body.

Loading history...
196
    }
197
198
    public function deleteTable($type, $table)
199
    {
200
        if ($type === MySqlDriver::TYPE_TABLE) {
201
            $query = sprintf('DROP TABLE `%s`', $table);
202
        } elseif ($type === MySqlDriver::TYPE_VIEW) {
203
            $query = sprintf('DROP VIEW `%s`', $table);
204
        } else {
205
            throw new InvalidArgumentException('Type "' . $type . '" is not supported');
206
        }
207
        return $this->connection->query($query);
0 ignored issues
show
Bug Best Practice introduced by
The return type of return $this->connection->query($query); (PDOStatement) is incompatible with the return type declared by the interface UniMan\Core\DataManager\...rInterface::deleteTable of type boolean|null.

If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.

Let’s take a look at an example:

class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}

Our function my_function expects a Post object, and outputs the author of the post. The base class Post returns a simple string and outputting a simple string will work just fine. However, the child class BlogPost which is a sub-type of Post instead decided to return an object, and is therefore violating the SOLID principles. If a BlogPost were passed to my_function, PHP would not complain, but ultimately fail when executing the strtoupper call in its body.

Loading history...
208
    }
209
210
    public function deleteDatabase($database)
211
    {
212
        $query = sprintf('DROP DATABASE `%s`', $database);
213
        return $this->connection->query($query);
0 ignored issues
show
Bug Best Practice introduced by
The return type of return $this->connection->query($query); (PDOStatement) is incompatible with the return type declared by the interface UniMan\Core\DataManager\...terface::deleteDatabase of type boolean|null.

If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.

Let’s take a look at an example:

class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}

Our function my_function expects a Post object, and outputs the author of the post. The base class Post returns a simple string and outputting a simple string will work just fine. However, the child class BlogPost which is a sub-type of Post instead decided to return an object, and is therefore violating the SOLID principles. If a BlogPost were passed to my_function, PHP would not complain, but ultimately fail when executing the strtoupper call in its body.

Loading history...
214
    }
215
216
    public function selectDatabase($database)
217
    {
218
        $this->database = $database;
219
        $query = sprintf('USE `%s`', $database);
220
        $this->connection->query($query);
221
    }
222
223
    public function getPrimaryColumns($type, $table)
224
    {
225
        $primaryColumns = [];
226
        $columns = [];
227
        foreach ($this->getColumns($type, $table) as $column) {
228
            $columns[] = $column['Field'];
229
            if ($column['Key'] == 'PRI') {
230
                $primaryColumns[] = $column['Field'];
231
            }
232
        }
233
        if (empty($primaryColumns)) {
234
            $primaryColumns = $columns;
235
        }
236
        return $primaryColumns;
237
    }
238
239
    public function getColumns($type, $table)
0 ignored issues
show
Unused Code introduced by
The parameter $type is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
240
    {
241
        if ($this->columns === null) {
242
            $columns = $this->connection->query(sprintf('SHOW FULL COLUMNS FROM `%s`', $table))->fetchAll(PDO::FETCH_ASSOC);
243
            $keys = [];
244
            foreach ($this->connection->query(sprintf('SELECT * FROM information_schema.KEY_COLUMN_USAGE WHERE TABLE_SCHEMA = "%s" AND TABLE_NAME = "%s"', $this->database, $table))->fetchAll(PDO::FETCH_ASSOC) as $key) {
245
                $keys[$key['COLUMN_NAME']] = $key;
246
            }
247
            $this->columns = [];
248
            foreach ($columns as $column) {
249
                $column['key_info'] = isset($keys[$column['Field']]) ? $keys[$column['Field']] : [];
250
                $this->columns[$column['Field']] = $column;
251
            }
252
        }
253
        return $this->columns;
254
    }
255
256
    public function execute($commands)
257
    {
258
        $queries = array_filter(array_map('trim', explode(';', $commands)), function ($query) {
259
            return $query;
260
        });
261
        $results = [];
262
        foreach ($queries as $query) {
263
            $results[$query]['headers'] = [];
264
            $statement = $this->connection->query($query);
265
            if (Strings::startsWith(strtolower($query), 'select ') || Strings::startsWith(strtolower($query), 'show ')) {
266
                $res = $statement->fetchAll(PDO::FETCH_ASSOC);
267
                $results[$query]['headers'] = array_keys(current($res));
268
                $results[$query]['items'] = $res;
269
                continue;
270
            }
271
            $results[$query] = (bool) $statement;
272
        }
273
        return $results;
274
    }
275
}
276