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
81
82
83
84
85
86
87
88
89
90
|
<?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\CoreConsole\Commands;
use Piwik\Plugin\Manager;
/**
*/
class GenerateVisualizationPlugin extends GeneratePlugin
{
protected function configure()
{
$this->setName('generate:visualizationplugin')
->setDescription('Generates a new visualization plugin including all needed files')
->addRequiredValueOption('name', null, 'Plugin name ([a-Z0-9_-])')
->addRequiredValueOption('visualizationname', null, 'Visualization name ([a-Z0-9])')
->addRequiredValueOption('description', null, 'Plugin description, max 150 characters')
->addOptionalValueOption('pluginversion', null, 'Plugin version')
->addNoValueOption('overwrite', null, 'Generate even if plugin directory already exists.')
->addOptionalValueOption('full', null, 'If a value is set, an API and a Controller will be created as well. Option is only available for creating plugins, not for creating themes.');
}
protected function doExecute(): int
{
$pluginName = $this->getPluginName();
$this->checkAndUpdateRequiredPiwikVersion($pluginName);
$description = $this->getPluginDescription();
$version = $this->getPluginVersion();
$visualizationName = $this->getVisualizationName();
$this->generatePluginFolder($pluginName);
$exampleFolder = Manager::getPluginDirectory('ExampleVisualization');
$replace = array(
'SimpleTable' => $visualizationName,
'simpleTable' => lcfirst($visualizationName),
'Simple Table' => $this->makeTranslationIfPossible($pluginName, $visualizationName),
'ExampleVisualization' => $pluginName,
'ExampleVisualizationDescription' => $description,
);
$this->copyTemplateToPlugin($exampleFolder, $pluginName, $replace, $allowListFiles = array());
$this->writeSuccessMessage(array(
sprintf('Visualization plugin %s %s generated.', $pluginName, $version),
'Enjoy!',
));
return self::SUCCESS;
}
/**
* @return string
* @throws \RuntimeException
*/
private function getVisualizationName()
{
$input = $this->getInput();
$validate = function ($visualizationName) {
if (empty($visualizationName)) {
throw new \RuntimeException('You have to enter a visualization name');
}
if (!ctype_alnum($visualizationName)) {
throw new \RuntimeException(sprintf('The visualization name %s is not valid (only AlNum allowed)', $visualizationName));
}
return $visualizationName;
};
$visualizationName = $input->getOption('visualizationname');
if (empty($visualizationName)) {
$visualizationName = $this->askAndValidate('Enter a visualization name (only AlNum allowed): ', $validate);
} else {
$validate($visualizationName);
}
$visualizationName = ucfirst($visualizationName);
return $visualizationName;
}
}
|
