Stinger-Soft / EntitySearchBundle

StingerSoftEntitySearchBundle.php

Doc Comments +3 added lines

@@ -17,6 +17,9 @@
  */
 class StingerSoftEntitySearchBundle extends Bundle {
 
+	/**
+	 * @param string $env
+	 */
 	public static function getRequiredBundles($env) {
 		$bundles = array();
 		$bundles['StingerSoftEntitySearchBundle'] = '\StingerSoft\EntitySearchBundle\StingerSoftEntitySearchBundle';

Tests/Form/QueryTypeTest.php

Spacing +1 added lines, -1 removed lines

@@ -116,7 +116,7 @@
 		$view = $form->createView();
 		$children = $view->children;
 		
-		foreach(array_keys($formData) as $key) {
+		foreach (array_keys($formData) as $key) {
 			$this->assertArrayHasKey($key, $children);
 		}
 		

Tests/Services/DoctrineListenerTest.php

Doc Comments +4 added lines, -4 removed lines

@@ -25,9 +25,9 @@ 
 
 	/**
 	 *
-	 * @param number $save
+	 * @param integer $save
 	 *        	Number of expected saves
-	 * @param number $delete
+	 * @param integer $delete
 	 *        	Number of expected deletions
 	 */
 	protected function registerDoctrineListener($save = 0, $delete = 0) {
@@ -50,9 +50,9 @@ 
 
 	/**
 	 *
-	 * @param number $save
+	 * @param integer $save
 	 *        	Number of expected saves
-	 * @param number $delete
+	 * @param integer $delete
 	 *        	Number of expected deletions
 	 */
 	protected function registerSearchService($save = 0, $delete = 0) {

Tests/AbstractORMTestCase.php

Spacing +4 added lines, -4 removed lines

@@ -44,7 +44,7 @@ 
 		);
 		$config = null === $config ? $this->getMockAnnotatedConfig() : $config;
 		$em = EntityManager::create($conn, $config, $evm ?: $this->getEventManager());
-		$schema = array_map(function ($class) use ($em) {
+		$schema = array_map(function($class) use ($em) {
 			return $em->getClassMetadata($class);
 		}, (array)$this->getUsedEntityFixtures());
 		$schemaTool = new SchemaTool($em);
@@ -69,13 +69,13 @@ 
 		$refl = new \ReflectionClass($configurationClass);
 		$methods = $refl->getMethods();
 		$mockMethods = array();
-		foreach($methods as $method) {
-			if($method->name !== 'addFilter' && $method->name !== 'getFilterClassName') {
+		foreach ($methods as $method) {
+			if ($method->name !== 'addFilter' && $method->name !== 'getFilterClassName') {
 				$mockMethods[] = $method->name;
 			}
 		}
 		$config = $this->getMockBuilder($configurationClass)->setMethods($mockMethods)->getMock();
-		$config->expects($this->once())->method('getProxyDir')->will($this->returnValue(__DIR__ . '/../../temp'));
+		$config->expects($this->once())->method('getProxyDir')->will($this->returnValue(__DIR__.'/../../temp'));
 		$config->expects($this->once())->method('getProxyNamespace')->will($this->returnValue('Proxy'));
 		$config->expects($this->any())->method('getDefaultQueryHints')->will($this->returnValue(array()));
 		$config->expects($this->once())->method('getAutoGenerateProxyClasses')->will($this->returnValue(true));

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/application.php

Spacing +1 added lines, -1 removed lines

@@ -1,6 +1,6 @@
 <?php
 // application.php
-require __DIR__ . '/../vendor/autoload.php';
+require __DIR__.'/../vendor/autoload.php';
 
 use StingerSoft\EntitySearchBundle\Command\ClearIndexCommand;
 use StingerSoft\EntitySearchBundle\Command\SyncCommand;

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