CRM_Queue_Queue - Add 'getStatistic($name)'. Deprecate 'numberOfItems()' #24452
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
Should `numberOfItems()` tell you the _total_ number of items -- or the number of _ready_ items? Trick question. They can tell you different things: * When implementing a task-worker (which should start/stop based on available tasks), you'd use _ready_ items. * When implementing `existsQueue()` (which tells if you the queue has anything at all), you'd use _total_ items. This trick-question is why different implementations have computed `numberOfItems()` in different ways. This patch resolves the trick-question by deprecating `numberOfItems()` and replacing it with `getStatistic($name)`.
|
(Standard links)
|
| public function numberOfItems() { | ||
| return count($this->items); | ||
| public function getStatistic(string $name) { | ||
| $ready = function(): int { |
There was a problem hiding this comment.
Hmm - this inline function threw me at first - would be more readable as a separate function but OK - it's a short enough function it doesn't matter
There was a problem hiding this comment.
PHP visibility levels:
publicprotectedprivateso_private_you_can_t_even_see_it
There was a problem hiding this comment.
lol - yes it is VERY private
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.
Overview
(This is an off-shoot from #24408.)
Should
numberOfItems()tell you the total number of items -- or the number of ready items? Trick question. They can tell you different things:existsQueue()(which tells if you the queue has anything at all), you'd use total items.This trick-question is why different implementations have computed
numberOfItems()in different ways.This patch resolves the trick-question by deprecating
numberOfItems()and replacing it withgetStatistic($name).Before
numberOfItems()is ambiguousAfter
numberOfItems()is ambiguousgetStatistics($name)replaces it