blob: 701fed32cab721189ff6f7abb82338484683f125 (
plain)
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
|
<?php
/**
* Piwik - free/libre analytics platform
*
* @link https://matomo.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*/
namespace Piwik\Plugins\ExampleCommand\Commands;
use Piwik\Plugin\ConsoleCommand;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
/**
* This class lets you define a new command. To read more about commands have a look at our Piwik Console guide on
* http://developer.piwik.org/guides/piwik-on-the-command-line
*
* As Piwik Console is based on the Symfony Console you might also want to have a look at
* http://symfony.com/doc/current/components/console/index.html
*/
class HelloWorld extends ConsoleCommand
{
/**
* This methods 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->addOption('name', null, InputOption::VALUE_REQUIRED, 'Your name:');
}
/**
* The actual task is defined in this method. Here you can access any option or argument that was defined on the
* command line via $input and write anything to the console via $output argument.
* 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 Piwik Team"
*/
protected function execute(InputInterface $input, OutputInterface $output)
{
$name = $input->getOption('name');
$message = sprintf('<info>HelloWorld: %s</info>', $name);
$output->writeln($message);
}
}
|
