Merge pull request #31 from yii2mod/feature-add-get-all-settings-method

Add getAllBySection method to the Settings component

README.md

@@ -102,6 +102,9 @@ $settings->remove('section', 'key');
 // Removes all settings
 $settings->removeAll();
 
+// Get's all values in the specific section.
+$settings->getAllBySection('admin');
+
 $settings->invalidateCache(); // automatically called on set(), remove();
 ```
 

components/Settings.php

@@ -66,6 +66,27 @@ public function init()
         $this->model = Yii::createObject($this->modelClass);
     }
 
+    /**
+     * Get's all values in the specific section.
+     *
+     * @param string $section
+     * @param null $default
+     *
+     * @return mixed
+     */
+    public function getAllBySection($section, $default = null)
+    {
+        $items = $this->getSettingsConfig();
+
+        if (isset($items[$section])) {
+            $this->setting = ArrayHelper::getColumn($items[$section], 'value');
+        } else {
+            $this->setting = $default;
+        }
+
+        return $this->setting;
+    }
+
     /**
      * Get's the value for the given section and key.
      *

tests/SettingsTest.php

@@ -23,6 +23,21 @@ public function testSetAndGetSetting()
         $this->assertEquals('[email protected]', Yii::$app->settings->get('admin', 'email'), 'Wrong setting name!');
     }
 
+    public function testGetAllSettingsBySection()
+    {
+        Yii::$app->settings->set('admin', 'email', '[email protected]');
+        Yii::$app->settings->set('admin', 'username', 'admin');
+        Yii::$app->settings->set('admin', 'website', 'http://example.org');
+
+        $settings = Yii::$app->settings->getAllBySection('admin');
+
+        $this->assertCount(3, $settings, 'Wrong settings count!');
+        $this->assertEquals('[email protected]', $settings['email']);
+        $this->assertEquals('admin', $settings['username']);
+        $this->assertEquals('http://example.org', $settings['website']);
+        $this->assertNull(Yii::$app->settings->getAllBySection('not-existed'));
+    }
+
     public function testRemoveSetting()
     {
         Yii::$app->settings->set('admin', 'email', '[email protected]');