TASK: Code cleanup and clearify some interfaces with type hints

Author: daniellienert

Classes/Client/ClientFactory.php

@@ -32,6 +32,7 @@ class ClientFactory
      * Create a client
      *
      * @return Client
+     * @throws \Flowpack\ElasticSearch\Exception
      */
     public function create()
     {

Classes/Command/NodeIndexCommandController.php

@@ -27,6 +27,8 @@
 use Neos\Flow\Annotations as Flow;
 use Neos\Flow\Cli\CommandController;
 use Neos\Flow\Configuration\ConfigurationManager;
+use Neos\Flow\Configuration\Exception\InvalidConfigurationTypeException;
+use Neos\Flow\Mvc\Exception\StopActionException;
 use Neos\Flow\ObjectManagement\ObjectManagerInterface;
 use Neos\Neos\Controller\CreateContentContextTrait;
 use Symfony\Component\Yaml\Yaml;
@@ -105,6 +107,7 @@ class NodeIndexCommandController extends CommandController
      * Called by the Flow object framework after creating the object and resolving all dependencies.
      *
      * @param integer $cause Creation cause
+     * @throws InvalidConfigurationTypeException
      */
     public function initializeObject($cause)
     {
@@ -154,6 +157,7 @@ public function showMappingCommand()
      * @param string $identifier
      * @param string $workspace
      * @return void
+     * @throws StopActionException
      */
     public function indexNodeCommand($identifier, $workspace = null)
     {
@@ -221,6 +225,7 @@ public function indexNodeCommand($identifier, $workspace = null)
      * @param string $workspace name of the workspace which should be indexed
      * @param string $postfix Index postfix, index with the same postfix will be deleted if exist
      * @return void
+     * @throws StopActionException
      */
     public function buildCommand($limit = null, $update = false, $workspace = null, $postfix = null)
     {
@@ -312,7 +317,7 @@ public function cleanupCommand()
      * @param string $postfix
      * @return void
      */
-    protected function createNewIndex($postfix)
+    protected function createNewIndex(string $postfix)
     {
         $this->nodeIndexer->setIndexNamePostfix($postfix ?: time());
         if ($this->nodeIndexer->getIndex()->exists() === true) {

Classes/Command/NodeTypeCommandController.php

@@ -11,6 +11,8 @@
  * source code.
  */
 
+use Neos\ContentRepository\Domain\Service\NodeTypeManager;
+use Neos\ContentRepository\Exception\NodeTypeNotFoundException;
 use Neos\Flow\Annotations as Flow;
 use Neos\Flow\Cli\CommandController;
 
@@ -25,7 +27,7 @@ class NodeTypeCommandController extends CommandController
 {
     /**
      * @Flow\Inject
-     * @var \Neos\ContentRepository\Domain\Service\NodeTypeManager
+     * @var NodeTypeManager
      */
     protected $nodeTypeManager;
 
@@ -34,6 +36,7 @@ class NodeTypeCommandController extends CommandController
      *
      * @param string $nodeType the node type to optionally filter for
      * @return void
+     * @throws NodeTypeNotFoundException
      */
     public function showCommand($nodeType = null)
     {

Classes/Driver/AbstractNodeTypeMappingBuilder.php

@@ -69,7 +69,7 @@ public function initializeObject($cause)
      * @param string $nodeTypeName
      * @return string
      */
-    public function convertNodeTypeNameToMappingName($nodeTypeName)
+    public function convertNodeTypeNameToMappingName(string $nodeTypeName): string
     {
         return str_replace('.', '-', $nodeTypeName);
     }

Classes/Driver/IndexDriverInterface.php

@@ -19,18 +19,18 @@ interface IndexDriverInterface
     /**
      * Get the list of Indexes attached to the given alias
      *
-     * @param $alias
+     * @param string $alias
      * @return array
      */
-    public function indexesByAlias($alias);
+    public function indexesByAlias(string $alias);
 
     /**
      * Remove alias by name
      *
      * @param string $index
      * @return void
      */
-    public function deleteIndex($index);
+    public function deleteIndex(string $index);
 
     /**
      * Execute batch aliases actions

Classes/Driver/IndexerDriverInterface.php

@@ -28,7 +28,7 @@ interface IndexerDriverInterface
      * @param array $documentData
      * @return array
      */
-    public function document($indexName, NodeInterface $node, ElasticSearchDocument $document, array $documentData);
+    public function document(string $indexName, NodeInterface $node, ElasticSearchDocument $document, array $documentData);
 
     /**
      * Generate the query to index the fulltext of the document

Classes/Driver/NodeTypeMappingBuilderInterface.php

@@ -27,7 +27,7 @@ interface NodeTypeMappingBuilderInterface
      * @param string $nodeTypeName
      * @return string
      */
-    public function convertNodeTypeNameToMappingName($nodeTypeName);
+    public function convertNodeTypeNameToMappingName(string $nodeTypeName): string;
 
     /**
      * Builds a Mapping Collection from the configured node types

Classes/Driver/Version1/DocumentDriver.php

@@ -50,6 +50,7 @@ public function delete(NodeInterface $node, $identifier)
 
     /**
      * {@inheritdoc}
+     * @throws \Flowpack\ElasticSearch\Exception
      */
     public function deleteDuplicateDocumentNotMatchingType(Index $index, $documentIdentifier, NodeType $nodeType)
     {

Classes/Driver/Version1/IndexDriver.php

@@ -33,8 +33,9 @@ public function aliasActions(array $actions)
 
     /**
      * {@inheritdoc}
+     * @throws Exception
      */
-    public function deleteIndex($index)
+    public function deleteIndex(string $index)
     {
         $response = $this->searchClient->request('HEAD', '/' . $index);
         if ($response->getStatusCode() === 200) {
@@ -47,8 +48,9 @@ public function deleteIndex($index)
 
     /**
      * {@inheritdoc}
+     * @throws Exception
      */
-    public function indexesByAlias($alias)
+    public function indexesByAlias(string $alias)
     {
         $response = $this->searchClient->request('GET', '/_alias/' . $alias);
         if ($response->getStatusCode() !== 200 && $response->getStatusCode() !== 404) {

Classes/Driver/Version1/IndexerDriver.php

@@ -34,7 +34,7 @@ class IndexerDriver extends AbstractIndexerDriver implements IndexerDriverInterf
     /**
      * {@inheritdoc}
      */
-    public function document($indexName, NodeInterface $node, ElasticSearchDocument $document, array $documentData)
+    public function document(string $indexName, NodeInterface $node, ElasticSearchDocument $document, array $documentData)
     {
         if ($this->isFulltextRoot($node)) {
             // for fulltext root documents, we need to preserve the "__fulltext" field. That's why we use the