Add more precise return types for the openssl cipher functions #4043
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
stof
force-pushed
the
better_openssl_types
branch
from
6144182 to
ecfa6c2
Compare
staabm
reviewed
Jun 4, 2025
Comment on lines
38
to
63
| public function getTypeFromFunctionCall(FunctionReflection $functionReflection, FuncCall $functionCall, Scope $scope): Type | ||
| { | ||
| $returnType = ParametersAcceptorSelector::selectFromArgs( | ||
| $scope, | ||
| $functionCall->getArgs(), | ||
| $functionReflection->getVariants(), | ||
| )->getReturnType(); | ||
|
|
||
| if (!$this->phpVersion->throwsValueErrorForInternalFunctions()) { | ||
| return $returnType; | ||
| } | ||
|
|
||
| if (count($functionCall->getArgs()) < 1) { | ||
| return $returnType; | ||
| } | ||
|
|
||
| $strings = $scope->getType($functionCall->getArgs()[0]->value)->getConstantStrings(); | ||
| $results = array_unique(array_map(fn (ConstantStringType $algorithm): bool => $this->isSupportedAlgorithm($algorithm->getValue()), $strings)); | ||
|
|
||
| if (count($results) === 1) { | ||
| return $results[0] | ||
| ? TypeCombinator::remove($returnType, new ConstantBooleanType(false)) | ||
| : new ConstantBooleanType(false); | ||
| } | ||
|
|
||
| return $returnType; |
There was a problem hiding this comment.
instead of
$returnType = ParametersAcceptorSelector::selectFromArgs(
$scope,
$functionCall->getArgs(),
$functionReflection->getVariants(),
)->getReturnType();
you can just return null; for the cases where the extension cannot provide a better type then the default.
that way you can simplify the extension a bit.
There was a problem hiding this comment.
I refactored the code to return null for all such cases.
staabm
reviewed
Jun 4, 2025
| return in_array(strtoupper($algorithm), $this->getSupportedAlgorithms(), true); | ||
| } | ||
|
|
||
| /** @return string[] */ |
There was a problem hiding this comment.
might work to use a more precise return type
Suggested change
| /** @return string[] */ | |
| /** @return uppercase-string[] */ |
There was a problem hiding this comment.
I inspired from MbFunctionsReturnTypeExtensionTrait, which also uses simply string[]
stof
force-pushed
the
better_openssl_types
branch
from
ecfa6c2 to
bb6367d
Compare
|
Needs cs fix |
stof
force-pushed
the
better_openssl_types
branch
from
bb6367d to
1e9efb6
Compare
|
@staabm done |
ondrejmirtes
requested changes
Jul 17, 2025
conf/config.neon
Outdated
| tags: | ||
| - phpstan.dynamicFunctionThrowTypeExtension | ||
|
|
||
| - |
There was a problem hiding this comment.
Please put this on 2.1.x and use AutowiredService attribute instead of changing config.neon. Thanks.
There was a problem hiding this comment.
@ondrejmirtes sorry for the delay. This is now done.
stof
force-pushed
the
better_openssl_types
branch
from
1e9efb6 to
1c9db7a
Compare
|
Thank you. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Those functions return false (and trigger a warning) only when the argument is an unknown algorithm, which is not something worth checking when using them with a known algorithm.
I'm providing this improvement only on PHP 8+, because PHP 7 can have other kind of warnings (that have been upgraded to
ValueErrorin PHP 8)Replaces #3582