Improve-callable-typing #60762
Improve-callable-typing #60762
Conversation
609c5fd to
eeb6152
Compare
| @@ -237,7 +237,10 @@ private function addCsrfSection(ArrayNodeDefinition $rootNode): void | |||
| ; | |||
| } | |||
|
|
|||
| private function addFormSection(ArrayNodeDefinition $rootNode, callable $enableIfStandalone): void | |||
| /** | |||
| * @param \Closure(string, class-string):("canBeDisabled"|"canBeEnabled") $enableIfStandalone | |||
There was a problem hiding this comment.
Types like this could be more manageable if we took advantage of @psalm-type annotations, but it hasn't been done in this codebase before, so I didn't know if it was allowed.
| @@ -160,6 +169,8 @@ public function setAutocompleterValues(?iterable $values): static | |||
|
|
|||
| /** | |||
| * Gets the callback function used for the autocompleter. | |||
| * | |||
| * @return (callable(mixed):iterable)|null | |||
There was a problem hiding this comment.
| * @return (callable(mixed):iterable)|null | |
| * @return (callable(string):string[])|null |
The autocomplete callback is expected to return an array of strings. We don't support returning an iterator (we use array functions with that value for instance) and values must be strings.
the current value from which to autocomplete is also guaranteed to be a string.
btw, the same type is useful for \Symfony\Component\Console\Helper\QuestionHelper::autocomplete (that is consuming the value returned by this getter), so you could update it as well.
| private ?\Closure $autocompleterCallback = null; | ||
| /** | ||
| * @var (\Closure(mixed):bool)|null |
There was a problem hiding this comment.
the validator does not actually return bool. It returns the validated value (potentially transformed) or throws an exception.
| @@ -70,11 +70,15 @@ public function table(array $headers, array $rows): void; | |||
|
|
|||
| /** | |||
| * Asks a question. | |||
| * | |||
| * @param (callable(mixed):bool)|null $validator | |||
There was a problem hiding this comment.
those types are wrong (they must match the type in Question)
|
Thanks for the review. |
Defining a callable's shape is important to have valid static analysis.
It also improves documentation because developers no longer need to search the source code for what callable shape to use.