DoctrineListener::getEntityToDocumentMapper() - Code Metrics - Inspection of "Refactored EntityHanlder to EntityToDocumentMapper" - Stinger-Soft/EntitySearchBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( eb8df6...b4be3b )

by Florian

created 2016-06-21 11:16 UTC

DoctrineListener::getEntityToDocumentMapper() A

↳ Parent: DoctrineListener

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php

/*
 * This file is part of the Stinger Enity Search package.
 *
 * (c) Oliver Kotte <[email protected]>
 * (c) Florian Meyer <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace StingerSoft\EntitySearchBundle\Services;

use Doctrine\Common\Persistence\Event\LifecycleEventArgs;
use Doctrine\Common\Persistence\ObjectManager;
use Doctrine\Common\EventSubscriber;
use StingerSoft\EntitySearchBundle\Services\Mapping\EntityToDocumentMapperInterface;

class DoctrineListener implements EventSubscriber {

	/**
	 *
	 * @var EntityToDocumentMapperInterface
	 */
	protected $entityToDocumentMapper;
	
	/**
	 *
	 * @var SearchService
	 */
	protected $searchService;

	public function getSubscribedEvents() {
		return array(
			'postPersist',
			'postUpdate',
			'preRemove' 
		);
	}

	/**
	 * Constructor
	 *
	 * @param SearchService $searchService        	
	 */
	public function __construct(EntityToDocumentMapperInterface $entityToDocumentMapper, SearchService $searchService) {
		$this->entityToDocumentMapper = $entityToDocumentMapper;
		$this->searchService = $searchService;
	}

	/**
	 * Index the entity after it is persisted for the first time
	 *
	 * @param LifecycleEventArgs $args        	
	 */
	public function postPersist(LifecycleEventArgs $args) {
		$this->updateEntity($args->getObject(), $args->getObjectManager());
	}

	/**
	 * Removes the entity from the index when it marked for deletion
	 *
	 * @param LifecycleEventArgs $args        	
	 */
	public function preRemove(LifecycleEventArgs $args) {
		$this->removeEntity($args->getObject(), $args->getObjectManager());
	}

	/**
	 * Updates the entity in the index after it is updated
	 *
	 * @param LifecycleEventArgs $args        	
	 */
	public function postUpdate(LifecycleEventArgs $args) {
		$this->updateEntity($args->getObject(), $args->getObjectManager());
	}

	/**
	 *
	 * @return EntityToDocumentMapperInterface
	 */
	protected function getEntityToDocumentMapper() {
		return $this->entityToDocumentMapper;
	}
	
	/**
	 *
	 * @return SearchService
	 */
	protected function getSearchService(ObjectManager $manager) {
		$this->searchService->setObjectManager($manager);
		return $this->searchService;
	}

	/**
	 *
	 * @param object $entity        	
	 */
	protected function updateEntity($entity, ObjectManager $manager) {
		$document = $this->getEntityToDocumentMapper()->createDocument($manager, $entity);
		if($document !== false) {
			$this->getSearchService($manager)->saveDocument($document);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
		}
	}

	/**
	 *
	 * @param object $entity        	
	 */
	protected function removeEntity($entity, ObjectManager $manager) {
		$document = $this->getEntityToDocumentMapper()->createDocument($manager, $entity);
		if($document !== false) {
			$this->getSearchService($manager)->removeDocument($document);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
		}
	}
}

1			<?php
2
3			/*
4			* This file is part of the Stinger Enity Search package.
5			*
6			* (c) Oliver Kotte <[email protected]>
7			* (c) Florian Meyer <[email protected]>
8			*
9			* For the full copyright and license information, please view the LICENSE
10			* file that was distributed with this source code.
11			*/
12			namespace StingerSoft\EntitySearchBundle\Services;
13
14			use Doctrine\Common\Persistence\Event\LifecycleEventArgs;
15			use Doctrine\Common\Persistence\ObjectManager;
16			use Doctrine\Common\EventSubscriber;
17			use StingerSoft\EntitySearchBundle\Services\Mapping\EntityToDocumentMapperInterface;
18
19			class DoctrineListener implements EventSubscriber {
20
21			/**
22			*
23			* @var EntityToDocumentMapperInterface
24			*/
25			protected $entityToDocumentMapper;
26
27			/**
28			*
29			* @var SearchService
30			*/
31			protected $searchService;
32
33			public function getSubscribedEvents() {
34			return array(
35			'postPersist',
36			'postUpdate',
37			'preRemove'
38			);
39			}
40
41			/**
42			* Constructor
43			*
44			* @param SearchService $searchService
45			*/
46			public function __construct(EntityToDocumentMapperInterface $entityToDocumentMapper, SearchService $searchService) {
47			$this->entityToDocumentMapper = $entityToDocumentMapper;
48			$this->searchService = $searchService;
49			}
50
51			/**
52			* Index the entity after it is persisted for the first time
53			*
54			* @param LifecycleEventArgs $args
55			*/
56			public function postPersist(LifecycleEventArgs $args) {
57			$this->updateEntity($args->getObject(), $args->getObjectManager());
58			}
59
60			/**
61			* Removes the entity from the index when it marked for deletion
62			*
63			* @param LifecycleEventArgs $args
64			*/
65			public function preRemove(LifecycleEventArgs $args) {
66			$this->removeEntity($args->getObject(), $args->getObjectManager());
67			}
68
69			/**
70			* Updates the entity in the index after it is updated
71			*
72			* @param LifecycleEventArgs $args
73			*/
74			public function postUpdate(LifecycleEventArgs $args) {
75			$this->updateEntity($args->getObject(), $args->getObjectManager());
76			}
77
78			/**
79			*
80			* @return EntityToDocumentMapperInterface
81			*/
82			protected function getEntityToDocumentMapper() {
83			return $this->entityToDocumentMapper;
84			}
85
86			/**
87			*
88			* @return SearchService
89			*/
90			protected function getSearchService(ObjectManager $manager) {
91			$this->searchService->setObjectManager($manager);
92			return $this->searchService;
93			}
94
95			/**
96			*
97			* @param object $entity
98			*/
99			protected function updateEntity($entity, ObjectManager $manager) {
100			$document = $this->getEntityToDocumentMapper()->createDocument($manager, $entity);
101			if($document !== false) {
102			$this->getSearchService($manager)->saveDocument($document);
			0 ignored issues – show Bug introduced 2016-06-21 11:19 UTC by Report Bug Copy Issue Report It seems like `$document` defined by `$this->getEntityToDocume...ment($manager, $entity)` on line `100` can also be of type `boolean`; however, `StingerSoft\EntitySearch...Service::saveDocument()` does only seem to accept `object<StingerSoft\Entit...hBundle\Model\Document>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
103			}
104			}
105
106			/**
107			*
108			* @param object $entity
109			*/
110			protected function removeEntity($entity, ObjectManager $manager) {
111			$document = $this->getEntityToDocumentMapper()->createDocument($manager, $entity);
112			if($document !== false) {
113			$this->getSearchService($manager)->removeDocument($document);
			0 ignored issues – show Bug introduced 2016-06-21 11:19 UTC by Report Bug Copy Issue Report It seems like `$document` defined by `$this->getEntityToDocume...ment($manager, $entity)` on line `111` can also be of type `boolean`; however, `StingerSoft\EntitySearch...rvice::removeDocument()` does only seem to accept `object<StingerSoft\Entit...hBundle\Model\Document>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
114			}
115			}
116			}

Stinger-Soft / EntitySearchBundle

GitHub Access Token became invalid

Push — master ( eb8df6...b4be3b )

DoctrineListener::getEntityToDocumentMapper() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like