(NFC) BaseCommand

civicrm · Sep 24, 2024 · 25cb9d8 · 25cb9d8
1 parent 0dfb8e3
commit 25cb9d8
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/lib/src/Command/BaseCommand.php b/lib/src/Command/BaseCommand.php
@@ -7,6 +7,14 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
+/**
+ * Cv's `BaseCommand` is a Symfony `Command` with support for bootstrapping CiviCRM/CMS.
+ *
+ * - From end-user POV, the command accepts options like --user, --level, --hostname.
+ * - From dev POV, the command allows you to implement `execute()` method without needing to
+ *   explicitly boot Civi.
+ * - From dev POV, you may fine-tune command by changing the $bootOptions / getBootOptions().
+ */
 class BaseCommand extends Command {
 
   use OptionCallbackTrait;