Merge pull request #420 from kdambekalns/task/code-cleanup

Code cleanup

Author: kdambekalns

Classes/AssetExtraction/IngestAttachmentAssetExtractor.php

@@ -13,10 +13,12 @@
  * source code.
  */
 
+use Flowpack\ElasticSearch\Transfer\Exception\ApiException;
 use Neos\Flow\Annotations as Flow;
 use Neos\ContentRepository\Search\AssetExtraction\AssetExtractorInterface;
 use Neos\ContentRepository\Search\Dto\AssetContent;
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\ElasticSearchClient;
+use Neos\Flow\Http\Exception;
 use Neos\Flow\Log\ThrowableStorageInterface;
 use Neos\Flow\Log\Utility\LogEnvironment;
 use Neos\Media\Domain\Model\AssetInterface;
@@ -58,8 +60,8 @@ class IngestAttachmentAssetExtractor implements AssetExtractorInterface
      * @param AssetInterface $asset
      * @return AssetContent
      * @throws \Flowpack\ElasticSearch\Transfer\Exception
-     * @throws \Flowpack\ElasticSearch\Transfer\Exception\ApiException
-     * @throws \Neos\Flow\Http\Exception
+     * @throws ApiException
+     * @throws Exception
      */
     public function extract(AssetInterface $asset): AssetContent
     {
@@ -132,7 +134,7 @@ protected function getAssetContent(AssetInterface $asset): string
     }
 
     /**
-     * @param $extractedAsset
+     * @param ?array $extractedAsset
      * @return AssetContent
      */
     protected function buildAssetContentObject(?array $extractedAsset): AssetContent

Classes/Client/ClientFactory.php

@@ -15,6 +15,7 @@
 
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\ElasticSearchClient;
 use Flowpack\ElasticSearch\Domain\Model\Client;
+use Flowpack\ElasticSearch\Exception;
 use Neos\Flow\Annotations as Flow;
 
 /**
@@ -32,7 +33,7 @@ class ClientFactory
      * Create a client
      *
      * @return Client
-     * @throws \Flowpack\ElasticSearch\Exception
+     * @throws Exception
      */
     public function create(): Client
     {

Classes/Command/NodeTypeCommandController.php

@@ -13,6 +13,7 @@
  * source code.
  */
 
+use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Exception;
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Service\NodeTypeIndexingConfiguration;
 use Neos\ContentRepository\Domain\Model\NodeType;
 use Neos\ContentRepository\Domain\Service\NodeTypeManager;
@@ -69,7 +70,7 @@ public function showCommand(?string $nodeType = null): void
     /**
      * Shows a list of NodeTypes and if they are configured to be indexable or not
      *
-     * @throws \Flowpack\ElasticSearch\ContentRepositoryAdaptor\Exception
+     * @throws Exception
      */
     public function showIndexableConfigurationCommand(): void
     {

Classes/Command/SearchCommandController.php

@@ -148,15 +148,15 @@ private function outputResults(ElasticSearchQueryResult $result): void
 
             foreach ($node->getProperties() as $propertyName => $propertyValue) {
                 if ($propertyValue instanceof ResourceBasedInterface) {
-                    $properties[$propertyName] = '<b>' . $propertyName . '</b>: ' . (string)$propertyValue->getResource()->getFilename();
+                    $properties[$propertyName] = '<b>' . $propertyName . '</b>: ' . $propertyValue->getResource()->getFilename();
                 } elseif ($propertyValue instanceof \DateTime) {
                     $properties[$propertyName] = '<b>' . $propertyName . '</b>: ' . $propertyValue->format('Y-m-d H:i');
                 } elseif (is_array($propertyValue)) {
                     $properties[$propertyName] = '<b>' . $propertyName . '</b>: ' . 'array';
                 } elseif ($propertyValue instanceof NodeInterface) {
                     $properties[$propertyName] = '<b>' . $propertyName . '</b>: ' . $propertyValue->getIdentifier();
                 } else {
-                    $properties[$propertyName] = '<b>' . $propertyName . '</b>: ' . (string)$propertyValue;
+                    $properties[$propertyName] = '<b>' . $propertyName . '</b>: ' . $propertyValue;
                 }
             }
 

Classes/Driver/AbstractIndexerDriver.php

@@ -65,7 +65,7 @@ protected function findClosestFulltextRoot(NodeInterface $node): ?NodeInterface
             if ($closestFulltextNode === null) {
                 // root of hierarchy, no fulltext root found anymore, abort silently...
                 if ($node->getPath() !== '/' && $node->getPath() !== '/sites') {
-                    $this->logger->warning(sprintf('NodeIndexer: No fulltext root found for node %s', (string)$node), LogEnvironment::fromMethodName(__METHOD__));
+                    $this->logger->warning(sprintf('NodeIndexer: No fulltext root found for node %s', $node), LogEnvironment::fromMethodName(__METHOD__));
                 }
 
                 return null;

Classes/Driver/AbstractNodeTypeMappingBuilder.php

@@ -54,7 +54,7 @@ abstract class AbstractNodeTypeMappingBuilder implements NodeTypeMappingBuilderI
     /**
      * Called by the Flow object framework after creating the object and resolving all dependencies.
      *
-     * @param integer $cause Creation cause
+     * @param int $cause Creation cause
      * @throws InvalidConfigurationTypeException
      */
     public function initializeObject($cause): void

Classes/Driver/AbstractQuery.php

@@ -278,7 +278,7 @@ protected function prepareRequest(): array
      * All methods are considered safe
      *
      * @param string $methodName
-     * @return boolean
+     * @return bool
      */
     public function allowsCallOfMethod($methodName)
     {

Classes/Driver/DocumentDriverInterface.php

@@ -14,9 +14,7 @@
  * source code.
  */
 
-use Flowpack\ElasticSearch\Domain\Model\Index;
 use Neos\ContentRepository\Domain\Model\NodeInterface;
-use Neos\ContentRepository\Domain\Model\NodeType;
 
 /**
  * Elasticsearch Document Driver Interface

Classes/Driver/NodeTypeMappingBuilderInterface.php

@@ -15,6 +15,7 @@
  */
 
 use Flowpack\ElasticSearch\Domain\Model\Index;
+use Flowpack\ElasticSearch\Domain\Model\Mapping;
 use Flowpack\ElasticSearch\Mapping\MappingCollection;
 use Neos\Error\Messages\Result;
 
@@ -27,7 +28,7 @@ interface NodeTypeMappingBuilderInterface
      * Builds a Mapping Collection from the configured node types
      *
      * @param Index $index
-     * @return MappingCollection<\Flowpack\ElasticSearch\Domain\Model\Mapping>
+     * @return MappingCollection<Mapping>
      */
     public function buildMappingInformation(Index $index): MappingCollection;
 

Classes/Driver/QueryInterface.php

@@ -56,7 +56,7 @@ public function addSortFilter(array $configuration): void;
     /**
      * Set the size (limit) of the request
      *
-     * @param integer $size
+     * @param int $size
      * @return void
      * @api
      */
@@ -65,7 +65,7 @@ public function size(int $size): void;
     /**
      * Set the from (offset) of the request
      *
-     * @param integer $size
+     * @param int $size
      * @return void
      * @api
      */
@@ -95,7 +95,7 @@ public function simpleQueryStringFulltext(string $searchWord, array $options = [
      * Configure Result Highlighting. Only makes sense in combination with fulltext(). By default, highlighting is enabled.
      * It can be disabled by calling "highlight(FALSE)".
      *
-     * @param integer|boolean $fragmentSize The result fragment size for highlight snippets. If this parameter is FALSE, highlighting will be disabled.
+     * @param int|bool $fragmentSize The result fragment size for highlight snippets. If this parameter is FALSE, highlighting will be disabled.
      * @param int|null $fragmentCount The number of highlight fragments to show.
      * @param int $noMatchSize
      * @param string $field