Adding Parameters value related methods

Author: nyamsprod

CHANGELOG.md

@@ -11,8 +11,10 @@ All Notable changes to `bakame/http-strucured-fields` will be documented in this
 - `InnerList::from` named constructor which accepts a variadic list of members items
 - `OrderedList::from` named constructor which accepts a variadic list of members items
 - `Token::fromString` named constructor which accepts `string` and `Stringable` object
+- `Parameter::values` returns an array of all the values contained inside the `Parameters` instance
 - [BC Break] `InnerList::fromList` to replace `InnerList::fromMembers`
 - [BC Break] `OrderedList::fromList` to replace `OrderedList::fromMembers`
+- [BC Break] `Parameter::value` to replace `InnerList::parameter` and `Item::parameter`
 
 ### Fixed
 
@@ -28,8 +30,10 @@ All Notable changes to `bakame/http-strucured-fields` will be documented in this
 
 ### Removed
 
-- [BC Break] `InnerList::fromMembers` to replace `InnerList::fromList`
-- [BC Break] `OrderedList::fromMembers` to replace `OrderedList::fromList`
+- [BC Break] `InnerList::fromMembers` replaced by `InnerList::fromList`
+- [BC Break] `OrderedList::fromMembers` replaced by `OrderedList::fromList`
+- [BC Break] `Item::parameter` replaced by `Parameter::value`
+- [BC Break] `InnerList::parameter` replaced by `Parameter::value`
 
 ## [0.1.0] - 2022-03-18
 

README.md

@@ -189,6 +189,7 @@ key to its members as such they expose the following methods:
 - `append` always add an element at the end of the container, if already present the previous value is removed;
 - `prepend` always add an element at the beginning of the container, if already present the previous value is removed;
 - `delete` to remove elements based on their associated keys;
+- `keys` to list all existing keys for the ordered maps as an array list;
 
 ```php
 use Bakame\Http\StructuredFields\Dictionary;
@@ -215,6 +216,25 @@ echo $dictionary->toHttpValue(); //returns "a=?0, z=42.0"
 - `Parameters` can only contains `Item` instances 
 - `Dictionary` instance can contain `Item` and `InnerList` instances.
 
+The `Parameters` instance exposes the following methods:
+
+- `Parameters::values` to list all existing Bare Items value as an array list;
+- `Parameters::value($key)` to return the value of the Bare Item associated to the `$key` or throw if the key is unknown or invalid;
+
+```php
+use Bakame\Http\StructuredFields\Parameters;
+use Bakame\Http\StructuredFields\Item;
+use Bakame\Http\StructuredFields\Token;
+
+$parameters = Parameters::fromAssociative(['b' => true, 'foo' => 'bar']);
+$parameters->keys(); // returns ['b', 'foo']
+$parameters->values(); // returns [true, 'bar']
+$parameters->value('b'); // returns true
+$parameters->get('b'); // returns Item::from(true)
+iterator_to_array($parameters->toPairs(), true); // returns [['b', Item::from(true)], ['foo', Item::from('bar')]]
+iterator_to_array($parameters, true); // returns ['b' => Item::from(true), 'foo' => Item::from('bar')]
+```
+
 #### Lists
 
 The `OrderedList` and the `InnerList` classes are list of members 
@@ -264,8 +284,8 @@ use Bakame\Http\StructuredFields\InnerList;
 use Bakame\Http\StructuredFields\Parameters;
 
 $innerList = InnerList::fromList([42, 42.0, "42"], ["a" => true]);
-$innerList->parameter('a'); //returns true
 $innerList->parameters();   //returns a Parameters object
+$innerList->parameters()->value('a'); // returns true
 ```
 
 Contributing

src/InnerList.php

@@ -74,11 +74,6 @@ public function parameters(): Parameters
         return $this->parameters;
     }
 
-    public function parameter(string $key): Item|Token|ByteSequence|float|int|bool|string
-    {
-        return $this->parameters->get($key)->value();
-    }
-
     /**
      * @param Parameters|iterable<array-key, Item|Token|ByteSequence|float|int|bool|string> $parameters
      */

src/InnerListTest.php

@@ -176,7 +176,7 @@ public function it_can_access_its_parameter_values(): void
     {
         $instance = InnerList::fromList([false], ['foo' => 'bar']);
 
-        self::assertSame('bar', $instance->parameter('foo'));
+        self::assertSame('bar', $instance->parameters()->value('foo'));
     }
 
     /**
@@ -187,7 +187,7 @@ public function it_fails_to_access_unknown_parameter_values(): void
         $this->expectException(InvalidOffset::class);
 
         $instance = InnerList::fromList([false], ['foo' => 'bar']);
-        $instance->parameter('bar');
+        $instance->parameters()->value('bar');
     }
 
     /**
@@ -202,6 +202,6 @@ public function it_can_exchange_parameters(): void
         $instance->exchangeParameters(['foo' => 'bar']);
 
         self::assertCount(1, $instance->parameters());
-        self::assertSame('bar', $instance->parameter('foo'));
+        self::assertSame('bar', $instance->parameters()->value('foo'));
     }
 }

src/Item.php

@@ -273,11 +273,6 @@ public function parameters(): Parameters
         return $this->parameters;
     }
 
-    public function parameter(string $key): Item|Token|ByteSequence|float|int|bool|string
-    {
-        return $this->parameters->get($key)->value();
-    }
-
     /**
      * @param Parameters|iterable<array-key, Item|Token|ByteSequence|float|int|bool|string> $parameters
      */

src/ItemTest.php

@@ -228,7 +228,7 @@ public function it_can_access_its_parameter_values(): void
     {
         $instance = Item::fromHttpValue('1; a; b=?0');
 
-        self::assertTrue($instance->parameter('a'));
+        self::assertTrue($instance->parameters()->value('a'));
     }
 
     /**
@@ -239,7 +239,7 @@ public function it_fails_to_access_unknown_parameter_values(): void
         $this->expectException(InvalidOffset::class);
 
         $instance = Item::fromHttpValue('1; a; b=?0');
-        $instance->parameter('bar');
+        $instance->parameters()->value('bar');
     }
 
     /**
@@ -254,6 +254,6 @@ public function it_can_exchange_parameters(): void
         $instance->exchangeParameters(['foo' => 'bar']);
 
         self::assertCount(1, $instance->parameters());
-        self::assertSame('bar', $instance->parameter('foo'));
+        self::assertSame('bar', $instance->parameters()->value('foo'));
     }
 }

src/Parameters.php

@@ -160,6 +160,25 @@ public function keys(): array
         return array_keys($this->members);
     }
 
+    /**
+     * @return array<string, Token|ByteSequence|float|int|bool|string>
+     */
+    public function values(): array
+    {
+        return array_map(fn (Item $item): Token|ByteSequence|float|int|bool|string => $item->value(), $this->members);
+    }
+
+    public function value(string $key): Token|ByteSequence|float|int|bool|string
+    {
+        self::validateKey($key);
+
+        if (!array_key_exists($key, $this->members)) {
+            throw InvalidOffset::dueToKeyNotFound($key);
+        }
+
+        return $this->members[$key]->value();
+    }
+
     public function has(string $key): bool
     {
         return array_key_exists($key, $this->members);

src/ParametersTest.php

@@ -232,4 +232,18 @@ public function it_can_be_regenerated_with_eval(): void
 
         self::assertEquals($instance, $generatedInstance);
     }
+
+    /**
+     * @test
+     */
+    public function it_can_return_bare_items_values(): void
+    {
+        $instance = Parameters::fromAssociative([
+            'string' => Item::from('helloWorld'),
+            'boolean' => Item::from(true),
+        ]);
+
+        self::assertSame('helloWorld', $instance->value('string'));
+        self::assertSame(['string' => 'helloWorld', 'boolean' => true], $instance->values());
+    }
 }

src/SupportsParameters.php

@@ -8,11 +8,5 @@ interface SupportsParameters
 {
     public function parameters(): Parameters;
 
-    /**
-     * @throws SyntaxError   if the key used is invalid according to RFC8941
-     * @throws InvalidOffset If no value is found for the given key
-     */
-    public function parameter(string $key): Item|Token|ByteSequence|float|int|bool|string;
-
     public function exchangeParameters(Parameters $parameters): void;
 }