Converter::checkVariableType() - Code Metrics - Inspection of "implemented type casting for float and int in Conv..." - ongr-io/ElasticsearchBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#585)

unknown

created 2016-03-09 13:43 UTC

Converter::checkVariableType() A

↳ Parent: Converter

Complexity

Conditions	3
Paths	3

Size

Total Lines	12
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	12
rs	9.4285
cc	3
eloc	7
nc	3
nop	2

<?php

/*
 * This file is part of the ONGR package.
 *
 * (c) NFQ Technologies UAB <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace ONGR\ElasticsearchBundle\Result;

use ONGR\ElasticsearchBundle\Collection\Collection;
use ONGR\ElasticsearchBundle\Mapping\MetadataCollector;
use ONGR\ElasticsearchBundle\Service\Manager;

/**
 * This class converts array to document object.
 */
class Converter
{
    /**
     * @var MetadataCollector
     */
    private $metadataCollector;

    /**
     * Constructor.
     *
     * @param MetadataCollector $metadataCollector
     */
    public function __construct($metadataCollector)
    {
        $this->metadataCollector = $metadataCollector;
    }

    /**
     * Converts raw array to document.
     *
     * @param array   $rawData
     * @param Manager $manager
     *
     * @return object
     *
     * @throws \LogicException
     */
    public function convertToDocument($rawData, Manager $manager)
    {
        $types = $this->metadataCollector->getMappings($manager->getConfig()['mappings']);

        if (isset($types[$rawData['_type']])) {
            $metadata = $types[$rawData['_type']];
        } else {
            throw new \LogicException("Got document of unknown type '{$rawData['_type']}'.");
        }

        switch (true) {
            case isset($rawData['_source']):
                $rawData = array_merge($rawData, $rawData['_source']);
                break;
            case isset($rawData['fields']):
                $rawData = array_merge($rawData, $rawData['fields']);
                break;
            default:
                // Do nothing.
                break;
        }

        $object = $this->assignArrayToObject($rawData, new $metadata['namespace'](), $metadata['aliases']);

        return $object;
    }

    /**
     * Assigns all properties to object.
     *
     * @param array            $array
     * @param \ReflectionClass $object
     * @param array            $aliases
     *
     * @return object
     */
    public function assignArrayToObject(array $array, $object, array $aliases)
    {
        foreach ($array as $name => $value) {
            if (!isset($aliases[$name])) {
                continue;
            }

            if (isset($aliases[$name]['type'])) {
                switch ($aliases[$name]['type']) {
                    case 'date':
                        $value = \DateTime::createFromFormat(
                            isset($aliases[$name]['format']) ? $aliases[$name]['format'] : \DateTime::ISO8601,
                            $value
                        );
                        break;
                    case 'object':
                    case 'nested':
                        if ($aliases[$name]['multiple']) {
                            $value = new ObjectIterator($this, $value, $aliases[$name]);
                        } else {
                            if (!isset($value)) {
                                break;
                            }
                            $value = $this->assignArrayToObject(
                                $value,
                                new $aliases[$name]['namespace'](),
                                $aliases[$name]['aliases']
                            );
                        }
                        break;
                    default:
                        // Do nothing here. Default cas is required by our code style standard.
                        break;
                }
            }

            if ($aliases[$name]['propertyType'] == 'private') {

                $object->{$aliases[$name]['methods']['setter']}($value);
            } else {
                $object->{$aliases[$name]['propertyName']} = $value;
            }
        }

        return $object;
    }

    /**
     * Converts object to an array.
     *
     * @param mixed $object
     * @param array $aliases
     * @param array $fields
     *
     * @return array
     */
    public function convertToArray($object, $aliases = [], $fields = [])
    {
        if (empty($aliases)) {
            $aliases = $this->getAlias($object);
            if (count($fields) > 0) {
                $aliases = array_intersect_key($aliases, array_flip($fields));
            }
        }

        $array = [];

        // Variable $name defined in client.
        foreach ($aliases as $name => $alias) {
            if ($aliases[$name]['propertyType'] == 'private') {

                $value = $object->{$aliases[$name]['methods']['getter']}();
            } else {
                $value = $object->{$aliases[$name]['propertyName']};
            }

            if (isset($value)) {
                if (array_key_exists('aliases', $alias)) {
                    $new = [];
                    if ($alias['multiple']) {
                        $this->isCollection($aliases[$name]['propertyName'], $value);
                        foreach ($value as $item) {
                            $this->checkVariableType($item, [$alias['namespace']]);
                            $new[] = $this->convertToArray($item, $alias['aliases']);
                        }
                    } else {
                        $this->checkVariableType($value, [$alias['namespace']]);
                        $new = $this->convertToArray($value, $alias['aliases']);
                    }
                    $value = $new;
                }

                if ($value instanceof \DateTime) {
                    $value = $value->format(isset($alias['format']) ? $alias['format'] : \DateTime::ISO8601);
                }

                if (isset($alias['type'])) {
                    switch ($alias['type']) {
                        case 'float':
                            if (is_string($value) && preg_match('/^[0-9]*,*[0-9]*$/', $value)) {
                                $value = explode(',', $value);
                                $value = implode('.', $value);
                            }
                            $value = (float)$value;
                            break;
                        case 'integer':
                            $value = (int)$value;
                            break;
                        default:
                            break;
                    }
                }

                $array[$name] = $value;
            }
        }

        return $array;
    }

    /**
     * Check if class matches the expected one.
     *
     * @param object $object
     * @param array  $expectedClasses
     *
     * @throws \InvalidArgumentException
     */
    private function checkVariableType($object, array $expectedClasses)
    {
        if (!is_object($object)) {
            $msg = 'Expected variable of type object, got ' . gettype($object) . ". (field isn't multiple)";
            throw new \InvalidArgumentException($msg);
        }

        $class = get_class($object);
        if (!in_array($class, $expectedClasses)) {
            throw new \InvalidArgumentException("Expected object of type {$expectedClasses[0]}, got {$class}.");
        }
    }

    /**
     * Check if value is instance of Collection.
     *
     * @param string $property
     * @param mixed  $value
     *
     * @throws \InvalidArgumentException
     */
    private function isCollection($property, $value)
    {
        if (!$value instanceof Collection) {
            $got = is_object($value) ? get_class($value) : gettype($value);

            throw new \InvalidArgumentException(
                sprintf('Value of "%s" property must be an instance of Collection, got %s.', $property, $got)
            );
        }
    }

    /**
     * Returns aliases for certain document.
     *
     * @param object $document
     *
     * @return array
     */
    private function getAlias($document)
    {
        $class = get_class($document);
        $documentMapping = $this->metadataCollector->getMapping($class);

        return $documentMapping['aliases'];
    }
}


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\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 2015-11-23 09:47 UTC by Report Bug Copy Issue Report 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		* @param array $fields
136		*
137		* @return array
138		*/
139		public function convertToArray($object, $aliases = [], $fields = [])
140		{
141		if (empty($aliases)) {
142		$aliases = $this->getAlias($object);
143		if (count($fields) > 0) {
144		$aliases = array_intersect_key($aliases, array_flip($fields));
145		}
146		}
147
148		$array = [];
149
150		// Variable $name defined in client.
151		foreach ($aliases as $name => $alias) {
152	View Code Duplication	if ($aliases[$name]['propertyType'] == 'private') {
		0 ignored issues – show Duplication introduced 2015-11-23 09:47 UTC by Report Bug Copy Issue Report 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...
153		$value = $object->{$aliases[$name]['methods']['getter']}();
154		} else {
155		$value = $object->{$aliases[$name]['propertyName']};
156		}
157
158		if (isset($value)) {
159		if (array_key_exists('aliases', $alias)) {
160		$new = [];
161		if ($alias['multiple']) {
162		$this->isCollection($aliases[$name]['propertyName'], $value);
163		foreach ($value as $item) {
164		$this->checkVariableType($item, [$alias['namespace']]);
165		$new[] = $this->convertToArray($item, $alias['aliases']);
166		}
167		} else {
168		$this->checkVariableType($value, [$alias['namespace']]);
169		$new = $this->convertToArray($value, $alias['aliases']);
170		}
171		$value = $new;
172		}
173
174		if ($value instanceof \DateTime) {
175		$value = $value->format(isset($alias['format']) ? $alias['format'] : \DateTime::ISO8601);
176		}
177
178		if (isset($alias['type'])) {
179		switch ($alias['type']) {
180		case 'float':
181		if (is_string($value) && preg_match('/^[0-9],[0-9]*$/', $value)) {
182		$value = explode(',', $value);
183		$value = implode('.', $value);
184		}
185		$value = (float)$value;
186		break;
187		case 'integer':
188		$value = (int)$value;
189		break;
190		default:
191		break;
192		}
193		}
194
195		$array[$name] = $value;
196		}
197		}
198
199		return $array;
200		}
201
202		/**
203		* Check if class matches the expected one.
204		*
205		* @param object $object
206		* @param array $expectedClasses
207		*
208		* @throws \InvalidArgumentException
209		*/
210		private function checkVariableType($object, array $expectedClasses)
211		{
212		if (!is_object($object)) {
213		$msg = 'Expected variable of type object, got ' . gettype($object) . ". (field isn't multiple)";
214		throw new \InvalidArgumentException($msg);
215		}
216
217		$class = get_class($object);
218		if (!in_array($class, $expectedClasses)) {
219		throw new \InvalidArgumentException("Expected object of type {$expectedClasses[0]}, got {$class}.");
220		}
221		}
222
223		/**
224		* Check if value is instance of Collection.
225		*
226		* @param string $property
227		* @param mixed $value
228		*
229		* @throws \InvalidArgumentException
230		*/
231		private function isCollection($property, $value)
232		{
233		if (!$value instanceof Collection) {
234		$got = is_object($value) ? get_class($value) : gettype($value);
235
236		throw new \InvalidArgumentException(
237		sprintf('Value of "%s" property must be an instance of Collection, got %s.', $property, $got)
238		);
239		}
240		}
241
242		/**
243		* Returns aliases for certain document.
244		*
245		* @param object $document
246		*
247		* @return array
248		*/
249		private function getAlias($document)
250		{
251		$class = get_class($document);
252		$documentMapping = $this->metadataCollector->getMapping($class);
253
254		return $documentMapping['aliases'];
255		}
256		}
257

ongr-io / ElasticsearchBundle

Pull Request — master (#585)

Converter::checkVariableType() A

Complexity

Size

Duplication

Duplication Side-by-Side

Filter issues like