Added methods for arrays.

Author: prwater

src/TypedConfig.php

@@ -21,7 +21,6 @@ class TypedConfig
   private $config;
 
   //--------------------------------------------------------------------------------------------------------------------
-
   /**
    * TypedConfig constructor.
    *
@@ -58,6 +57,28 @@ public function getConfig(): Config
     return $this->config;
   }
 
+  //--------------------------------------------------------------------------------------------------------------------
+  /**
+   * Returns the value of a mandatory nested configuration setting.
+   *
+   * @param string     $key     The key of the configuration setting. The key might be nested using dot notation.
+   * @param array|null $default The default value.
+   *
+   * @return array
+   *
+   * @throws TypedConfigException
+   */
+  public function getManArray(string $key, ?array $default = null): array
+  {
+    $value = $this->config->get($key, $default);
+    if (is_array($value))
+    {
+      return $value;
+    }
+
+    throw self::createException($key, 'array', $value);
+  }
+
   //--------------------------------------------------------------------------------------------------------------------
   /**
    * Returns the value of a mandatory boolean configuration setting.
@@ -178,6 +199,28 @@ public function getManString(string $key, ?string $default = null): string
     }
   }
 
+  //--------------------------------------------------------------------------------------------------------------------
+  /**
+   * Returns the value of an optional nested configuration setting.
+   *
+   * @param string     $key     The key of the configuration setting. The key might be nested using dot notation.
+   * @param array|null $default The default value.
+   *
+   * @return array|null
+   *
+   * @throws TypedConfigException
+   */
+  public function getOptArray(string $key, ?array $default = null): ?array
+  {
+    $value = $this->config->get($key, $default);
+    if ($value===null || is_array($value))
+    {
+      return $value;
+    }
+
+    throw self::createException($key, 'array', $value);
+  }
+
   //--------------------------------------------------------------------------------------------------------------------
   /**
    * Returns the value of an optional boolean configuration setting.

src/TypedConfigException.php

@@ -40,7 +40,7 @@ private static function message(string $key, string $type, $value): string
       return sprintf("Empty mandatory %s value found for key '%s'", $type, $key);
     }
 
-    $a = ($type=='integer') ? 'an' : 'a';
+    $a = (in_array($type, ['array', 'integer'])) ? 'an' : 'a';
 
     if (Cast::isManString($value))
     {

test/TypedConfigTest.php

@@ -28,6 +28,21 @@ class TypedConfigTest extends TestCase
    */
   private $typeConfig;
 
+  //--------------------------------------------------------------------------------------------------------------------
+  /**
+   * Data provider for invalid mandatory arrays.
+   *
+   * @return array
+   */
+  public function invalidManArrayCases(): array
+  {
+    $cases = $this->invalidOptArrayCases();
+
+    $cases[] = ['null.array', null];
+
+    return $cases;
+  }
+
   //--------------------------------------------------------------------------------------------------------------------
   /**
    * Data provider for invalid mandatory booleans.
@@ -103,6 +118,17 @@ public function invalidManStringCases(): array
     return $cases;
   }
 
+  //--------------------------------------------------------------------------------------------------------------------
+  /**
+   * Data provider for invalid optional arrays.
+   *
+   * @return array
+   */
+  public function invalidOptArrayCases(): array
+  {
+    return [['invalid.array', null]];
+  }
+
   //--------------------------------------------------------------------------------------------------------------------
   /**
    * Data provider for invalid optional booleans.
@@ -178,6 +204,21 @@ public function testGetConfig(): void
     self::assertSame($this->config, $this->typeConfig->getConfig());
   }
 
+  //--------------------------------------------------------------------------------------------------------------------
+  /**
+   * Test case for invalid mandatory array.
+   *
+   * @param string     $key     The key.
+   * @param array|null $default The default value.
+   *
+   * @dataProvider invalidManArrayCases
+   */
+  public function testInvalidArrayBool(string $key, ?array $default): void
+  {
+    $this->expectException(TypedConfigException::class);
+    $this->typeConfig->getManArray($key, $default);
+  }
+
   //--------------------------------------------------------------------------------------------------------------------
   /**
    * Test case for invalid mandatory boolean.
@@ -253,6 +294,21 @@ public function testInvalidManString(string $key, ?int $default): void
     $this->typeConfig->getManString($key, $default);
   }
 
+  //--------------------------------------------------------------------------------------------------------------------
+  /**
+   * Test case for invalid optional array.
+   *
+   * @param string     $key     The key.
+   * @param array|null $default The default value.
+   *
+   * @dataProvider invalidOptArrayCases
+   */
+  public function testInvalidOptArray(string $key, ?array $default): void
+  {
+    $this->expectException(TypedConfigException::class);
+    $this->typeConfig->getOptArray($key, $default);
+  }
+
   //--------------------------------------------------------------------------------------------------------------------
   /**
    * Test case for invalid optional boolean.
@@ -344,6 +400,22 @@ public function testValidInt(string $key, ?int $default, ?int $expected): void
     self::assertSame($value, $expected);
   }
 
+  //--------------------------------------------------------------------------------------------------------------------
+  /**
+   * Test case for mandatory array.
+   *
+   * @param string     $key      The key.
+   * @param array|null $default  The default value.
+   * @param array|null $expected The expected value.
+   *
+   * @dataProvider validManArrayCases
+   */
+  public function testValidManArray(string $key, ?array $default, ?array $expected): void
+  {
+    $value = $this->typeConfig->getManArray($key, $default);
+    self::assertSame($value, $expected);
+  }
+
   //--------------------------------------------------------------------------------------------------------------------
   /**
    * Test case for mandatory boolean.
@@ -392,6 +464,22 @@ public function testValidManFloat(string $key, ?float $default, ?float $expected
     self::assertSame($value, $expected);
   }
 
+  //--------------------------------------------------------------------------------------------------------------------
+  /**
+   * Test case for optional array.
+   *
+   * @param string     $key      The key.
+   * @param array|null $default  The default value.
+   * @param array|null $expected The expected value.
+   *
+   * @dataProvider validOptArrayCases
+   */
+  public function testValidOptArray(string $key, ?array $default, ?array $expected): void
+  {
+    $value = $this->typeConfig->getOptArray($key, $default);
+    self::assertSame($value, $expected);
+  }
+
   //--------------------------------------------------------------------------------------------------------------------
   /**
    * Test case for optional boolean.
@@ -488,6 +576,18 @@ public function testValidString(string $key, ?string $default, ?string $expected
     self::assertSame($value, $expected);
   }
 
+  //--------------------------------------------------------------------------------------------------------------------
+  /**
+   * Data provider for valid mandatory arrays.
+   *
+   * @return array
+   */
+  public function validManArrayCases(): array
+  {
+    return [['valid-array', null, ['one' => '1', 'two' => '2', 'three' => '3']],
+            ['null.array', [], []]];
+  }
+
   //--------------------------------------------------------------------------------------------------------------------
   /**
    * Data provider for valid mandatory booleans.
@@ -551,6 +651,21 @@ public function validManStringCases(): array
             ['null.string', 'default', 'default']];
   }
 
+  //--------------------------------------------------------------------------------------------------------------------
+  /**
+   * Data provider for valid optional arrays.
+   *
+   * @return array
+   */
+  public function validOptArrayCases(): array
+  {
+    $cases = $this->validManArrayCases();
+
+    $cases[] = ['null.array', null, null];
+
+    return $cases;
+  }
+
   //--------------------------------------------------------------------------------------------------------------------
   /**
    * Data provider for valid optional booleans.

test/test.ini

@@ -6,8 +6,14 @@ integer = 123
 string = "Hello, world!"
 
 [invalid]
+array = not an array
 bool = not a boolean
 finite-float = not a float
 float = not a float
 integer = not an integer
 string = replace with handle
+
+[valid-array]
+one = 1
+two = 2
+three = 3