Stinger-Soft / EntitySearchBundle

Command/SyncCommand.php

Unused Use Statements -2 removed lines

@@ -13,13 +13,11 @@
 
 namespace StingerSoft\EntitySearchBundle\Command;
 
-use Doctrine\Common\Persistence\ObjectManager;
 use Doctrine\DBAL\Platforms\SQLServerPlatform;
 use Doctrine\ORM\EntityManager;
 use Doctrine\ORM\Mapping\ClassMetadata;
 use StingerSoft\EntitySearchBundle\Services\Mapping\EntityToDocumentMapperInterface;
 use StingerSoft\EntitySearchBundle\Services\SearchService;
-use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Helper\ProgressBar;
 use Symfony\Component\Console\Input\InputArgument;

Spacing +16 added lines, -16 removed lines

@@ -60,13 +60,13 @@ 
 		$this->searchService = $searchService;
 		$this->entityToDocumentMapper = $mapper;
 		// Detect upload path
-		if(!self::$defaultUploadPath) {
-			if(Kernel::VERSION_ID < 40200) {
+		if (!self::$defaultUploadPath) {
+			if (Kernel::VERSION_ID < 40200) {
 				$root = $kernel->getRootDir();
 			} else {
 				$root = $kernel->getProjectDir();
 			}
-			self::$defaultUploadPath = $root . '/../web/uploads';
+			self::$defaultUploadPath = $root.'/../web/uploads';
 		}
 	}
 
@@ -102,7 +102,7 @@ 
 		// Get the entity argument
 		$entity = $input->getArgument('entity');
 
-		if($entity === 'all') {
+		if ($entity === 'all') {
 			/**
 			 * @var EntityManager $entityManager
 			 */
@@ -113,12 +113,12 @@ 
 			/**
 			 * @var ClassMetadata $m
 			 */
-			foreach($meta as $m) {
+			foreach ($meta as $m) {
 
-				if($m->getReflectionClass()->isAbstract() || $m->getReflectionClass()->isInterface()) {
+				if ($m->getReflectionClass()->isAbstract() || $m->getReflectionClass()->isInterface()) {
 					continue;
 				}
-				if(!$this->entityToDocumentMapper->isClassIndexable($m->getReflectionClass()->getName())) {
+				if (!$this->entityToDocumentMapper->isClassIndexable($m->getReflectionClass()->getName())) {
 					continue;
 				}
 				$this->indexEntity($input, $output, $m->getReflectionClass()->getName());
@@ -150,7 +150,7 @@ 
 		try {
 			// Get repository for the given entity type
 			$repository = $entityManager->getRepository($entity);
-		} catch(\Exception $e) {
+		} catch (\Exception $e) {
 			$output->writeln(sprintf('<error>No repository found for "%s", check your input</error>', $entity));
 			return;
 		}
@@ -162,7 +162,7 @@ 
 
 		$useBatch = !($entityManager->getConnection()->getDatabasePlatform() instanceof SQLServerPlatform);
 		$iterableResult = $useBatch ? $queryBuilder->getQuery()->iterate() : $queryBuilder->getQuery()->getResult();
-		if($entityCount === 0) {
+		if ($entityCount === 0) {
 			$output->writeln('<comment>No entities found for indexing</comment>');
 			return;
 		}
@@ -172,21 +172,21 @@ 
 		$entitiesIndexed = 0;
 
 		// Index each entity separate
-		foreach($iterableResult as $row) {
+		foreach ($iterableResult as $row) {
 			$entity = $useBatch ? $row[0] : $row;
 			$progressBar->advance();
-			if($this->entityToDocumentMapper->isIndexable($entity)) {
+			if ($this->entityToDocumentMapper->isIndexable($entity)) {
 				$document = $this->entityToDocumentMapper->createDocument($entityManager, $entity);
-				if($document === null) {
+				if ($document === null) {
 					continue;
 				}
 				try {
 					$this->searchService->saveDocument($document);
 					$entitiesIndexed++;
-				} catch(\Exception $e) {
-					$output->writeln('<error>Failed to index entity with ID ' . $document->getEntityId() . '</error>');
+				} catch (\Exception $e) {
+					$output->writeln('<error>Failed to index entity with ID '.$document->getEntityId().'</error>');
 				}
-				if($entitiesIndexed % 50 === 0) {
+				if ($entitiesIndexed % 50 === 0) {
 					$entityManager->flush();
 				}
 			}
@@ -196,7 +196,7 @@ 
 		$entityManager->clear();
 		$progressBar->finish();
 		$output->writeln('');
-		$output->writeln('<comment>Indexed ' . $entitiesIndexed . ' entities</comment>');
+		$output->writeln('<comment>Indexed '.$entitiesIndexed.' entities</comment>');
 	}
 
 }
\ No newline at end of file

Model/Document.php

Doc Comments +6 added lines, -1 removed lines

@@ -94,6 +94,7 @@ 
 	 *            The name of the field
 	 * @param mixed $value
 	 *            The value of this field
+	 * @return void
 	 */
 	public function addField(string $fieldName, $value): void;
 
@@ -122,6 +123,7 @@ 
 	 *            The name of the field
 	 * @param mixed $value
 	 *            The additional value of this field
+	 * @return void
 	 */
 	public function addMultiValueField(string $fieldName, $value): void;
 
@@ -133,6 +135,7 @@ 
 	 *
 	 * @param string $clazz
 	 *            The classname
+	 * @return void
 	 */
 	public function setEntityClass(string $clazz): void;
 
@@ -152,6 +155,7 @@ 
 	 *
 	 * @param mixed $id
 	 *            The ID of the corresponding entity
+	 * @return void
 	 */
 	public function setEntityId($id): void;
 
@@ -168,6 +172,7 @@ 
 	 * hiding some programatically needed complexity from the user
 	 *
 	 * @param string $type
+	 * @return void
 	 */
 	public function setEntityType(string $type): void;
 
@@ -178,7 +183,6 @@ 
 	 *
 	 * If no entity type is set, the class will be used instead
 	 *
-	 * @param string $type
 	 */
 	public function getEntityType(): string;
 
@@ -188,6 +192,7 @@ 
 	 * <strong>note:</strong> This may not supported by the underlying implementation
 	 *
 	 * @param string $path
+	 * @return void
 	 */
 	public function setFile(string $path): void;
 

Model/Query.php

Doc Comments +1 added lines, -1 removed lines

@@ -106,7 +106,7 @@
 	 *
 	 * @param string $name
 	 *            Name of the property to set
-	 * @param mixed $value
+	 * @param string[] $value
 	 *            The value of the property
 	 */
 	public function __set($name, $value): void {

Spacing +4 added lines, -4 removed lines

@@ -92,10 +92,10 @@ 
 	 * @return array
 	 */
 	public function __get($name) {
-		if(strrpos($name, 'facet_', -strlen($name)) !== false) {
+		if (strrpos($name, 'facet_', -strlen($name)) !== false) {
 			$facetname = substr($name, 6);
 
-			if(isset($this->facets[$facetname])) {
+			if (isset($this->facets[$facetname])) {
 				return $this->facets[$facetname];
 			}
 			return array();
@@ -110,7 +110,7 @@ 
 	 *            The value of the property
 	 */
 	public function __set($name, $value): void {
-		if(strrpos($name, 'facet_', -strlen($name)) !== false) {
+		if (strrpos($name, 'facet_', -strlen($name)) !== false) {
 			$facetname = substr($name, 6);
 			$this->facets[$facetname] = $value;
 		}
@@ -123,7 +123,7 @@ 
 	 * @return boolean
 	 */
 	public function __isset($name): bool {
-		if(strrpos($name, 'facet_', -strlen($name)) !== false) {
+		if (strrpos($name, 'facet_', -strlen($name)) !== false) {
 			return true;
 		}
 

Model/Result/FacetSet.php

Doc Comments +3 added lines

@@ -40,5 +40,8 @@
 	 */
 	public function getFacets(): array;
 
+	/**
+	 * @return void
+	 */
 	public function addFacetValue(string $key, string $label, $value = null, int $increaseCounterBy = 1) : void;
 }
\ No newline at end of file

Services/Mapping/DocumentToEntityMapperInterface.php

Doc Comments -1 removed lines

@@ -22,7 +22,6 @@
 	/**
 	 * Tries to create a document from the given object
 	 *
-	 * @param object $object        	
 	 * @return object Returns false if no document could be created
 	 */
 	public function getEntity(Document $document) : ?object;

Tests/AbstractORMTestCase.php

Doc Comments +2 added lines, -2 removed lines

@@ -61,7 +61,7 @@ 
 	/**
 	 * Get annotation mapping configuration
 	 *
-	 * @return \Doctrine\ORM\Configuration
+	 * @return \PHPUnit\Framework\MockObject\MockObject
 	 */
 	protected function getMockAnnotatedConfig() {
 		// We need to mock every method except the ones which
@@ -93,7 +93,7 @@ 
 	/**
 	 * Creates default mapping driver
 	 *
-	 * @return \Doctrine\ORM\Mapping\Driver\Driver
+	 * @return AnnotationDriver
 	 */
 	protected function getMetadataDriverImplementation() {
 		return new AnnotationDriver($_ENV['annotation_reader'], $this->getPaths());

Tests/Controller/SearchControllerTest.php

Doc Comments +3 added lines

@@ -77,6 +77,9 @@
 
 	}
 
+	/**
+	 * @param \StingerSoft\EntitySearchBundle\Services\DummySearchService $searchService
+	 */
 	protected function getSearchController(?SearchService $searchService = null): SearchController {
 		$searchService = $searchService ?? $this->getDummySearchService();
 

Spacing +2 added lines, -2 removed lines

@@ -97,7 +97,7 @@ 
 			return \in_array($id, ['twig', 'form.factory'], true);
 		});
 		$container->method('get')->willReturnCallback(function($id) use ($that) {
-			if($id === 'form.factory') {
+			if ($id === 'form.factory') {
 				$resolvedFormTypeFactory = new ResolvedFormTypeFactory();
 				$formTypeFactory = Forms::createFormFactoryBuilder()
 					->addType(new FacetType())
@@ -107,7 +107,7 @@ 
 					->getFormFactory();
 				return $formTypeFactory;
 			}
-			if($id === 'twig') {
+			if ($id === 'twig') {
 				return $that;
 			}
 		});

Controller/SearchControllerTrait.php

Spacing +14 added lines, -14 removed lines

@@ -32,7 +32,7 @@ 
 	private $facetFormatter;
 
 	public function searchAction(Request $request, DocumentToEntityMapperInterface $mapper) {
-		if($request->query->get('term', false) !== false) {
+		if ($request->query->get('term', false) !== false) {
 			$this->setSearchTerm($request->getSession(), $request->query->get('term'));
 			return $this->redirectToRoute('stinger_soft_entity_search_search');
 		}
@@ -48,8 +48,8 @@ 
 		));
 
 		$facetForm->handleRequest($request);
-		if($facetForm->isSubmitted()) {
-			if($facetForm->get('clear')->isClicked()) {
+		if ($facetForm->isSubmitted()) {
+			if ($facetForm->get('clear')->isClicked()) {
 				$query->setFacets($this->getDefaultFacets());
 			}
 			$this->setSearchTerm($request->getSession(), $query->getSearchTerm());
@@ -67,9 +67,9 @@ 
 
 			$page = (int)$request->query->get('page', 1);
 			$results = null;
-			if($result instanceof PaginatableResultSet) {
+			if ($result instanceof PaginatableResultSet) {
 				$results = $result->paginate($page, $this->getResultsPerPage());
-			} elseif($results !== null) {
+			} elseif ($results !== null) {
 				$results = $result->getResults(($page - 1) * $this->getResultsPerPage(), $this->getResultsPerPage());
 			}
 
@@ -80,7 +80,7 @@ 
 				'mapper'    => $mapper,
 				'facetForm' => $facetForm->createView()
 			));
-		} catch(\Exception $exception) {
+		} catch (\Exception $exception) {
 			$response = $this->render($this->getErrorTemplate(), array(
 				'error' => $exception->getMessage(),
 				'term'  => $query->getSearchTerm()
@@ -124,7 +124,7 @@ 
 	protected function getConfiguredUsedFacets(array $queryUsedFacets) {
 		$availableFacets = $this->getAvailableFacets();
 		$usedFacets = array();
-		foreach($queryUsedFacets as $queryUsedFacet) {
+		foreach ($queryUsedFacets as $queryUsedFacet) {
 			$usedFacets[$queryUsedFacet] = $availableFacets[$queryUsedFacet];
 		}
 		return $usedFacets;
@@ -191,15 +191,15 @@ 
 	}
 
 	protected function initFacets() {
-		if(!$this->availableFacets) {
+		if (!$this->availableFacets) {
 			$this->availableFacets = array();
 			$this->facetFormatter = array();
 
 			$facetServices = $this->getParameter('stinger_soft.entity_search.available_facets');
-			foreach($facetServices as $facetServiceId) {
+			foreach ($facetServices as $facetServiceId) {
 				$facetService = $this->searchService->getFacet($facetServiceId);
 				$this->availableFacets[$facetService->getField()] = $facetService->getFormOptions();
-				if($facetService->getFacetFormatter()) {
+				if ($facetService->getFacetFormatter()) {
 					$this->facetFormatter[$facetService->getField()] = $facetService->getFacetFormatter();
 				}
 			}
@@ -213,7 +213,7 @@ 
 	 * @return string[string][]
 	 */
 	protected function getSearchFacets(SessionInterface $session) {
-		$facets = $session->get($this->getSessionPrefix() . '_facets', false);
+		$facets = $session->get($this->getSessionPrefix().'_facets', false);
 		return $facets ? \json_decode($facets, true) : $this->getDefaultFacets();
 	}
 
@@ -224,7 +224,7 @@ 
 	 * @param string[string][] $facets
 	 */
 	protected function setSearchFacets(SessionInterface $session, $facets) {
-		$session->set($this->getSessionPrefix() . '_facets', \json_encode($facets));
+		$session->set($this->getSessionPrefix().'_facets', \json_encode($facets));
 	}
 
 	/**
@@ -234,7 +234,7 @@ 
 	 * @return mixed
 	 */
 	protected function getSearchTerm(SessionInterface $session) {
-		return $session->get($this->getSessionPrefix() . '_term', false);
+		return $session->get($this->getSessionPrefix().'_term', false);
 	}
 
 	/**
@@ -244,7 +244,7 @@ 
 	 * @param string $term
 	 */
 	protected function setSearchTerm(SessionInterface $session, $term) {
-		$session->set($this->getSessionPrefix() . '_term', $term);
+		$session->set($this->getSessionPrefix().'_term', $term);
 	}
 
 }
\ No newline at end of file

Tests/Model/Result/FacetSetAdapterTest.php

Spacing +3 added lines, -3 removed lines

@@ -16,7 +16,7 @@ 
 
 class FacetSetAdapterTest extends \PHPUnit\Framework\TestCase {
 
-	public function testAddFacetValue(){
+	public function testAddFacetValue() {
 		$facets = new FacetSetAdapter(array());
 		$this->assertCount(0, $facets);
 		$facets->addFacetValue(Document::FIELD_AUTHOR, 'Oliver Kotte');
@@ -26,13 +26,13 @@ 
 		$this->assertCount(1, $facets);
 		$this->assertCount(2, $facets->getFacet(Document::FIELD_AUTHOR));
 		
-		foreach($facets as $facetKey => $facetValues){
+		foreach ($facets as $facetKey => $facetValues) {
 			$this->assertEquals(Document::FIELD_AUTHOR, $facetKey);
 			$this->assertCount(2, $facetValues);
 		}
 	}
 	
-	public function testGetFacet(){
+	public function testGetFacet() {
 		$facets = new FacetSetAdapter(array());
 		$this->assertCount(0, $facets);
 		$this->assertNull($facets->getFacet('NotExisting'));