1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
<?php
/**
* Matomo - free/libre analytics platform
*
* @link https://matomo.org
* @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*/
namespace Piwik\Plugins\ExampleCommand\Commands;
use Piwik\Plugin\ConsoleCommand;
/**
* This class lets you define a new command. To read more about commands have a look at our Matomo Console guide on
* https://developer.matomo.org/guides/piwik-on-the-command-line
*
* As Matomo Console is based on the Symfony Console you might also want to have a look at
* https://symfony.com/doc/current/components/console/index.html
*/
class HelloWorld extends ConsoleCommand
{
/**
* This method allows you to configure your command. Here you can define the name and description of your command
* as well as all options and arguments you expect when executing it.
*/
protected function configure()
{
$this->setName('examplecommand:helloworld');
$this->setDescription('ExampleCommandDescription');
$this->addRequiredValueOption('name', null, 'Your name:');
}
/**
* Interact with the user.
*
* This method is executed before the InputDefinition is validated.
* This means that this is the only place where the command can
* interactively ask for values of missing required arguments.
*/
protected function doInteract(): void
{
}
/**
* Initializes the command after the input has been bound and before the input
* is validated.
*
* This is mainly useful when a lot of commands extends one main command
* where some things need to be initialized based on the input arguments and options.
*/
protected function doInitialize(): void
{
}
/**
* The actual task is defined in this method. Here you can access any option or argument that was defined on the
* command line via $this->getInput() and write anything to the console via $this->getOutput().
* In case anything went wrong during the execution you should throw an exception to make sure the user will get a
* useful error message and to make sure the command does not exit with the status code 0.
*
* Ideally, the actual command is quite short as it acts like a controller. It should only receive the input values,
* execute the task by calling a method of another class and output any useful information.
*
* Execute the command like: ./console examplecommand:helloworld --name="The Matomo Team"
*/
protected function doExecute(): int
{
$input = $this->getInput();
$output = $this->getOutput();
$name = $input->getOption('name');
$message = sprintf('<info>HelloWorld: %s</info>', $name);
$output->writeln($message);
return self::SUCCESS;
}
}
|
