Skip to content

feat: Add isAvailable() method to AbstractCommand#10228

Open
patel-vansh wants to merge 9 commits into
codeigniter4:4.8from
patel-vansh:feat/is-available-method
Open

feat: Add isAvailable() method to AbstractCommand#10228
patel-vansh wants to merge 9 commits into
codeigniter4:4.8from
patel-vansh:feat/is-available-method

Conversation

@patel-vansh
Copy link
Copy Markdown
Contributor

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 use isAvailable() method to determine whether the command should execute or not.

The run() method will first call isAvailable() before any other lifecycle methods (like initialize()/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, CommandNotAvailableException is thrown.

Checklist:

  • Securely signed commits
  • Component(s) with PHPDoc blocks, only if necessary or adds value (without duplication)
  • Unit testing, with >80% coverage
  • User guide updated
  • Conforms to style guide

@github-actions github-actions Bot added the 4.8 PRs that target the `4.8` branch. label May 22, 2026
Comment thread user_guide_src/source/cli/cli_modern_commands/013.php Outdated
Comment thread system/CLI/AbstractCommand.php Outdated
@patel-vansh patel-vansh requested a review from paulbalandan May 22, 2026 12:57
Comment thread system/Language/en/Commands.php Outdated
Comment thread tests/system/CLI/AbstractCommandTest.php Outdated
Comment thread user_guide_src/source/cli/cli_modern_commands.rst
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

4.8 PRs that target the `4.8` branch.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants