-
Notifications
You must be signed in to change notification settings - Fork 214
feat: add shared WP-CLI command registry for wp dokan
#3301
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
MdAsifHossainNadim
wants to merge
5
commits into
develop
Choose a base branch
from
feature/dokan-cli-registry
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
71c2f3d
feat: add shared WP-CLI command registry for `wp dokan`
MdAsifHossainNadim 175534f
refactor: register the CLI Manager via a tagged cli-service provider
MdAsifHossainNadim a6acdad
docs: comment why the CLI registry boots only under WP-CLI
MdAsifHossainNadim 4ff9706
fix: validate contributed commands before registering them
MdAsifHossainNadim 805a28a
refactor: cast the CLI commands filter instead of validating each entry
MdAsifHossainNadim File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| <?php | ||
|
|
||
| namespace WeDevs\Dokan\CLI; | ||
|
|
||
| /** | ||
| * Dokan WP-CLI command registry. | ||
| * | ||
| * Owns the `wp dokan` command namespace and exposes the `dokan_cli_commands` | ||
| * filter so Dokan and its extensions (e.g. Dokan Pro) can register commands | ||
| * under the same namespace from a single place. | ||
| * | ||
| * @since DOKAN_SINCE | ||
| */ | ||
| class Manager { | ||
|
|
||
| /** | ||
| * Bootstraps the CLI command registry. | ||
| * | ||
| * @since DOKAN_SINCE | ||
| */ | ||
| public function __construct() { | ||
| // Only register commands while running under WP-CLI. | ||
| if ( ! defined( 'WP_CLI' ) || ! WP_CLI ) { | ||
| return; | ||
| } | ||
|
|
||
| // Register late so every extension has contributed its commands to the filter first. | ||
| add_action( 'init', [ $this, 'register_commands' ], 99 ); | ||
| } | ||
|
|
||
| /** | ||
| * Registers every Dokan WP-CLI command collected from the filter. | ||
| * | ||
| * @since DOKAN_SINCE | ||
| * | ||
| * @return void | ||
| */ | ||
| public function register_commands() { | ||
| // Extensions add their commands as [ 'dokan <command>' => HandlerClass::class ]. | ||
| $commands = (array) apply_filters( 'dokan_cli_commands', [] ); | ||
|
|
||
| foreach ( $commands as $name => $handler ) { | ||
| \WP_CLI::add_command( $name, $handler ); | ||
| } | ||
| } | ||
| } | ||
44 changes: 44 additions & 0 deletions
44
includes/DependencyManagement/Providers/CliServiceProvider.php
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| <?php | ||
|
|
||
| namespace WeDevs\Dokan\DependencyManagement\Providers; | ||
|
|
||
| use WeDevs\Dokan\DependencyManagement\BaseServiceProvider; | ||
| use WeDevs\Dokan\CLI\Manager; | ||
|
|
||
| /** | ||
| * Class CliServiceProvider | ||
| * | ||
| * Registers the WP-CLI command registry with the dependency container and tags | ||
| * it so it is only resolved while running under WP-CLI. | ||
| * | ||
| * @since DOKAN_SINCE | ||
| */ | ||
| class CliServiceProvider extends BaseServiceProvider { | ||
| /** | ||
| * Tags used to identify the service in the container. | ||
| * | ||
| * @var array | ||
| */ | ||
| protected $tags = [ 'cli-service' ]; | ||
|
|
||
| /** | ||
| * List of services provided by this provider. | ||
| * | ||
| * @var array | ||
| */ | ||
| protected $services = [ | ||
| Manager::class, | ||
| ]; | ||
|
|
||
| /** | ||
| * Register the CLI Manager in the container and add the corresponding tags. | ||
| * | ||
| * @return void | ||
| */ | ||
| public function register(): void { | ||
| $this->add_tags( | ||
| $this->getContainer()->addShared( Manager::class ), | ||
| $this->tags | ||
| ); | ||
| } | ||
| } |
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.