feat: Add isAvailable() method to AbstractCommand#10228
Open
patel-vansh wants to merge 9 commits into
Open
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.
Description
This PR adds a new method in
AbstractCommand.php,isAvailable(). This method can be used to check in runtime if the command should be executed or not. Many times, we need to define environment specific commands, especially dev commands that shouldn't be callable in production or testing. In this case, one can useisAvailable()method to determine whether the command should execute or not.The
run()method will first callisAvailable()before any other lifecycle methods (likeinitialize()/interact()/execute(), etc.). The sole purpose of this method is to allow/restrict execution of commands based on runtime environment/config/state and NOT passed arguments or options, and that's why it doesn't accept any parameters.If a caller calls a command that is not available for particular runtime,
CommandNotAvailableExceptionis thrown.Checklist: