Adding the clear method to container classes

Author: nyamsprod

README.md

@@ -148,6 +148,7 @@ At any given time it is possible with each of these objects to:
 - tell whether the container is empty via an `isEmpty` method;
 - know the number of elements contained in the container via the `Countable` interface;
 - merge multiple instance of **the same type** using the `merge` method;
+- clear the container using the `clear` method;
 
 ```php
 use Bakame\Http\StructuredFields\Parameters;

src/Dictionary.php

@@ -225,6 +225,11 @@ public function delete(string ...$keys): void
         }
     }
 
+    public function clear(): void
+    {
+        $this->elements = [];
+    }
+
     public function append(string $key, InnerList|Item|ByteSequence|Token|bool|int|float|string $element): void
     {
         self::validateKey($key);

src/DictionaryTest.php

@@ -30,6 +30,8 @@ public function it_can_be_instantiated_with_an_collection_of_item_or_inner_list(
         );
 
         self::assertEquals($arrayParams, iterator_to_array($instance, true));
+        $instance->clear();
+        self::assertTrue($instance->isEmpty());
     }
 
     /**

src/InnerList.php

@@ -194,6 +194,11 @@ public function remove(int ...$indexes): void
         $this->elements = array_values($this->elements);
     }
 
+    public function clear(): void
+    {
+        $this->elements = [];
+    }
+
     public function merge(self ...$others): void
     {
         foreach ($others as $other) {

src/InnerListTest.php

@@ -26,6 +26,8 @@ public function it_can_be_instantiated_with_an_collection_of_item(): void
         self::assertFalse($instance->isEmpty());
 
         self::assertEquals($arrayParams, iterator_to_array($instance, true));
+        $instance->clear();
+        self::assertTrue($instance->isEmpty());
     }
 
     /**

src/OrderedList.php

@@ -164,6 +164,11 @@ public function remove(int ...$indexes): void
         $this->elements = array_values($this->elements);
     }
 
+    public function clear(): void
+    {
+        $this->elements = [];
+    }
+
     public function merge(self ...$others): void
     {
         foreach ($others as $other) {

src/OrderedListTest.php

@@ -67,15 +67,17 @@ public function it_can_add_or_remove_elements(): void
      */
     public function it_can_unshift_insert_and_replace(): void
     {
-        $container = OrderedList::fromElements();
-        $container->unshift(Item::from('42'));
-        $container->push(Item::from(42));
-        $container->insert(1, Item::from(42.0));
-        $container->replace(0, Item::from(ByteSequence::fromDecoded('Hello World')));
+        $instance = OrderedList::fromElements();
+        $instance->unshift(Item::from('42'));
+        $instance->push(Item::from(42));
+        $instance->insert(1, Item::from(42.0));
+        $instance->replace(0, Item::from(ByteSequence::fromDecoded('Hello World')));
 
-        self::assertCount(3, $container);
-        self::assertFalse($container->isEmpty());
-        self::assertSame(':SGVsbG8gV29ybGQ=:, 42.0, 42', $container->toHttpValue());
+        self::assertCount(3, $instance);
+        self::assertFalse($instance->isEmpty());
+        self::assertSame(':SGVsbG8gV29ybGQ=:, 42.0, 42', $instance->toHttpValue());
+        $instance->clear();
+        self::assertTrue($instance->isEmpty());
     }
 
     /**

src/Parameters.php

@@ -205,6 +205,11 @@ public function delete(string ...$keys): void
         }
     }
 
+    public function clear(): void
+    {
+        $this->elements = [];
+    }
+
     public function append(string $key, Item|ByteSequence|Token|bool|int|float|string $element): void
     {
         $element = self::filterElement($element);

src/ParametersTest.php

@@ -31,6 +31,8 @@ public function it_can_be_instantiated_with_an_collection_of_item(): void
         self::assertTrue($instance->has('string'));
 
         self::assertEquals($arrayParams, iterator_to_array($instance, true));
+        $instance->clear();
+        self::assertTrue($instance->isEmpty());
     }
 
     /**