[HttpFoundation] add HeaderBag::getFirst and HeaderBag::getAll

Simperfit · Simperfit · commit e9544ef1542e · 2019-06-20T21:59:08.000+02:00
diff --git a/src/Symfony/Component/HttpFoundation/HeaderBag.php b/src/Symfony/Component/HttpFoundation/HeaderBag.php
@@ -105,26 +105,44 @@ public function add(array $headers)
      * @param string|null $default The default value
      * @param bool        $first   Whether to return the first value or all header values
      *
-     * @return string|string[]|null The first header value or default value if $first is true, an array of values otherwise
+     * @return string|string[]|int|null The first header value or default value if $first is true, an array of values otherwise
      */
     public function get($key, $default = null, $first = true)
+    {
+        // do we trigger an deprecation ?
+        // @trigger_error(sprintf('%s::%s is deprecated since Symfony 4.4, use %s::getFirst() or %s::getAll() instead.', __CLASS__, __METHOD__, __CLASS__, __CLASS__), E_USER_DEPRECATED);
+        if ($first === true) {
+            return $this->getFirst($key, $default);
+        }
+
+        return $this->getAll($key, $default);
+    }
+
+    public function getFirst($key, $default = null)
+    {
+        $all = $this->getAll($key, $default);
+
+        if (\count($all))  {
+            return isset($all[0]) ? $all[0] : null;
+        }
+
+        return $default;
+    }
+
+    public function getAll($key, $default = null): array
     {
         $key = str_replace('_', '-', strtolower($key));
         $headers = $this->all();
 
         if (!\array_key_exists($key, $headers)) {
             if (null === $default) {
-                return $first ? null : [];
+                return [];
             }
 
-            return $first ? $default : [$default];
+            return [$default];
         }
-
-        if ($first) {
-            return \count($headers[$key]) ? $headers[$key][0] : $default;
-        }
-
         return $headers[$key];
+
     }
 
     /**
diff --git a/src/Symfony/Component/HttpFoundation/Tests/HeaderBagTest.php b/src/Symfony/Component/HttpFoundation/Tests/HeaderBagTest.php
@@ -93,10 +93,15 @@ public function testGet()
         // defaults
         $this->assertNull($bag->get('none'), '->get unknown values returns null');
         $this->assertEquals('default', $bag->get('none', 'default'), '->get unknown values returns default');
+        $this->assertEquals($bag->getFirst('none', 'default'), $bag->get('none', 'default'), '->get unknown values returns default as array');
+
         $this->assertEquals(['default'], $bag->get('none', 'default', false), '->get unknown values returns default as array');
+        $this->assertEquals($bag->getAll('none', 'default'), $bag->get('none', 'default', false), '->get unknown values returns default as array');
 
         $bag->set('foo', 'bor', false);
         $this->assertEquals('bar', $bag->get('foo'), '->get return first value');
+        $this->assertEquals($bag->getAll('foo', 'nope'), $bag->get('foo', 'nope', false), '->get return all values as array');
+
         $this->assertEquals(['bar', 'bor'], $bag->get('foo', 'nope', false), '->get return all values as array');
     }
 
