xref: /plugin/dev/skel/cli.php (revision 70316b849e063a6d74c051966388525c6a62b604)
1<?php
2
3use splitbrain\phpcli\Options;
4
5/**
6 * DokuWiki Plugin @@PLUGIN_NAME@@ (CLI Component)
7 *
8 * @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html
9 * @author  @@AUTHOR_NAME@@ <@@AUTHOR_MAIL@@>
10 */
11class @@PLUGIN_COMPONENT_NAME@@ extends \dokuwiki\Extension\CLIPlugin
12{
13
14    /** @inheritDoc */
15    protected function setup(Options $options)
16    {
17        $options->setHelp('FIXME: What does this CLI do?');
18
19        // main arguments
20        $options->registerArgument('FIXME:argumentName', 'FIXME:argument description', 'FIXME:required? true|false');
21
22        // options
23        // $options->registerOption('FIXME:longOptionName', 'FIXME: helptext for option', 'FIXME: optional shortkey', 'FIXME:needs argument? true|false', 'FIXME:if applies only to subcommand: subcommandName');
24
25        // sub-commands and their arguments
26        // $options->registerCommand('FIXME:subcommandName', 'FIXME:subcommand description');
27        // $options->registerArgument('FIXME:subcommandArgumentName', 'FIXME:subcommand-argument description', 'FIXME:required? true|false', 'FIXME:subcommandName');
28    }
29
30    /** @inheritDoc */
31    protected function main(Options $options)
32    {
33        // $command = $options->getCmd()
34        // $arguments = $options->getArgs()
35    }
36
37}
38
39