minor symfony#24854 Docblock fixes (nicolas-grekas)

nicolas-grekas · nicolas-grekas · commit 4371d03d6116 · 2017-11-07T12:56:10.000+01:00
This PR was merged into the 2.7 branch. Discussion ---------- Docblock fixes | Q | A | ------------- | --- | Branch? | 2.7 | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - Commits ------- b56bfe7 Docblock fixes
diff --git a/src/Symfony/Bridge/Doctrine/DependencyInjection/CompilerPass/RegisterMappingsPass.php b/src/Symfony/Bridge/Doctrine/DependencyInjection/CompilerPass/RegisterMappingsPass.php
@@ -69,7 +69,7 @@ abstract class RegisterMappingsPass implements CompilerPassInterface
      * only do anything if the parameter is present. (But regardless of the
      * value of that parameter.
      *
-     * @var string
+     * @var string|false
      */
     protected $enabledParameter;
 
diff --git a/src/Symfony/Bridge/Twig/Extension/CodeExtension.php b/src/Symfony/Bridge/Twig/Extension/CodeExtension.php
@@ -193,7 +193,7 @@ public function formatFile($file, $line, $text = null)
      * @param string $file An absolute file path
      * @param int    $line The line number
      *
-     * @return string A link of false
+     * @return string|false A link or false
      */
     public function getFileLink($file, $line)
     {
diff --git a/src/Symfony/Bundle/FrameworkBundle/Client.php b/src/Symfony/Bundle/FrameworkBundle/Client.php
@@ -62,7 +62,7 @@ public function getKernel()
     /**
      * Gets the profile associated with the current Response.
      *
-     * @return HttpProfile A Profile instance
+     * @return HttpProfile|false A Profile instance
      */
     public function getProfile()
     {
diff --git a/src/Symfony/Component/Config/Util/XmlUtils.php b/src/Symfony/Component/Config/Util/XmlUtils.php
@@ -109,7 +109,7 @@ public static function loadFile($file, $schemaOrCallable = null)
     }
 
     /**
-     * Converts a \DomElement object to a PHP array.
+     * Converts a \DOMElement object to a PHP array.
      *
      * The following rules applies during the conversion:
      *
@@ -123,7 +123,7 @@ public static function loadFile($file, $schemaOrCallable = null)
      *
      *  * The nested-tags are converted to keys (<foo><foo>bar</foo></foo>)
      *
-     * @param \DomElement $element     A \DomElement instance
+     * @param \DOMElement $element     A \DOMElement instance
      * @param bool        $checkPrefix Check prefix in an element or an attribute name
      *
      * @return array A PHP array
diff --git a/src/Symfony/Component/DependencyInjection/Loader/XmlFileLoader.php b/src/Symfony/Component/DependencyInjection/Loader/XmlFileLoader.php
@@ -547,7 +547,7 @@ private function loadFromExtensions(\DOMDocument $xml)
     }
 
     /**
-     * Converts a \DomElement object to a PHP array.
+     * Converts a \DOMElement object to a PHP array.
      *
      * The following rules applies during the conversion:
      *
@@ -561,7 +561,7 @@ private function loadFromExtensions(\DOMDocument $xml)
      *
      *  * The nested-tags are converted to keys (<foo><foo>bar</foo></foo>)
      *
-     * @param \DomElement $element A \DomElement instance
+     * @param \DOMElement $element A \DOMElement instance
      *
      * @return array A PHP array
      */
diff --git a/src/Symfony/Component/Form/Extension/Core/Type/DateType.php b/src/Symfony/Component/Form/Extension/Core/Type/DateType.php
@@ -268,7 +268,7 @@ public function getName()
     private function formatTimestamps(\IntlDateFormatter $formatter, $regex, array $timestamps)
     {
         $pattern = $formatter->getPattern();
-        $timezone = $formatter->getTimezoneId();
+        $timezone = $formatter->getTimeZoneId();
         $formattedTimestamps = array();
 
         if ($setTimeZone = \PHP_VERSION_ID >= 50500 || method_exists($formatter, 'setTimeZone')) {
diff --git a/src/Symfony/Component/Validator/Constraints/AbstractComparisonValidator.php b/src/Symfony/Component/Validator/Constraints/AbstractComparisonValidator.php
@@ -47,7 +47,7 @@ public function validate($value, Constraint $constraint)
             if ($value instanceof \DateTimeImmutable) {
                 // If $value is immutable, convert the compared value to a
                 // DateTimeImmutable too
-                $comparedValue = new \DatetimeImmutable($comparedValue);
+                $comparedValue = new \DateTimeImmutable($comparedValue);
             } elseif ($value instanceof \DateTime || $value instanceof \DateTimeInterface) {
                 // Otherwise use DateTime
                 $comparedValue = new \DateTime($comparedValue);

Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,7 @@ abstract class RegisterMappingsPass implements CompilerPassInterface`
`69`	`69`	`* only do anything if the parameter is present. (But regardless of the`
`70`	`70`	`* value of that parameter.`
`71`	`71`	`*`
`72`		`- * @var string`
	`72`	`+ * @var string\|false`
`73`	`73`	`*/`
`74`	`74`	`protected $enabledParameter;`
`75`	`75`
Original file line number	Diff line number	Diff line change
`@@ -193,7 +193,7 @@ public function formatFile($file, $line, $text = null)`
`193`	`193`	`* @param string $file An absolute file path`
`194`	`194`	`* @param int $line The line number`
`195`	`195`	`*`
`196`		`- * @return string A link of false`
	`196`	`+ * @return string\|false A link or false`
`197`	`197`	`*/`
`198`	`198`	`public function getFileLink($file, $line)`
`199`	`199`	`{`
Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ public function getKernel()`
`62`	`62`	`/**`
`63`	`63`	`* Gets the profile associated with the current Response.`
`64`	`64`	`*`
`65`		`- * @return HttpProfile A Profile instance`
	`65`	`+ * @return HttpProfile\|false A Profile instance`
`66`	`66`	`*/`
`67`	`67`	`public function getProfile()`
`68`	`68`	`{`
Original file line number	Diff line number	Diff line change
`@@ -109,7 +109,7 @@ public static function loadFile($file, $schemaOrCallable = null)`
`109`	`109`	`}`
`110`	`110`
`111`	`111`	`/**`
`112`		`- * Converts a \DomElement object to a PHP array.`
	`112`	`+ * Converts a \DOMElement object to a PHP array.`
`113`	`113`	`*`
`114`	`114`	`* The following rules applies during the conversion:`
`115`	`115`	`*`
`@@ -123,7 +123,7 @@ public static function loadFile($file, $schemaOrCallable = null)`
`123`	`123`	`*`
`124`	`124`	`* * The nested-tags are converted to keys (<foo><foo>bar</foo></foo>)`
`125`	`125`	`*`
`126`		`- * @param \DomElement $element A \DomElement instance`
	`126`	`+ * @param \DOMElement $element A \DOMElement instance`
`127`	`127`	`* @param bool $checkPrefix Check prefix in an element or an attribute name`
`128`	`128`	`*`
`129`	`129`	`* @return array A PHP array`
Original file line number	Diff line number	Diff line change
`@@ -547,7 +547,7 @@ private function loadFromExtensions(\DOMDocument $xml)`
`547`	`547`	`}`
`548`	`548`
`549`	`549`	`/**`
`550`		`- * Converts a \DomElement object to a PHP array.`
	`550`	`+ * Converts a \DOMElement object to a PHP array.`
`551`	`551`	`*`
`552`	`552`	`* The following rules applies during the conversion:`
`553`	`553`	`*`
`@@ -561,7 +561,7 @@ private function loadFromExtensions(\DOMDocument $xml)`
`561`	`561`	`*`
`562`	`562`	`* * The nested-tags are converted to keys (<foo><foo>bar</foo></foo>)`
`563`	`563`	`*`
`564`		`- * @param \DomElement $element A \DomElement instance`
	`564`	`+ * @param \DOMElement $element A \DOMElement instance`
`565`	`565`	`*`
`566`	`566`	`* @return array A PHP array`
`567`	`567`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -268,7 +268,7 @@ public function getName()`
`268`	`268`	`private function formatTimestamps(\IntlDateFormatter $formatter, $regex, array $timestamps)`
`269`	`269`	`{`
`270`	`270`	`$pattern = $formatter->getPattern();`
`271`		`- $timezone = $formatter->getTimezoneId();`
	`271`	`+ $timezone = $formatter->getTimeZoneId();`
`272`	`272`	`$formattedTimestamps = array();`
`273`	`273`
`274`	`274`	`if ($setTimeZone = \PHP_VERSION_ID >= 50500 \|\| method_exists($formatter, 'setTimeZone')) {`