Add consistency to method name

Author: ByScripts

README.md

@@ -8,15 +8,7 @@ Provides an easy way to get some entity/model behavior with static data
 
 ### Add the package in your composer.json
 
-```json
-{
-    "require": {
-        "byscripts/static-entity": "~1.0"
-    }
-}
-```
-
-Then run `composer update` (or `composer update byscripts/static-entity` if you don't want to update all your packages)
+At command line, run `composer require byscripts/static-entity:~2.0`
 
 ### Usage
 
@@ -122,28 +114,35 @@ $firefox->is(WebBrowser::FIREFOX);  // true
 WebBrowser::toId($firefox); // 2
 WebBrowser::toId(2);        // 2
 
-// The getIds() returns an array of ... well, ids.
+// The getIds() method returns an array of all ids present in data set
 WebBrowser::getIds(); // [1, 2, 3, 4, 5]
 
 // The getAssoc() returns an associative array with `id` as key and `name` as value
-WebBrowser::getAssoc(); // [1 => 'Chromium', 2 => 'Firefox', ...]
+WebBrowser::getAssociative(); // [1 => 'Chromium', 2 => 'Firefox', ...]
 
 // You can also pass the name of an argument you want to use as value
-WebBrowser::getAssoc('brand'); // [1 => 'Google', 2 => 'Mozilla', 3 => 'Microsoft', ...]
+WebBrowser::getAssociative('brand'); // [1 => 'Google', 2 => 'Mozilla', 3 => 'Microsoft', ...]
 
-// The getAll() method return an array containing all instances of entities
+// The getAll() method returns an array containing all instances of entities
 WebBrowser::getAll(); // [Object, Object, ...]
 
 // The exists() method check whether the passed ID exists in data set
-WebBrowser::exists(3); // true
-WebBrowser::exists(9); // false
+WebBrowser::hasId(3); // true
+WebBrowser::hasId(9); // false
 ```
 
 #### Alternative usage
 
-All static methods can be called indirectly from StaticEntity class by passing the desired class as last method argument.
+You can also directly use the StaticEntityBuilder to achieve same result
 
 ```
-StaticEntity::get(2, 'WebBrowser');
-StaticEntity::getAssoc('brand', 'WebBrowser');
+$builder = new StaticEntityBuilder('WebBrowser');
+
+$builder->get(WebBrowser::FIREFOX);
+$builder->getAssociative();
+$builder->getAssociative('other');
+$builder->getIds();
+$builder->getAll();
+$builder->hasId(WebBrowser::CHROMIUM);
+$builder->convertToId($instance);
 ```

src/StaticEntity.php

@@ -48,7 +48,7 @@ static public function get($identifier)
      *
      * @return bool Whether the ID exists or not
      */
-    static public function exists($id)
+    static public function hasId($id)
     {
         return self::getBuilder()->hasId($id);
     }
@@ -74,13 +74,9 @@ static public function getAll()
      *
      * @return array
      */
-    static public function getAssoc($valueKey = 'name')
+    static public function getAssociative($valueKey = 'name')
     {
-        if (empty($valueKey)) {
-            $valueKey = 'name';
-        }
-
-        return self::getBuilder()->getAssociativeArray($valueKey);
+        return self::getBuilder()->getAssociative($valueKey);
     }
 
     /**

src/StaticEntityBuilder.php

@@ -20,7 +20,7 @@ class StaticEntityBuilder
     private $class;
 
     private $instances = array();
-    private $ids = array();
+    private $ids       = array();
     private $dataSet;
 
     /**
@@ -50,10 +50,14 @@ public function get($id)
      * @return array
      * @throws \Exception
      */
-    public function getAssociativeArray($valueKey)
+    public function getAssociative($valueKey = 'name')
     {
         $this->initDataSet();
 
+        if (empty($valueKey)) {
+            $valueKey = 'name';
+        }
+
         return array_map(
             function ($arr) use ($valueKey) {
                 return $arr[$valueKey];
@@ -92,6 +96,25 @@ public function hasId($id)
         return in_array($id, $this->ids, true);
     }
 
+    /**
+     * @param mixed|StaticEntity $staticEntity
+     *
+     * @return mixed
+     * @throws \Exception
+     */
+    public function convertToId($staticEntity)
+    {
+        if ($staticEntity instanceof StaticEntity) {
+            return $staticEntity->getId();
+        } elseif (!$this->hasId($staticEntity)) {
+            throw new \Exception(
+                sprintf('Unable to convert "%s" to a valid id for class %s', $staticEntity, $this->class)
+            );
+        }
+
+        return $staticEntity;
+    }
+
     /**
      * @throws \Exception
      *
@@ -160,21 +183,4 @@ private function createInstance($id)
 
         $this->instances[$id] = $instance;
     }
-
-    /**
-     * @param mixed|StaticEntity $staticEntity
-     *
-     * @return mixed
-     * @throws \Exception
-     */
-    public function convertToId($staticEntity)
-    {
-        if ($staticEntity instanceof StaticEntity) {
-            return $staticEntity->getId();
-        } elseif (!$this->hasId($staticEntity)) {
-            throw new \Exception(sprintf('Unable to convert "%s" to a valid id for class %s', $staticEntity, $this->class));
-        }
-
-        return $staticEntity;
-    }
 }

tests/StaticEntityBuilderTest.php

@@ -141,15 +141,15 @@ public function testGetAllTwice()
     public function testGetAssoc()
     {
         $builder = new StaticEntityBuilder('\Byscripts\StaticEntity\Tests\Fixtures\Civility');
-        $assoc = $builder->getAssociativeArray('name');
+        $assoc = $builder->getAssociative('name');
 
         $this->assertArrayHasKey('mr', $assoc);
         $this->assertArrayHasKey('mrs', $assoc);
 
         $this->assertEquals('Mister', $assoc['mr']);
         $this->assertEquals('Misses', $assoc['mrs']);
 
-        $assoc = $builder->getAssociativeArray('shortName');
+        $assoc = $builder->getAssociative('shortName');
 
         $this->assertArrayHasKey('mr', $assoc);
         $this->assertArrayHasKey('mrs', $assoc);

tests/StaticEntityTest.php

@@ -71,11 +71,11 @@ public function testMissingProperty()
     public function testExists()
     {
         $this->assertTrue(
-            Civility::exists('mr')
+            Civility::hasId('mr')
         );
 
         $this->assertFalse(
-            Civility::exists('non-existent-id')
+            Civility::hasId('non-existent-id')
         );
     }
 
@@ -122,7 +122,7 @@ public function testGetAllTwice()
 
     public function testGetAssoc()
     {
-        $assoc = Civility::getAssoc();
+        $assoc = Civility::getAssociative();
 
         $this->assertArrayHasKey('mr', $assoc);
         $this->assertArrayHasKey('mrs', $assoc);
@@ -133,7 +133,7 @@ public function testGetAssoc()
 
     public function testGetAssocWithEmptyParam()
     {
-        $assoc = Civility::getAssoc(null);
+        $assoc = Civility::getAssociative(null);
 
         $this->assertArrayHasKey('mr', $assoc);
         $this->assertArrayHasKey('mrs', $assoc);
@@ -144,7 +144,7 @@ public function testGetAssocWithEmptyParam()
 
     public function testGetAssocWithParam()
     {
-        $assoc = Civility::getAssoc('shortName');
+        $assoc = Civility::getAssociative('shortName');
 
         $this->assertArrayHasKey('mr', $assoc);
         $this->assertArrayHasKey('mrs', $assoc);
@@ -184,7 +184,7 @@ public function testGetOnStaticEntityClass()
      */
     public function testExistsOnStaticEntityClass()
     {
-        StaticEntity::exists(1);
+        StaticEntity::hasId(1);
     }
 
     /**
@@ -202,7 +202,7 @@ public function testGetAllOnStaticEntityClass()
      */
     public function testGetAssocOnStaticEntityClass()
     {
-        StaticEntity::getAssoc();
+        StaticEntity::getAssociative();
     }
 
     /**