[Config] fix return type declarations

derrabus · nicolas-grekas · commit 9c63be489e42 · 2019-08-26T09:52:57.000+02:00
diff --git a/src/Symfony/Component/Config/Definition/ArrayNode.php b/src/Symfony/Component/Config/Definition/ArrayNode.php
@@ -38,17 +38,13 @@ public function setNormalizeKeys($normalizeKeys)
     }
 
     /**
-     * Normalizes keys between the different configuration formats.
+     * {@inheritdoc}
      *
      * Namely, you mostly have foo_bar in YAML while you have foo-bar in XML.
      * After running this method, all keys are normalized to foo_bar.
      *
      * If you have a mixed key like foo-bar_moo, it will not be altered.
      * The key will also not be altered if the target key already exists.
-     *
-     * @param mixed $value
-     *
-     * @return array The value with normalized keys
      */
     protected function preNormalize($value)
     {
diff --git a/src/Symfony/Component/Config/Definition/BaseNode.php b/src/Symfony/Component/Config/Definition/BaseNode.php
@@ -49,21 +49,37 @@ public function __construct($name, NodeInterface $parent = null)
         $this->parent = $parent;
     }
 
+    /**
+     * @param string $key
+     */
     public function setAttribute($key, $value)
     {
         $this->attributes[$key] = $value;
     }
 
+    /**
+     * @param string $key
+     *
+     * @return mixed
+     */
     public function getAttribute($key, $default = null)
     {
         return isset($this->attributes[$key]) ? $this->attributes[$key] : $default;
     }
 
+    /**
+     * @param string $key
+     *
+     * @return bool
+     */
     public function hasAttribute($key)
     {
         return isset($this->attributes[$key]);
     }
 
+    /**
+     * @return array
+     */
     public function getAttributes()
     {
         return $this->attributes;
@@ -74,6 +90,9 @@ public function setAttributes(array $attributes)
         $this->attributes = $attributes;
     }
 
+    /**
+     * @param string $key
+     */
     public function removeAttribute($key)
     {
         unset($this->attributes[$key]);
@@ -92,7 +111,7 @@ public function setInfo($info)
     /**
      * Returns info message.
      *
-     * @return string The info text
+     * @return string|null The info text
      */
     public function getInfo()
     {
@@ -112,7 +131,7 @@ public function setExample($example)
     /**
      * Retrieves the example configuration for this node.
      *
-     * @return string|array The example
+     * @return string|array|null The example
      */
     public function getExample()
     {
diff --git a/src/Symfony/Component/Config/Definition/PrototypedArrayNode.php b/src/Symfony/Component/Config/Definition/PrototypedArrayNode.php
@@ -78,7 +78,7 @@ public function setKeyAttribute($attribute, $remove = true)
     /**
      * Retrieves the name of the attribute which value should be used as key.
      *
-     * @return string The name of the attribute
+     * @return string|null The name of the attribute
      */
     public function getKeyAttribute()
     {
diff --git a/src/Symfony/Component/Config/Util/XmlUtils.php b/src/Symfony/Component/Config/Util/XmlUtils.php
@@ -152,7 +152,7 @@ public static function loadFile($file, $schemaOrCallable = null)
      * @param \DOMElement $element     A \DOMElement instance
      * @param bool        $checkPrefix Check prefix in an element or an attribute name
      *
-     * @return array A PHP array
+     * @return mixed
      */
     public static function convertDomElementToArray(\DOMElement $element, $checkPrefix = true)
     {

Original file line number	Diff line number	Diff line change
`@@ -38,17 +38,13 @@ public function setNormalizeKeys($normalizeKeys)`
`38`	`38`	`}`
`39`	`39`
`40`	`40`	`/**`
`41`		`- * Normalizes keys between the different configuration formats.`
	`41`	`+ * {@inheritdoc}`
`42`	`42`	`*`
`43`	`43`	`* Namely, you mostly have foo_bar in YAML while you have foo-bar in XML.`
`44`	`44`	`* After running this method, all keys are normalized to foo_bar.`
`45`	`45`	`*`
`46`	`46`	`* If you have a mixed key like foo-bar_moo, it will not be altered.`
`47`	`47`	`* The key will also not be altered if the target key already exists.`
`48`		`- *`
`49`		`- * @param mixed $value`
`50`		`- *`
`51`		`- * @return array The value with normalized keys`
`52`	`48`	`*/`
`53`	`49`	`protected function preNormalize($value)`
`54`	`50`	`{`
Original file line number	Diff line number	Diff line change
`@@ -49,21 +49,37 @@ public function __construct($name, NodeInterface $parent = null)`
`49`	`49`	`$this->parent = $parent;`
`50`	`50`	`}`
`51`	`51`
	`52`	`+ /**`
	`53`	`+ * @param string $key`
	`54`	`+ */`
`52`	`55`	`public function setAttribute($key, $value)`
`53`	`56`	`{`
`54`	`57`	`$this->attributes[$key] = $value;`
`55`	`58`	`}`
`56`	`59`
	`60`	`+ /**`
	`61`	`+ * @param string $key`
	`62`	`+ *`
	`63`	`+ * @return mixed`
	`64`	`+ */`
`57`	`65`	`public function getAttribute($key, $default = null)`
`58`	`66`	`{`
`59`	`67`	`return isset($this->attributes[$key]) ? $this->attributes[$key] : $default;`
`60`	`68`	`}`
`61`	`69`
	`70`	`+ /**`
	`71`	`+ * @param string $key`
	`72`	`+ *`
	`73`	`+ * @return bool`
	`74`	`+ */`
`62`	`75`	`public function hasAttribute($key)`
`63`	`76`	`{`
`64`	`77`	`return isset($this->attributes[$key]);`
`65`	`78`	`}`
`66`	`79`
	`80`	`+ /**`
	`81`	`+ * @return array`
	`82`	`+ */`
`67`	`83`	`public function getAttributes()`
`68`	`84`	`{`
`69`	`85`	`return $this->attributes;`
`@@ -74,6 +90,9 @@ public function setAttributes(array $attributes)`
`74`	`90`	`$this->attributes = $attributes;`
`75`	`91`	`}`
`76`	`92`
	`93`	`+ /**`
	`94`	`+ * @param string $key`
	`95`	`+ */`
`77`	`96`	`public function removeAttribute($key)`
`78`	`97`	`{`
`79`	`98`	`unset($this->attributes[$key]);`
`@@ -92,7 +111,7 @@ public function setInfo($info)`
`92`	`111`	`/**`
`93`	`112`	`* Returns info message.`
`94`	`113`	`*`
`95`		`- * @return string The info text`
	`114`	`+ * @return string\|null The info text`
`96`	`115`	`*/`
`97`	`116`	`public function getInfo()`
`98`	`117`	`{`
`@@ -112,7 +131,7 @@ public function setExample($example)`
`112`	`131`	`/**`
`113`	`132`	`* Retrieves the example configuration for this node.`
`114`	`133`	`*`
`115`		`- * @return string\|array The example`
	`134`	`+ * @return string\|array\|null The example`
`116`	`135`	`*/`
`117`	`136`	`public function getExample()`
`118`	`137`	`{`
Original file line number	Diff line number	Diff line change
`@@ -78,7 +78,7 @@ public function setKeyAttribute($attribute, $remove = true)`
`78`	`78`	`/**`
`79`	`79`	`* Retrieves the name of the attribute which value should be used as key.`
`80`	`80`	`*`
`81`		`- * @return string The name of the attribute`
	`81`	`+ * @return string\|null The name of the attribute`
`82`	`82`	`*/`
`83`	`83`	`public function getKeyAttribute()`
`84`	`84`	`{`
Original file line number	Diff line number	Diff line change
`@@ -152,7 +152,7 @@ public static function loadFile($file, $schemaOrCallable = null)`
`152`	`152`	`* @param \DOMElement $element A \DOMElement instance`
`153`	`153`	`* @param bool $checkPrefix Check prefix in an element or an attribute name`
`154`	`154`	`*`
`155`		`- * @return array A PHP array`
	`155`	`+ * @return mixed`
`156`	`156`	`*/`
`157`	`157`	`public static function convertDomElementToArray(\DOMElement $element, $checkPrefix = true)`
`158`	`158`	`{`