Make Api\SearchResults implement Api\SearchResultsInterface #1420
Conversation
This file contains 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
Purpose == Make the implementation actually fulfill the contract defined by the interface. Background == The return type hints of almost all the repository implementations of the `getList()` method indicate a return type of `\Magento\Framework\Api\SearchResultsInterface` or one of its sub-interfaces. One example of many is `\Magento\Catalog\Api\ProductRepositoryInterface::getList()`. The return type hint states it returns `\Magento\Catalog\Api\Data\ProductSearchResultsInterface`, which in turn extends `\Magento\Framework\Api\SearchResultsInterface`. However, the concrete implementation preference for that interface is `\Magento\Framework\Api\SearchResults`, which does not implement `\Magento\Framework\Api\SearchResultsInterface` (or any interface for that matter). Reasons for this PR == This PR makes `Api\SearchResults` actually implement `Api\SearchResultsInterface`, forcing all implementations to match the contract. It also improves developer experience because this is pretty much what should be expected of the code anyway. It also makes the preference configuration technically more correct, because the configured concrete class is guaranteed to at least partially fulfill the contract defined by the interface.
|
@Vinai thank you for the contribution! Internal reference: MAGETWO-39813 |
|
@Vinai your code changes have just been deployed in version 1.0.0-beta. Thank you again for your contribution! |
|
Thank you! |
magento-team
pushed a commit
that referenced
this pull request
Aug 17, 2017
[EngCom] Public Pull Requests - 2.1 - MAGETWO-71658: Fix for url_rewrite on page delete via api #10569
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.
Purpose
Make the implementation actually fulfill the contract defined by the interface.
Background
The return type hints of almost all the repository implementations of the
getList()method indicate a return type of
\Magento\Framework\Api\SearchResultsInterfaceorone of its sub-interfaces.
One example of many is
\Magento\Catalog\Api\ProductRepositoryInterface::getList().The return type hint states it returns
\Magento\Catalog\Api\Data\ProductSearchResultsInterface,which in turn extends
\Magento\Framework\Api\SearchResultsInterface.However, the concrete implementation preference for that interface is
\Magento\Framework\Api\SearchResults, which does not implement\Magento\Framework\Api\SearchResultsInterface(or any interface for that matter).Reasons for this PR
This PR makes
Api\SearchResultsactually implementApi\SearchResultsInterface,forcing all implementations to match the contract.
It also improves developer experience because this is pretty much what should be expected
of the code.
It also makes the preference configuration technically more correct, because the configured
concrete class is guaranteed to at least partially fulfill the contract defined by the
interface.