Total Complexity | 40 |
Total Lines | 146 |
Duplicated Lines | 0 % |
Changes | 1 | ||
Bugs | 0 | Features | 0 |
Complex classes like Maphper 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.
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 Maphper, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
3 | class Maphper implements \Countable, \ArrayAccess, \IteratorAggregate { |
||
4 | const FIND_EXACT = 0x1; |
||
5 | const FIND_LIKE = 0x2; |
||
6 | const FIND_STARTS = 0x4; |
||
7 | const FIND_ENDS = 0x8; |
||
8 | const FIND_BIT = 0x10; |
||
9 | const FIND_GREATER = 0x20; |
||
10 | const FIND_LESS = 0x40; |
||
11 | const FIND_EXPRESSION = 0x80; |
||
12 | const FIND_AND = 0x100; |
||
13 | const FIND_OR = 0x200; |
||
14 | const FIND_NOT = 0x400; |
||
15 | const FIND_BETWEEN = 0x800; |
||
16 | const FIND_NOCASE = 0x1000; |
||
17 | |||
18 | private $dataSource; |
||
19 | private $relations = []; |
||
20 | private $settings = ['filter' => [], 'sort' => null, 'limit' => null, 'offset' => null, 'resultClass' => '\\stdClass']; |
||
21 | private $iterator = 0; |
||
22 | private $entity; |
||
23 | |||
24 | public function __construct(DataSource $dataSource, array $settings = [], array $relations = []) { |
||
25 | $this->dataSource = $dataSource; |
||
26 | $this->settings = array_replace($this->settings, $settings); |
||
27 | $this->relations = $relations; |
||
28 | $this->entity = new Lib\Entity($this, $this->settings['resultClass'] ?? null); |
||
29 | } |
||
30 | |||
31 | public function addRelation($name, Relation $relation) { |
||
33 | } |
||
34 | |||
35 | public function count($group = null) { |
||
37 | } |
||
38 | |||
39 | //Allow filter(['user' => $user]) where $user is an object instead of |
||
40 | //filter(['userId' => $user->id]) |
||
41 | private function wrapFilter() { |
||
42 | foreach ($this->settings['filter'] as $name => $value) { |
||
43 | if (isset($this->relations[$name])) { |
||
44 | $filter = $this->relations[$name]->getFilter($value); |
||
45 | $this->settings['filter'] = array_merge($this->settings['filter'], $filter); |
||
46 | unset($this->settings['filter'][$name]); |
||
47 | } |
||
48 | } |
||
49 | } |
||
50 | |||
51 | private function getResults() { |
||
52 | $this->wrapFilter(); |
||
53 | foreach ($this->settings['filter'] as $name => &$filter) { |
||
54 | if (isset($this->relations[$name])) { |
||
55 | $this->relations[$name]->overwrite($filter, $filter[$name]); |
||
56 | } |
||
57 | } |
||
58 | $results = $this->dataSource->findByField($this->settings['filter'], |
||
59 | ['order' => $this->settings['sort'], 'limit' => $this->settings['limit'], 'offset' => $this->settings['offset'] ]); |
||
60 | |||
61 | $siblings = new \ArrayObject(); |
||
62 | |||
63 | foreach ($results as &$result) $result = $this->entity->create($result, $this->relations, $siblings); |
||
64 | |||
65 | return $results; |
||
66 | } |
||
67 | |||
68 | public function item($n) { |
||
69 | $array = $this->getResults(); |
||
70 | return isset($array[$n]) ? $array[$n] : null; |
||
71 | } |
||
72 | |||
73 | public function getIterator() { |
||
75 | } |
||
76 | |||
77 | private function processFilters($value) { |
||
83 | } |
||
84 | |||
85 | public function offsetSet($offset, $valueObj) { |
||
86 | if ($valueObj instanceof \Maphper\Relation) throw new \Exception(); |
||
87 | |||
88 | //Extract private properties from the object |
||
89 | $visibilityOverride = new \Maphper\Lib\VisibilityOverride($valueObj); |
||
90 | $value = $visibilityOverride->getProperties($valueObj); |
||
|
|||
91 | |||
92 | $value = $this->processFilters($value); |
||
93 | $pk = $this->dataSource->getPrimaryKey(); |
||
94 | if ($offset !== null) $value->{$pk[0]} = $offset; |
||
95 | $valueCopy = $this->removeRelations(clone $value, $pk); |
||
96 | $value = $this->entity->wrap($this->relations, $value); |
||
97 | $this->dataSource->save($value); |
||
98 | $visibilityOverride->write($value); |
||
99 | $value = $this->entity->create((array_merge((array)$value, (array)$valueCopy)), $this->relations); |
||
100 | $visibilityOverride->write($value); |
||
101 | } |
||
102 | |||
103 | private function removeRelations($obj, $pk) { // Prevent saving ManyMany twice except when pk isn't initially set |
||
104 | foreach ($this->relations as $name => $relation) |
||
105 | if ($relation instanceOf \Maphper\Relation\ManyMany && isset($obj->$name) && !empty($obj->{$pk[0]})) unset($obj->$name); |
||
106 | |||
107 | if (empty($obj->{$pk[0]})) unset($obj->{$pk[0]}); |
||
108 | return $obj; |
||
109 | } |
||
110 | |||
111 | public function offsetExists($offset) { |
||
112 | if (count($this->dataSource->getPrimaryKey()) > 1) return new MultiPk($this, $offset, $this->dataSource->getPrimaryKey()); |
||
113 | if (!empty($this->settings['filter'])) { |
||
114 | $data = $this->dataSource->findByField(array_merge($this->settings['filter'], [$this->dataSource->getPrimaryKey()[0] => $offset])); |
||
115 | return isset($data[0]); |
||
116 | } |
||
117 | return (bool) $this->dataSource->findById($offset); |
||
118 | } |
||
119 | |||
120 | public function offsetUnset($id) { |
||
121 | $this->dataSource->deleteById($id); |
||
122 | } |
||
123 | |||
124 | public function offsetGet($offset) { |
||
125 | if (count($this->dataSource->getPrimaryKey()) > 1) return new MultiPk($this, $offset, $this->dataSource->getPrimaryKey()); |
||
126 | if (!empty($this->settings['filter'])) { |
||
127 | $data = $this->dataSource->findByField(array_merge($this->settings['filter'], [$this->dataSource->getPrimaryKey()[0] => $offset])); |
||
128 | return $this->entity->create(isset($data[0]) ? $data[0] : null, $this->relations); |
||
129 | } |
||
130 | return $this->entity->create($this->dataSource->findById($offset), $this->relations); |
||
131 | } |
||
132 | |||
133 | public function __call($method, $args) { |
||
134 | if (array_key_exists($method, $this->settings)) { |
||
135 | $maphper = new Maphper($this->dataSource, $this->settings, $this->relations); |
||
136 | if (is_array($maphper->settings[$method])) $maphper->settings[$method] = $args[0] + $maphper->settings[$method]; |
||
137 | else $maphper->settings[$method] = $args[0]; |
||
138 | return $maphper; |
||
139 | } |
||
140 | else throw new \Exception('Method Maphper::' . $method . ' does not exist'); |
||
141 | } |
||
142 | |||
143 | public function findAggregate($function, $field, $group = null) { |
||
144 | return $this->dataSource->findAggregate($function, $field, $group, $this->settings['filter']); |
||
145 | } |
||
146 | |||
147 | public function delete() { |
||
149 | } |
||
150 | } |
||
151 |
This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.
If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. Please note the @ignore annotation hint above.