Fix PHPDoc return typehint in BatchConsumerInterface::batchExecute() #722
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.
Hi there! 👋
In this PR I'm suggesting to fix PHPDoc and add
int
as possible return types forBatchConsumerInterface::batchExecute()
The reason:
We're analyzing the result of
BatchConsumerInterface::batchExecute()
in:\OldSound\RabbitMqBundle\RabbitMq\BatchConsumer::batchConsume
-> \OldSound\RabbitMqBundle\RabbitMq\BatchConsumer::handleProcessMessages
-> \OldSound\RabbitMqBundle\RabbitMq\BatchConsumer::analyzeProcessFlags
-> \OldSound\RabbitMqBundle\RabbitMq\BatchConsumer::handleProcessFlag
Inside
BatchConsumer::handleProcessFlag()
we can see that the value is compared against integer constants.And inside
BatchConsumer::analyzeProcessFlags()
its clear that if$processFlags
isn't passed as array then the value would be formed as array of$deliveryTag
->$processFlags
, so initial result ofBatchConsumerInterface::batchExecute()
is used here.We discovered this issue while increasing the strictness of our static code analyzer.
Thanks for your time!