Completed
Pull Request — master (#527)
by Mantas
10:45 queued 03:22
created

Converter   A

Complexity

Total Complexity 35

Size/Duplication

Total Lines 220
Duplicated Lines 4.55 %

Coupling/Cohesion

Components 1
Dependencies 3

Importance

Changes 12
Bugs 3 Features 1
Metric Value
wmc 35
c 12
b 3
f 1
lcom 1
cbo 3
dl 10
loc 220
rs 9

7 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 4 1
A checkVariableType() 0 12 3
D convertToArray() 5 42 10
B convertToDocument() 0 26 4
C assignArrayToObject() 5 45 11
A isCollection() 0 10 3
A getAlias() 0 10 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
 * This file is part of the ONGR package.
5
 *
6
 * (c) NFQ Technologies UAB <[email protected]>
7
 *
8
 * For the full copyright and license information, please view the LICENSE
9
 * file that was distributed with this source code.
10
 */
11
12
namespace ONGR\ElasticsearchBundle\Result;
13
14
use ONGR\ElasticsearchBundle\Collection;
15
use ONGR\ElasticsearchBundle\Mapping\MetadataCollector;
16
use ONGR\ElasticsearchBundle\Service\Manager;
17
18
/**
19
 * This class converts array to document object.
20
 */
21
class Converter
22
{
23
    /**
24
     * @var MetadataCollector
25
     */
26
    private $metadataCollector;
27
28
    /**
29
     * Constructor.
30
     *
31
     * @param MetadataCollector $metadataCollector
32
     */
33
    public function __construct($metadataCollector)
34
    {
35
        $this->metadataCollector = $metadataCollector;
36
    }
37
38
    /**
39
     * Converts raw array to document.
40
     *
41
     * @param array   $rawData
42
     * @param Manager $manager
43
     *
44
     * @return object
45
     *
46
     * @throws \LogicException
47
     */
48
    public function convertToDocument($rawData, Manager $manager)
49
    {
50
        $types = $this->metadataCollector->getMappings($manager->getConfig()['mappings']);
51
52
        if (isset($types[$rawData['_type']])) {
53
            $metadata = $types[$rawData['_type']];
54
        } else {
55
            throw new \LogicException("Got document of unknown type '{$rawData['_type']}'.");
56
        }
57
58
        switch (true) {
59
            case isset($rawData['_source']):
60
                $rawData = array_merge($rawData, $rawData['_source']);
61
                break;
62
            case isset($rawData['fields']):
63
                $rawData = array_merge($rawData, $rawData['fields']);
64
                break;
65
            default:
66
                // Do nothing.
67
                break;
68
        }
69
70
        $object = $this->assignArrayToObject($rawData, new $metadata['namespace'](), $metadata['aliases']);
71
72
        return $object;
73
    }
74
75
    /**
76
     * Assigns all properties to object.
77
     *
78
     * @param array            $array
79
     * @param \ReflectionClass $object
80
     * @param array            $aliases
81
     *
82
     * @return object
83
     */
84
    public function assignArrayToObject(array $array, $object, array $aliases)
85
    {
86
        foreach ($array as $name => $value) {
87
            if (!isset($aliases[$name])) {
88
                continue;
89
            }
90
91
            if (isset($aliases[$name]['type'])) {
92
                switch ($aliases[$name]['type']) {
93
                    case 'date':
94
                        $value = \DateTime::createFromFormat(
95
                            isset($aliases[$name]['format']) ? $aliases[$name]['format'] : \DateTime::ISO8601,
96
                            $value
97
                        );
98
                        break;
99
                    case 'object':
100
                    case 'nested':
101
                        if ($aliases[$name]['multiple']) {
102
                            $value = new ObjectIterator($this, $value, $aliases[$name]);
103
                        } else {
104
                            if (!isset($value)) {
105
                                break;
106
                            }
107
                            $value = $this->assignArrayToObject(
108
                                $value,
109
                                new $aliases[$name]['namespace'](),
110
                                $aliases[$name]['aliases']
111
                            );
112
                        }
113
                        break;
114
                    default:
115
                        // Do nothing here. Default cas is required by our code style standard.
116
                        break;
117
                }
118
            }
119
120 View Code Duplication
            if ($aliases[$name]['propertyType'] == 'private') {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
121
                $object->{$aliases[$name]['methods']['setter']}($value);
122
            } else {
123
                $object->{$aliases[$name]['propertyName']} = $value;
124
            }
125
        }
126
127
        return $object;
128
    }
129
130
    /**
131
     * Converts object to an array.
132
     *
133
     * @param mixed $object
134
     * @param array $aliases
135
     *
136
     * @return array
137
     */
138
    public function convertToArray($object, $aliases = [])
139
    {
140
        if (empty($aliases)) {
141
            $aliases = $this->getAlias($object);
142
        }
143
144
        $array = [];
145
146
        // Variable $name defined in client.
147
        foreach ($aliases as $name => $alias) {
148 View Code Duplication
            if ($aliases[$name]['propertyType'] == 'private') {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
149
                $value = $object->{$aliases[$name]['methods']['getter']}();
150
            } else {
151
                $value = $object->{$aliases[$name]['propertyName']};
152
            }
153
154
            if (isset($value)) {
155
                if (array_key_exists('aliases', $alias)) {
156
                    $new = [];
157
                    if ($alias['multiple']) {
158
                        $this->isCollection($aliases[$name]['propertyName'], $value);
159
                        foreach ($value as $item) {
160
                            $this->checkVariableType($item, [$alias['namespace']]);
161
                            $new[] = $this->convertToArray($item, $alias['aliases']);
162
                        }
163
                    } else {
164
                        $this->checkVariableType($value, [$alias['namespace']]);
165
                        $new = $this->convertToArray($value, $alias['aliases']);
166
                    }
167
                    $value = $new;
168
                }
169
170
                if ($value instanceof \DateTime) {
171
                    $value = $value->format(isset($alias['format']) ? $alias['format'] : \DateTime::ISO8601);
172
                }
173
174
                $array[$name] = $value;
175
            }
176
        }
177
178
        return $array;
179
    }
180
181
    /**
182
     * Check if class matches the expected one.
183
     *
184
     * @param object $object
185
     * @param array  $expectedClasses
186
     *
187
     * @throws \InvalidArgumentException
188
     */
189
    private function checkVariableType($object, array $expectedClasses)
190
    {
191
        if (!is_object($object)) {
192
            $msg = 'Expected variable of type object, got ' . gettype($object) . ". (field isn't multiple)";
193
            throw new \InvalidArgumentException($msg);
194
        }
195
196
        $class = get_class($object);
197
        if (!in_array($class, $expectedClasses)) {
198
            throw new \InvalidArgumentException("Expected object of type {$expectedClasses[0]}, got {$class}.");
199
        }
200
    }
201
202
    /**
203
     * Check if value is instance of Collection.
204
     *
205
     * @param string $property
206
     * @param mixed  $value
207
     *
208
     * @throws \InvalidArgumentException
209
     */
210
    private function isCollection($property, $value)
211
    {
212
        if (!$value instanceof Collection) {
213
            $got = is_object($value) ? get_class($value) : gettype($value);
214
215
            throw new \InvalidArgumentException(
216
                sprintf('Value of "%s" property must be an instance of Collection, got %s.', $property, $got)
217
            );
218
        }
219
    }
220
221
    /**
222
     * Returns aliases for certain document.
223
     *
224
     * @param object $document
225
     *
226
     * @return array
227
     *
228
     * @throws \DomainException
229
     */
230
    private function getAlias($document)
231
    {
232
        $class = get_class($document);
233
        $documentMapping = $this->metadataCollector->getMapping($class);
234
        if (is_array($documentMapping) && isset($documentMapping['aliases'])) {
235
            return $documentMapping['aliases'];
236
        }
237
238
        throw new \DomainException("Aliases could not be found for {$class} document.");
239
    }
240
}
241