Merge pull request #52 from Flowpack/cleanup

[TASK] Clean up code

Author: kdambekalns

Classes/Flowpack/ElasticSearch/ContentRepositoryAdaptor/Command/NodeIndexCommandController.php

@@ -132,7 +132,7 @@ public function showMappingCommand() {
 	 * This command (re-)indexes all nodes contained in the content repository and sets the schema beforehand.
 	 *
 	 * @param integer $limit Amount of nodes to index at maximum
-	 * @param bool $update if TRUE, do not throw away the index at the start. Should *only be used for development*.
+	 * @param boolean $update if TRUE, do not throw away the index at the start. Should *only be used for development*.
 	 * @param string $workspace name of the workspace which should be indexed
 	 * @return void
 	 */
@@ -223,7 +223,7 @@ protected function indexWorkspace($workspaceName) {
 	 * @param array $dimensions
 	 * @return void
 	 */
-	protected function indexWorkspaceWithDimensions($workspaceName, $dimensions = array()) {
+	protected function indexWorkspaceWithDimensions($workspaceName, array $dimensions = array()) {
 		$context = $this->contextFactory->create(array('workspaceName' => $workspaceName, 'dimensions' => $dimensions));
 		$rootNode = $context->getRootNode();
 
@@ -241,6 +241,7 @@ protected function indexWorkspaceWithDimensions($workspaceName, $dimensions = ar
 
 	/**
 	 * @param \TYPO3\TYPO3CR\Domain\Model\Node $currentNode
+	 * @return void
 	 */
 	protected function traverseNodes(\TYPO3\TYPO3CR\Domain\Model\Node $currentNode) {
 

Classes/Flowpack/ElasticSearch/ContentRepositoryAdaptor/Indexer/NodeIndexer.php

@@ -135,7 +135,7 @@ public function getIndex() {
 	 * @param Node $node
 	 * @param string $targetWorkspaceName In case this is triggered during publishing, a workspace name will be passed in
 	 * @return void
-	 * @throws \Flowpack\ElasticSearch\ContentRepositoryAdaptor\Exception\IndexingException
+	 * @throws \TYPO3\TYPO3CR\Search\Exception\IndexingException
 	 */
 	public function indexNode(Node $node, $targetWorkspaceName = NULL) {
 		$contextPath = $node->getContextPath();
@@ -383,25 +383,25 @@ public function flush() {
 	 * Update the index alias
 	 *
 	 * @return void
-	 * @throws \Flowpack\ElasticSearch\ContentRepositoryAdaptor\Exception
+	 * @throws Exception
 	 * @throws \Flowpack\ElasticSearch\Transfer\Exception\ApiException
 	 * @throws \Exception
 	 */
 	public function updateIndexAlias() {
 		$aliasName = $this->searchClient->getIndexName(); // The alias name is the unprefixed index name
 		if ($this->getIndexName() === $aliasName) {
-			throw new \Flowpack\ElasticSearch\ContentRepositoryAdaptor\Exception('UpdateIndexAlias is only allowed to be called when $this->setIndexNamePostfix has been created.', 1383649061);
+			throw new Exception('UpdateIndexAlias is only allowed to be called when $this->setIndexNamePostfix has been created.', 1383649061);
 		}
 
 		if (!$this->getIndex()->exists()) {
-			throw new \Flowpack\ElasticSearch\ContentRepositoryAdaptor\Exception('The target index for updateIndexAlias does not exist. This shall never happen.', 1383649125);
+			throw new Exception('The target index for updateIndexAlias does not exist. This shall never happen.', 1383649125);
 		}
 
 		$aliasActions = array();
 		try {
 			$response = $this->searchClient->request('GET', '/*/_alias/' . $aliasName);
 			if ($response->getStatusCode() !== 200) {
-				throw new \Flowpack\ElasticSearch\ContentRepositoryAdaptor\Exception('The alias "' . $aliasName . '" was not found with some unexpected error... (return code: ' . $response->getStatusCode() . ')', 1383650137);
+				throw new Exception('The alias "' . $aliasName . '" was not found with some unexpected error... (return code: ' . $response->getStatusCode() . ')', 1383650137);
 			}
 
 			$indexNames = array_keys($response->getTreatedContent());
@@ -412,7 +412,7 @@ public function updateIndexAlias() {
 				if ($response->getStatusCode() === 200) {
 					$response = $this->searchClient->request('DELETE', '/' . $aliasName);
 					if ($response->getStatusCode() !== 200) {
-						throw new \Flowpack\ElasticSearch\ContentRepositoryAdaptor\Exception('The index "' . $aliasName . '" could not be removed to be replaced by an alias. (return code: ' . $response->getStatusCode() . ')', 1395419177);
+						throw new Exception('The index "' . $aliasName . '" could not be removed to be replaced by an alias. (return code: ' . $response->getStatusCode() . ')', 1395419177);
 					}
 				}
 			} else {

Documentation/Index.rst

@@ -9,21 +9,21 @@ TYPO3 Flow Package for indexing Nodes from TYPO3 Neos to ElasticSearch.
 Setup
 -----
 
-To be able indexing nodes into ElasticSearch there must be an index at all. This has to be 'neos'.
+To be able indexing nodes into ElasticSearch there must be an index at all.
 This can be created on console like this when the ElasticSearch Server is running::
 
-	curl -XPUT 'http://localhost:9200/neos/'
+	curl -XPUT 'http://localhost:9200/typo3cr/'
 
 Other wise you get an error message like this::
 
 	{
-		"error" : "IndexMissingException[[neos] missing]",
+		"error" : "IndexMissingException[[typo3cr] missing]",
 		"status" : 404
 	}
 
-To be sure that the 'neos' index was created use the following url in your browser::
+To be sure that the 'typo3cr' index was created use the following url in your browser::
 
-	http://localhost:9200/neos/_search?pretty
+	http://localhost:9200/typo3cr/_search?pretty
 
 The output should be like this::
 
@@ -41,3 +41,7 @@ The output should be like this::
 			"hits" : [ ]
 		}
 	}
+
+It is recommended to use an index name that corresponds to the project you are indexing to avoid
+clashes by using the same index in different projects. The index name can be changed in the
+settings.

composer.json

@@ -1,13 +1,12 @@
 {
     "name": "flowpack/elasticsearch-contentrepositoryadaptor",
     "type": "typo3-flow-package",
-    "description": "This package provides functionality for the interaction of elasticsearch engine and TYPO3CR.",
+    "description": "This package provides functionality for using Elasticsearch on top of TYPO3CR.Search",
     "homepage": "http://flowpack.org/",
     "license": ["LGPL-3.0+"],
     "require": {
         "flowpack/elasticsearch": "*",
         "typo3/eel": "*",
-        "typo3/typo3cr": "*",
         "typo3/typo3cr-search": "*"
     },
     "autoload": {