minor #53719 [HttpKernel] Document Kernel's array return types (derrabus)

nicolas-grekas · nicolas-grekas · commit ae9ebadc0403 · 2024-02-01T14:01:53.000+01:00
This PR was merged into the 7.1 branch. Discussion ---------- [HttpKernel] Document Kernel's array return types | Q | A | ------------- | --- | Branch? | 7.1 | Bug fix? | no | New feature? | no | Deprecations? | no | Issues | N/A | License | MIT The `Kernel` methods `getAnnotatedClassesToCompile()` and `getKernelParameters()` are meant to be overridden downstream. These additional annotations help static analyzers determine whether an overridden implementation is correct. Commits ------- 266af52 [HttpKernel] Document Kernel's array return types
diff --git a/src/Symfony/Component/HttpKernel/DependencyInjection/Extension.php b/src/Symfony/Component/HttpKernel/DependencyInjection/Extension.php
@@ -24,6 +24,8 @@ abstract class Extension extends BaseExtension
 
     /**
      * Gets the annotated classes to cache.
+     *
+     * @return string[]
      */
     public function getAnnotatedClassesToCompile(): array
     {
@@ -33,7 +35,7 @@ public function getAnnotatedClassesToCompile(): array
     /**
      * Adds annotated classes to the class cache.
      *
-     * @param array $annotatedClasses An array of class patterns
+     * @param string[] $annotatedClasses An array of class patterns
      */
     public function addAnnotatedClassesToCompile(array $annotatedClasses): void
     {
diff --git a/src/Symfony/Component/HttpKernel/Kernel.php b/src/Symfony/Component/HttpKernel/Kernel.php
@@ -314,6 +314,8 @@ public function getCharset(): string
 
     /**
      * Gets the patterns defining the classes to parse and cache for annotations.
+     *
+     * @return string[]
      */
     public function getAnnotatedClassesToCompile(): array
     {
@@ -534,6 +536,8 @@ protected function initializeContainer(): void
 
     /**
      * Returns the kernel parameters.
+     *
+     * @return array<string, array|bool|string|int|float|\UnitEnum|null>
      */
     protected function getKernelParameters(): array
     {

Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,8 @@ abstract class Extension extends BaseExtension`
`24`	`24`
`25`	`25`	`/**`
`26`	`26`	`* Gets the annotated classes to cache.`
	`27`	`+ *`
	`28`	`+ * @return string[]`
`27`	`29`	`*/`
`28`	`30`	`public function getAnnotatedClassesToCompile(): array`
`29`	`31`	`{`
`@@ -33,7 +35,7 @@ public function getAnnotatedClassesToCompile(): array`
`33`	`35`	`/**`
`34`	`36`	`* Adds annotated classes to the class cache.`
`35`	`37`	`*`
`36`		`- * @param array $annotatedClasses An array of class patterns`
	`38`	`+ * @param string[] $annotatedClasses An array of class patterns`
`37`	`39`	`*/`
`38`	`40`	`public function addAnnotatedClassesToCompile(array $annotatedClasses): void`
`39`	`41`	`{`