minor #27929 [HttpFoundation] Fixed phpdoc for get method of HeaderBag (JanHort)

fabpot · fabpot · commit 3b90bc71c118 · 2018-07-12T08:13:53.000+02:00
This PR was submitted for the master branch but it was merged into the 2.8 branch instead (closes #27929). Discussion ---------- [HttpFoundation] Fixed phpdoc for get method of HeaderBag | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | none | License | MIT | Doc PR | none Method `\Symfony\Component\HttpFoundation\HeaderBag::get` return type was declared only as `string|string[]` but there is also possibility of returning of `null` value since the `null` is the default value for second parameter. Commits ------- a72f4ec [HttpFoundation] Fixed phpdoc for get method of HeaderBag
diff --git a/src/Symfony/Component/HttpFoundation/HeaderBag.php b/src/Symfony/Component/HttpFoundation/HeaderBag.php
@@ -101,11 +101,11 @@ public function add(array $headers)
     /**
      * Returns a header value by name.
      *
-     * @param string          $key     The header name
-     * @param string|string[] $default The default value
-     * @param bool            $first   Whether to return the first value or all header values
+     * @param string               $key     The header name
+     * @param string|string[]|null $default The default value
+     * @param bool                 $first   Whether to return the first value or all header values
      *
-     * @return string|string[] The first header value or default value if $first is true, an array of values otherwise
+     * @return string|string[]|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)
     {

Original file line number	Diff line number	Diff line change
`@@ -101,11 +101,11 @@ public function add(array $headers)`
`101`	`101`	`/**`
`102`	`102`	`* Returns a header value by name.`
`103`	`103`	`*`
`104`		`- * @param string $key The header name`
`105`		`- * @param string\|string[] $default The default value`
`106`		`- * @param bool $first Whether to return the first value or all header values`
	`104`	`+ * @param string $key The header name`
	`105`	`+ * @param string\|string[]\|null $default The default value`
	`106`	`+ * @param bool $first Whether to return the first value or all header values`
`107`	`107`	`*`
`108`		`- * @return string\|string[] The first header value or default value if $first is true, an array of values otherwise`
	`108`	`+ * @return string\|string[]\|null The first header value or default value if $first is true, an array of values otherwise`
`109`	`109`	`*/`
`110`	`110`	`public function get($key, $default = null, $first = true)`
`111`	`111`	`{`