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