Expose the number of shards from the Index settings (#1331)

CHANGELOG.md

@@ -11,6 +11,7 @@ All notable changes to this project will be documented in this file based on the
 
 ### Added
  - Added getNumberOfReplicas() for index settings [PR#1324](https://github.com/ruflin/Elastica/pull/1324)
+ - Added getNumberOfShards() for index settings [PR#1321](https://github.com/ruflin/Elastica/pull/1331)
 
 ### Improvements
 

lib/Elastica/Index/Settings.php

@@ -24,6 +24,8 @@ class Settings
 
     const DEFAULT_NUMBER_OF_REPLICAS = 1;
 
+    const DEFAULT_NUMBER_OF_SHARDS = 5;
+
     /**
      * Response.
      *
@@ -153,6 +155,24 @@ public function getNumberOfReplicas()
         return $replicas;
     }
 
+    /**
+     * Returns the number of shards.
+     *
+     * If no number of shards is set, the default number is returned
+     *
+     * @return int The number of shards
+     */
+    public function getNumberOfShards()
+    {
+        $shards = $this->get('number_of_shards');
+
+        if (null === $shards) {
+            $shards = self::DEFAULT_NUMBER_OF_SHARDS;
+        }
+
+        return $shards;
+    }
+
     /**
      * Sets the index to read only.
      *

test/Elastica/Index/SettingsTest.php

@@ -103,6 +103,46 @@ public function testGetNumberOfReplicas()
         $index->delete();
     }
 
+    /**
+     * @group functional
+     */
+    public function testGetNumberOfShards()
+    {
+        $indexName = 'test';
+
+        $client = $this->_getClient();
+        $index = $client->getIndex($indexName);
+        $index->create(['index' => ['number_of_shards' => 1]], true);
+
+        $settings = $index->getSettings();
+
+        // Test with default number of replicas
+        $this->assertEquals(1, $settings->get('number_of_shards'));
+        $this->assertEquals(1, $settings->getNumberOfShards());
+
+        $index->delete();
+    }
+
+    /**
+     * @group functional
+     */
+    public function testGetDefaultNumberOfShards()
+    {
+        $indexName = 'test';
+
+        $client = $this->_getClient();
+        $index = $client->getIndex($indexName);
+        $index->create([], true);
+
+        $settings = $index->getSettings();
+
+        // Test with default number of shards
+        $this->assertEquals(IndexSettings::DEFAULT_NUMBER_OF_SHARDS, $settings->get('number_of_shards'));
+        $this->assertEquals(IndexSettings::DEFAULT_NUMBER_OF_SHARDS, $settings->getNumberOfShards());
+
+        $index->delete();
+    }
+
     /**
      * @group functional
      */