Nicer syntax through the helper. Fixes #3

Author: lonnieezell

README.md

@@ -67,7 +67,13 @@ or telling your BaseController to always load it.
 
 ```php
 helper('setting');
-$name = setting('App', 'siteName');
+
+// Using 'dot' syntax to separate class and field name
+$name = setting('App.siteName');
+// Store a value
+setting('App.sitename', 'My Great Site');
+
+// Using the service through the helper
 $name = setting()->get('App', 'siteName');
 $setting()->set('App', 'siteName', 'My Great Site');
 ```

src/Helpers/setting_helper.php

@@ -1,21 +1,45 @@
 <?php
 
-if (! function_exists('setting')) {
-    /**
-     * Provides a convenience interface to the
-     * Bonfire/Settings/Settings class.
-     *
-     * @param string|null $class
-     * @param string|null $field
-     */
-    function setting(string $class = null, string $field = null)
-    {
-        $setting = service('settings');
+if (! function_exists('setting'))
+{
+	/**
+	 * Provides a convenience interface to the
+	 * Bonfire/Settings/Settings class.
+	 *
+	 * @param string|null $field
+	 * @param null        $value
+	 *
+	 * @return mixed
+	 */
+	function setting(string $field = null, $value = null)
+	{
+		$setting = service('settings');
 
-        if (empty($class) || empty($field)) {
-            return $setting;
-        }
+		if (empty($field))
+		{
+			return $setting;
+		}
 
-        return $setting->get($class, $field);
-    }
+		// Parse the field name for class.field
+		$parts = explode('.', $field);
+
+		if (count($parts) === 1)
+		{
+			throw new \RuntimeException('$field must contain both the class and field name, i.e. Foo.bar');
+		}
+
+		[
+			$class,
+			$field,
+		] = $parts;
+
+		// Getting the value?
+		if ($value === null)
+		{
+			return $setting->get($class, $field);
+		}
+
+		// Setting the value
+		return $setting->set($class, $field, $value);
+	}
 }

tests/HelperTest.php

@@ -0,0 +1,74 @@
+<?php
+
+namespace CodeIgniter4\Tests;
+
+use CodeIgniter\I18n\Time;
+use CodeIgniter\Test\DatabaseTestTrait;
+use Sparks\Settings\Settings;
+use Tests\Support\TestCase;
+
+class HelperTest extends TestCase
+{
+	use DatabaseTestTrait;
+
+	protected $namespace = 'Sparks\Settings';
+	protected $refresh   = true;
+	protected $table;
+
+	public function setUp(): void
+	{
+		parent::setUp();
+
+		$this->table = config('Settings')->database['table'];
+		helper('setting');
+	}
+
+	public function testReturnsServiceByDefault()
+	{
+		$this->assertInstanceOf(Settings::class, setting());
+	}
+
+	public function testThrowsExceptionWithInvalidField()
+	{
+		$this->expectException(\RuntimeException::class);
+
+		setting('Foobar');
+	}
+
+	public function testReturnsValueDotArray()
+	{
+		$this->hasInDatabase($this->table, [
+			'class'      => 'Foo',
+			'key'        => 'bar',
+			'value'      => 'baz',
+			'type'       => 'string',
+			'created_at' => Time::now()->toDateTimeString(),
+			'updated_at' => Time::now()->toDateTimeString(),
+		]);
+
+		$this->assertEquals('baz', setting('Foo.bar'));
+	}
+
+	public function testSettingValueDotArray()
+	{
+		$this->hasInDatabase($this->table, [
+			'class'      => 'Foo',
+			'key'        => 'bar',
+			'value'      => 'baz',
+			'type'       => 'string',
+			'created_at' => Time::now()->toDateTimeString(),
+			'updated_at' => Time::now()->toDateTimeString(),
+		]);
+
+		setting('Foo.bar', false);
+
+		$this->seeInDatabase($this->table, [
+			'class' => 'Foo',
+			'key'   => 'bar',
+			'value' => '0',
+			'type'  => 'boolean',
+		]);
+
+		$this->assertSame(false, setting('Foo.bar'));
+	}
+}