Add generic return type to AbstractCrudController::getContext() - #7772
Open
ERuban wants to merge 1 commit into
Open
Add generic return type to AbstractCrudController::getContext()#7772ERuban wants to merge 1 commit into
ERuban wants to merge 1 commit into
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
EasyAdmin 5 made the CRUD stack generic:
AbstractCrudControllerdeclares@template TEntity of object, all action methods are annotated with@param AdminContext<TEntity> $context, and the chain continues throughAdminContextInterface<TEntity>::getEntity(): EntityDto<TEntity>down toEntityDto::getInstance(): TEntity|null.One link is missing:
getContext()has no@returnannotation, so the generic type is lost right at the start of the chain:This forces consumers to keep manual /** @var Product|null */ annotations, although the point of the 5.0 generics (see the "Static Analysis" section in UPGRADE.md) is to remove them.
This PR adds the missing @return AdminContext|null annotation, matching the existing @param AdminContext annotations of the action methods. With it, PHPStan infers Product|null in the example above.
Docblock-only change, no runtime impact.