MetadataCollector::getClassName() - Code Metrics - Inspection of "Introducing document_dir option" - ongr-io/ElasticsearchBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 5.0 (#724)

by Simonas

created 2016-12-13 13:25 UTC

MetadataCollector::getClassName() A

↳ Parent: MetadataCollector

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	1

<?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\Mapping;

use Doctrine\Common\Cache\CacheProvider;
use ONGR\ElasticsearchBundle\Exception\DocumentParserException;
use ONGR\ElasticsearchBundle\Exception\MissingDocumentAnnotationException;

/**
 * DocumentParser wrapper for getting bundle documents mapping.
 */
class MetadataCollector
{
    /**
     * @var DocumentFinder
     */
    private $finder;

    /**
     * @var DocumentParser
     */
    private $parser;

    /**
     * @var CacheProvider
     */
    private $cache = null;

    /**
     * @var bool
     */
    private $enableCache = false;

    /**
     * Bundles mappings local cache container.
     *
     * @var mixed
     */
//    private $mappings = [];


    /**
     * @param DocumentFinder $finder For finding documents.
     * @param DocumentParser $parser For reading document annotations.
     * @param CacheProvider  $cache  Cache provider to store the meta data for later use.
     */
    public function __construct($finder, $parser, $cache = null)
    {
        $this->finder = $finder;
        $this->parser = $parser;
        $this->cache = $cache;
    }

    /**
     * Enables metadata caching.
     *
     * @param bool $enableCache
     */
    public function setEnableCache($enableCache)
    {
        $this->enableCache = $enableCache;
    }

//    public function fetchMappingFromCache($name)

//    {
//        if ($this->enableCache) {
//            $this->mappings[$name] = $this->cache->fetch($name);
//        }
//
//        if (isset($this->mappings[$name])) {
//            return $this->mappings[$name];
//        }
//
//        return null;
//    }
//
//    public function saveMappingToCache($name, $value)
//    {
//        if ($this->enableCache) {
//            $this->cache->save($name, $value);
//        }
//
//        $this->mappings[$name] = $value;
//    }

    /**
     * Fetches bundles mapping from documents.
     *
     * @param string[] $bundles Elasticsearch manager config. You can get bundles list from 'mappings' node.
     * @return array
     */
    public function getMappings(array $bundles)
    {
        $output = [];
        foreach ($bundles as $name => $bundleConfig) {
            // Backward compatibility hack for support.
            if (!is_array($bundleConfig)) {
                $name = $bundleConfig;
                $bundleConfig = [];
            }
            $mappings = $this->getBundleMapping($name, $bundleConfig);

            $alreadyDefinedTypes = array_intersect_key($mappings, $output);
            if (count($alreadyDefinedTypes)) {
                throw new \LogicException(
                    implode(',', array_keys($alreadyDefinedTypes)) .
                    ' type(s) already defined in other document, you can use the same ' .
                    'type only once in a manager definition.'
                );
            }

            $output = array_merge($output, $mappings);
        }

        return $output;
    }

    /**
     * Searches for documents in the bundle and tries to read them.
     *
     * @param string $name
     * @param array $config Bundle configuration
     *
     * @return array Empty array on containing zero documents.
     */
    public function getBundleMapping($name, $config = [])
    {
        if (!is_string($name)) {
            throw new \LogicException('getBundleMapping() in the Metadata collector expects a string argument only!');
        }

        $cacheName =  'ongr.metadata.bundle.' . md5($name.serialize($config));

        $this->enableCache && $mappings = $this->cache->contains($cacheName);

        if (isset($mappings)) {
            return $mappings;
        }

        $mappings = [];
        $documentDir = isset($config['document_dir']) ? $config['document_dir'] : 'Document';

        // Handle the case when single document mapping requested
        // Usage od ":" in name is deprecated. This if is only for BC.
        if (strpos($name, ':') !== false) {
            list($bundle, $documentClass) = explode(':', $name);
            $documents = $this->finder->getBundleDocumentClasses($bundle);
            $documents = in_array($documentClass, $documents) ? [$documentClass] : [];
        } else {
            $documents = $this->finder->getBundleDocumentClasses($name, $documentDir);
            $bundle = $name;
        }

        $bundleNamespace = $this->finder->getBundleClass($bundle);
        $bundleNamespace = substr($bundleNamespace, 0, strrpos($bundleNamespace, '\\'));

        if (!count($documents)) {
            return [];
        }

        // Loop through documents found in bundle.
        foreach ($documents as $document) {
            $documentReflection = new \ReflectionClass(
                $bundleNamespace .
                '\\' . DocumentFinder::DOCUMENT_DIR .
                '\\' . $document
            );

            try {
                $documentMapping = $this->getDocumentReflectionMapping($documentReflection);
            } catch (MissingDocumentAnnotationException $exception) {
                // Not a document, just ignore
                continue;
            }

            if (!array_key_exists($documentMapping['type'], $mappings)) {
                $documentMapping['bundle'] = $bundle;
                $mappings = array_merge($mappings, [$documentMapping['type'] => $documentMapping]);
            } else {
                throw new \LogicException(
                    $bundle . ' has 2 same type names defined in the documents. ' .
                    'Type names must be unique!'
                );
            }
        }

        $this->enableCache && $this->cache->save($cacheName, $mappings);

        return $mappings;
    }

    /**
     * @param array $manager
     *
     * @return array
     */
    public function getManagerTypes($manager)
    {
        $mapping = $this->getMappings($manager['mappings']);

        return array_keys($mapping);
    }

    /**
     * Resolves Elasticsearch type by document class.
     *
     * @param string $className FQCN or string in AppBundle:Document format
     *
     * @return string
     */
    public function getDocumentType($className)
    {
        $mapping = $this->getMapping($className);

        return $mapping['type'];
    }

    /**
     * Retrieves prepared mapping to sent to the elasticsearch client.
     *
     * @param array $bundles Manager config.
     *
     * @return array|null
     */
    public function getClientMapping(array $bundles)
    {
        /** @var array $typesMapping Array of filtered mappings for the elasticsearch client*/
        $typesMapping = null;

        /** @var array $mappings All mapping info */
        $mappings = $this->getMappings($bundles);

        foreach ($mappings as $type => $mapping) {
            if (!empty($mapping['properties'])) {
                $typesMapping[$type] = array_filter(
                    array_merge(
                        ['properties' => $mapping['properties']],
                        $mapping['fields']
                    ),
                    function ($value) {
                        return (bool)$value || is_bool($value);
                    }
                );
            }
        }

        return $typesMapping;
    }

    /**
     * Prepares analysis node for Elasticsearch client.
     *
     * @param array $bundles
     * @param array $analysisConfig
     *
     * @return array
     */
    public function getClientAnalysis(array $bundles, $analysisConfig = [])
    {
        $cacheName = 'ongr.metadata.analysis.'.md5(serialize($bundles));
        $typesAnalysis = $this->cache->fetch($cacheName);

        if ($typesAnalysis) {
            return $typesAnalysis;
        }

        $typesAnalysis = [
            'analyzer' => [],
            'filter' => [],
            'tokenizer' => [],
            'char_filter' => [],
        ];

        /** @var array $mappings All mapping info */
        $mappings = $this->getMappings($bundles);

        foreach ($mappings as $type => $metadata) {
            foreach ($metadata['analyzers'] as $analyzerName) {
                if (isset($analysisConfig['analyzer'][$analyzerName])) {
                    $analyzer = $analysisConfig['analyzer'][$analyzerName];
                    $typesAnalysis['analyzer'][$analyzerName] = $analyzer;
                    $typesAnalysis['filter'] = $this->getAnalysisNodeConfiguration(
                        'filter',
                        $analyzer,
                        $analysisConfig,
                        $typesAnalysis['filter']
                    );
                    $typesAnalysis['tokenizer'] = $this->getAnalysisNodeConfiguration(
                        'tokenizer',
                        $analyzer,
                        $analysisConfig,
                        $typesAnalysis['tokenizer']
                    );
                    $typesAnalysis['char_filter'] = $this->getAnalysisNodeConfiguration(
                        'char_filter',
                        $analyzer,
                        $analysisConfig,
                        $typesAnalysis['char_filter']
                    );
                }
            }
        }

        $this->cacheBundle($cacheName, $typesAnalysis);

        return $typesAnalysis;
    }

    /**
     * Prepares analysis node content for Elasticsearch client.
     *
     * @param string $type Node type: filter, tokenizer or char_filter
     * @param array $analyzer Analyzer from which used helpers will be extracted.
     * @param array $analysisConfig Pre configured analyzers container
     * @param array $container Current analysis container where prepared helpers will be appended.
     *
     * @return array
     */
    private function getAnalysisNodeConfiguration($type, $analyzer, $analysisConfig, $container = [])
    {
        if (isset($analyzer[$type])) {
            if (is_array($analyzer[$type])) {
                foreach ($analyzer[$type] as $filter) {
                    if (isset($analysisConfig[$type][$filter])) {
                        $container[$filter] = $analysisConfig[$type][$filter];
                    }
                }
            } else {
                if (isset($analysisConfig[$type][$analyzer[$type]])) {
                    $container[$analyzer[$type]] = $analysisConfig[$type][$analyzer[$type]];
                }
            }
        }
        return $container;
    }

    /**
     * Gathers annotation data from class.
     *
     * @param \ReflectionClass $reflectionClass Document reflection class to read mapping from.
     *
     * @return array
     * @throws DocumentParserException
     */
    private function getDocumentReflectionMapping(\ReflectionClass $reflectionClass)
    {
        return $this->parser->parse($reflectionClass);
    }

    /**
     * Returns single document mapping metadata.
     *
     * @param string $namespace Document namespace
     *
     * @return array
     * @throws DocumentParserException
     */
    public function getMapping($namespace)
    {
        $namespace = $this->getClassName($namespace);

        if (isset($this->mappings[$namespace])) {
            return $this->mappings[$namespace];
class MyClass { }

$x = new MyClass();
$x->foo = true;
        }

        $mapping = $this->getDocumentReflectionMapping(new \ReflectionClass($namespace));
        $this->cacheBundle($namespace, $mapping);

        return $mapping;
    }

    /**
     * Adds metadata information to the cache storage.
     *
     * @param string $bundle
     * @param array  $mapping
     */
    private function cacheBundle($bundle, array $mapping)
    {
        if ($this->enableCache) {
            $this->mappings[$bundle] = $mapping;
            $this->cache->save('ongr.metadata.mappings', $this->mappings);
        }
    }

    /**
     * Returns fully qualified class name.
     *
     * @param string $className
     *
     * @return string
     */
    public function getClassName($className)
    {
        return $this->finder->getNamespace($className);
    }
}


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\Mapping;
13
14			use Doctrine\Common\Cache\CacheProvider;
15			use ONGR\ElasticsearchBundle\Exception\DocumentParserException;
16			use ONGR\ElasticsearchBundle\Exception\MissingDocumentAnnotationException;
17
18			/**
19			* DocumentParser wrapper for getting bundle documents mapping.
20			*/
21			class MetadataCollector
22			{
23			/**
24			* @var DocumentFinder
25			*/
26			private $finder;
27
28			/**
29			* @var DocumentParser
30			*/
31			private $parser;
32
33			/**
34			* @var CacheProvider
35			*/
36			private $cache = null;
37
38			/**
39			* @var bool
40			*/
41			private $enableCache = false;
42
43			/**
44			* Bundles mappings local cache container.
45			*
46			* @var mixed
47			*/
48			// private $mappings = [];
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-12-13 13:29 UTC by Report Bug Copy Issue Report `50%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
49
50			/**
51			* @param DocumentFinder $finder For finding documents.
52			* @param DocumentParser $parser For reading document annotations.
53			* @param CacheProvider $cache Cache provider to store the meta data for later use.
54			*/
55			public function __construct($finder, $parser, $cache = null)
56			{
57			$this->finder = $finder;
58			$this->parser = $parser;
59			$this->cache = $cache;
60			}
61
62			/**
63			* Enables metadata caching.
64			*
65			* @param bool $enableCache
66			*/
67			public function setEnableCache($enableCache)
68			{
69			$this->enableCache = $enableCache;
70			}
71
72			// public function fetchMappingFromCache($name)
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-12-13 13:29 UTC by Report Bug Copy Issue Report `54%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
73			// {
74			// if ($this->enableCache) {
75			// $this->mappings[$name] = $this->cache->fetch($name);
76			// }
77			//
78			// if (isset($this->mappings[$name])) {
79			// return $this->mappings[$name];
80			// }
81			//
82			// return null;
83			// }
84			//
85			// public function saveMappingToCache($name, $value)
86			// {
87			// if ($this->enableCache) {
88			// $this->cache->save($name, $value);
89			// }
90			//
91			// $this->mappings[$name] = $value;
92			// }
93
94			/**
95			* Fetches bundles mapping from documents.
96			*
97			* @param string[] $bundles Elasticsearch manager config. You can get bundles list from 'mappings' node.
98			* @return array
99			*/
100			public function getMappings(array $bundles)
101			{
102			$output = [];
103			foreach ($bundles as $name => $bundleConfig) {
104			// Backward compatibility hack for support.
105			if (!is_array($bundleConfig)) {
106			$name = $bundleConfig;
107			$bundleConfig = [];
108			}
109			$mappings = $this->getBundleMapping($name, $bundleConfig);
110
111			$alreadyDefinedTypes = array_intersect_key($mappings, $output);
112			if (count($alreadyDefinedTypes)) {
113			throw new \LogicException(
114			implode(',', array_keys($alreadyDefinedTypes)) .
115			' type(s) already defined in other document, you can use the same ' .
116			'type only once in a manager definition.'
117			);
118			}
119
120			$output = array_merge($output, $mappings);
121			}
122
123			return $output;
124			}
125
126			/**
127			* Searches for documents in the bundle and tries to read them.
128			*
129			* @param string $name
130			* @param array $config Bundle configuration
131			*
132			* @return array Empty array on containing zero documents.
133			*/
134			public function getBundleMapping($name, $config = [])
135			{
136			if (!is_string($name)) {
137			throw new \LogicException('getBundleMapping() in the Metadata collector expects a string argument only!');
138			}
139
140			$cacheName = 'ongr.metadata.bundle.' . md5($name.serialize($config));
141
142			$this->enableCache && $mappings = $this->cache->contains($cacheName);
143
144			if (isset($mappings)) {
145			return $mappings;
146			}
147
148			$mappings = [];
149			$documentDir = isset($config['document_dir']) ? $config['document_dir'] : 'Document';
150
151			// Handle the case when single document mapping requested
152			// Usage od ":" in name is deprecated. This if is only for BC.
153			if (strpos($name, ':') !== false) {
154			list($bundle, $documentClass) = explode(':', $name);
155			$documents = $this->finder->getBundleDocumentClasses($bundle);
156			$documents = in_array($documentClass, $documents) ? [$documentClass] : [];
157			} else {
158			$documents = $this->finder->getBundleDocumentClasses($name, $documentDir);
159			$bundle = $name;
160			}
161
162			$bundleNamespace = $this->finder->getBundleClass($bundle);
163			$bundleNamespace = substr($bundleNamespace, 0, strrpos($bundleNamespace, '\\'));
164
165			if (!count($documents)) {
166			return [];
167			}
168
169			// Loop through documents found in bundle.
170			foreach ($documents as $document) {
171			$documentReflection = new \ReflectionClass(
172			$bundleNamespace .
173			'\\' . DocumentFinder::DOCUMENT_DIR .
174			'\\' . $document
175			);
176
177			try {
178			$documentMapping = $this->getDocumentReflectionMapping($documentReflection);
179			} catch (MissingDocumentAnnotationException $exception) {
180			// Not a document, just ignore
181			continue;
182			}
183
184			if (!array_key_exists($documentMapping['type'], $mappings)) {
185			$documentMapping['bundle'] = $bundle;
186			$mappings = array_merge($mappings, [$documentMapping['type'] => $documentMapping]);
187			} else {
188			throw new \LogicException(
189			$bundle . ' has 2 same type names defined in the documents. ' .
190			'Type names must be unique!'
191			);
192			}
193			}
194
195			$this->enableCache && $this->cache->save($cacheName, $mappings);
196
197			return $mappings;
198			}
199
200			/**
201			* @param array $manager
202			*
203			* @return array
204			*/
205			public function getManagerTypes($manager)
206			{
207			$mapping = $this->getMappings($manager['mappings']);
208
209			return array_keys($mapping);
210			}
211
212			/**
213			* Resolves Elasticsearch type by document class.
214			*
215			* @param string $className FQCN or string in AppBundle:Document format
216			*
217			* @return string
218			*/
219			public function getDocumentType($className)
220			{
221			$mapping = $this->getMapping($className);
222
223			return $mapping['type'];
224			}
225
226			/**
227			* Retrieves prepared mapping to sent to the elasticsearch client.
228			*
229			* @param array $bundles Manager config.
230			*
231			* @return array\|null
232			*/
233			public function getClientMapping(array $bundles)
234			{
235			/** @var array $typesMapping Array of filtered mappings for the elasticsearch client*/
236			$typesMapping = null;
237
238			/** @var array $mappings All mapping info */
239			$mappings = $this->getMappings($bundles);
240
241			foreach ($mappings as $type => $mapping) {
242			if (!empty($mapping['properties'])) {
243			$typesMapping[$type] = array_filter(
244			array_merge(
245			['properties' => $mapping['properties']],
246			$mapping['fields']
247			),
248			function ($value) {
249			return (bool)$value \|\| is_bool($value);
250			}
251			);
252			}
253			}
254
255			return $typesMapping;
256			}
257
258			/**
259			* Prepares analysis node for Elasticsearch client.
260			*
261			* @param array $bundles
262			* @param array $analysisConfig
263			*
264			* @return array
265			*/
266			public function getClientAnalysis(array $bundles, $analysisConfig = [])
267			{
268			$cacheName = 'ongr.metadata.analysis.'.md5(serialize($bundles));
269			$typesAnalysis = $this->cache->fetch($cacheName);
270
271			if ($typesAnalysis) {
272			return $typesAnalysis;
273			}
274
275			$typesAnalysis = [
276			'analyzer' => [],
277			'filter' => [],
278			'tokenizer' => [],
279			'char_filter' => [],
280			];
281
282			/** @var array $mappings All mapping info */
283			$mappings = $this->getMappings($bundles);
284
285			foreach ($mappings as $type => $metadata) {
286			foreach ($metadata['analyzers'] as $analyzerName) {
287			if (isset($analysisConfig['analyzer'][$analyzerName])) {
288			$analyzer = $analysisConfig['analyzer'][$analyzerName];
289			$typesAnalysis['analyzer'][$analyzerName] = $analyzer;
290			$typesAnalysis['filter'] = $this->getAnalysisNodeConfiguration(
291			'filter',
292			$analyzer,
293			$analysisConfig,
294			$typesAnalysis['filter']
295			);
296			$typesAnalysis['tokenizer'] = $this->getAnalysisNodeConfiguration(
297			'tokenizer',
298			$analyzer,
299			$analysisConfig,
300			$typesAnalysis['tokenizer']
301			);
302			$typesAnalysis['char_filter'] = $this->getAnalysisNodeConfiguration(
303			'char_filter',
304			$analyzer,
305			$analysisConfig,
306			$typesAnalysis['char_filter']
307			);
308			}
309			}
310			}
311
312			$this->cacheBundle($cacheName, $typesAnalysis);
313
314			return $typesAnalysis;
315			}
316
317			/**
318			* Prepares analysis node content for Elasticsearch client.
319			*
320			* @param string $type Node type: filter, tokenizer or char_filter
321			* @param array $analyzer Analyzer from which used helpers will be extracted.
322			* @param array $analysisConfig Pre configured analyzers container
323			* @param array $container Current analysis container where prepared helpers will be appended.
324			*
325			* @return array
326			*/
327			private function getAnalysisNodeConfiguration($type, $analyzer, $analysisConfig, $container = [])
328			{
329			if (isset($analyzer[$type])) {
330			if (is_array($analyzer[$type])) {
331			foreach ($analyzer[$type] as $filter) {
332			if (isset($analysisConfig[$type][$filter])) {
333			$container[$filter] = $analysisConfig[$type][$filter];
334			}
335			}
336			} else {
337			if (isset($analysisConfig[$type][$analyzer[$type]])) {
338			$container[$analyzer[$type]] = $analysisConfig[$type][$analyzer[$type]];
339			}
340			}
341			}
342			return $container;
343			}
344
345			/**
346			* Gathers annotation data from class.
347			*
348			* @param \ReflectionClass $reflectionClass Document reflection class to read mapping from.
349			*
350			* @return array
351			* @throws DocumentParserException
352			*/
353			private function getDocumentReflectionMapping(\ReflectionClass $reflectionClass)
354			{
355			return $this->parser->parse($reflectionClass);
356			}
357
358			/**
359			* Returns single document mapping metadata.
360			*
361			* @param string $namespace Document namespace
362			*
363			* @return array
364			* @throws DocumentParserException
365			*/
366			public function getMapping($namespace)
367			{
368			$namespace = $this->getClassName($namespace);
369
370			if (isset($this->mappings[$namespace])) {
371			return $this->mappings[$namespace];
			0 ignored issues – show Bug introduced 2016-12-13 13:29 UTC by Report Bug Copy Issue Report The property `mappings` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
372			}
373
374			$mapping = $this->getDocumentReflectionMapping(new \ReflectionClass($namespace));
375			$this->cacheBundle($namespace, $mapping);
376
377			return $mapping;
378			}
379
380			/**
381			* Adds metadata information to the cache storage.
382			*
383			* @param string $bundle
384			* @param array $mapping
385			*/
386			private function cacheBundle($bundle, array $mapping)
387			{
388			if ($this->enableCache) {
389			$this->mappings[$bundle] = $mapping;
390			$this->cache->save('ongr.metadata.mappings', $this->mappings);
391			}
392			}
393
394			/**
395			* Returns fully qualified class name.
396			*
397			* @param string $className
398			*
399			* @return string
400			*/
401			public function getClassName($className)
402			{
403			return $this->finder->getNamespace($className);
404			}
405			}
406

ongr-io / ElasticsearchBundle

Pull Request — 5.0 (#724)

MetadataCollector::getClassName() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like