xref: /plugin/dev/skel/cli.php (revision 70316b849e063a6d74c051966388525c6a62b604)
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
14*70316b84SAndreas Gohr    /** @inheritDoc */
15*70316b84SAndreas Gohr    protected function setup(Options $options)
16*70316b84SAndreas Gohr    {
17*70316b84SAndreas Gohr        $options->setHelp('FIXME: What does this CLI do?');
18*70316b84SAndreas Gohr
19*70316b84SAndreas Gohr        // main arguments
20*70316b84SAndreas Gohr        $options->registerArgument('FIXME:argumentName', 'FIXME:argument description', 'FIXME:required? true|false');
21*70316b84SAndreas Gohr
22*70316b84SAndreas Gohr        // options
23*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');
24*70316b84SAndreas Gohr
25*70316b84SAndreas Gohr        // sub-commands and their arguments
26*70316b84SAndreas Gohr        // $options->registerCommand('FIXME:subcommandName', 'FIXME:subcommand description');
27*70316b84SAndreas Gohr        // $options->registerArgument('FIXME:subcommandArgumentName', 'FIXME:subcommand-argument description', 'FIXME:required? true|false', 'FIXME:subcommandName');
28*70316b84SAndreas Gohr    }
29*70316b84SAndreas Gohr
30*70316b84SAndreas Gohr    /** @inheritDoc */
31*70316b84SAndreas Gohr    protected function main(Options $options)
32*70316b84SAndreas Gohr    {
33*70316b84SAndreas Gohr        // $command = $options->getCmd()
34*70316b84SAndreas Gohr        // $arguments = $options->getArgs()
35*70316b84SAndreas Gohr    }
36*70316b84SAndreas Gohr
37*70316b84SAndreas Gohr}
38*70316b84SAndreas Gohr
39