Ubuntu
setName('generate:report')->setDescription('Adds a new report to an existing plugin')->addRequiredValueOption('pluginname', null, 'The name of an existing plugin which does not have a menu defined yet')->addRequiredValueOption('reportname', null, 'The name of the report you want to create')->addRequiredValueOption('category', null, 'The name of the category the report belongs to')->addOptionalValueOption('dimension', null, 'The name of the dimension in case your report has a dimension')->addRequiredValueOption('documentation', null, 'A documentation that explains what your report is about');
}
protected function doExecute() : int
{
$pluginName = $this->getPluginName();
$this->checkAndUpdateRequiredPiwikVersion($pluginName);
$reportName = $this->getReportName();
$category = $this->getCategory($pluginName);
$documentation = $this->getDocumentation();
[$dimension, $dimensionClass] = $this->getDimension($pluginName);
$order = $this->getOrder($category);
$apiName = $this->getApiName($reportName);
$exampleFolder = Manager::getPluginDirectory('ExampleReport');
$replace = array('GetExampleReport' => ucfirst($apiName), 'getExampleReport' => lcfirst($apiName), 'getApiReport' => lcfirst($apiName), 'ExampleCategory' => $category, 'ExampleReportName' => $this->makeTranslationIfPossible($pluginName, $reportName), 'ExampleReportDocumentation' => $documentation, '999' => $order, 'new ExitPageUrl()' => $dimension, 'use Piwik\\Plugins\\Actions\\Columns\\ExitPageUrl;' => $dimensionClass, 'ExampleReport' => $pluginName);
$whitelistFiles = array('/Reports', '/Reports/Base.php', '/Reports/GetExampleReport.php');
if (file_exists($this->getPluginPath($pluginName) . '/API.php')) {
$this->copyTemplateMethodToExisitingClass('Piwik\\Plugins\\ExampleReport\\API', 'getExampleReport', $replace);
} else {
$whitelistFiles[] = '/API.php';
}
$this->copyTemplateToPlugin($exampleFolder, $pluginName, $replace, $whitelistFiles);
$this->writeSuccessMessage(array(
sprintf('plugins/%s/Reports/%s.php for %s generated.', $pluginName, ucfirst($apiName), $pluginName),
'You should now implement the method called "' . lcfirst($apiName) . '()" in API.php',
// 'Read more about this here: link to developer guide',
'Enjoy!',
));
return self::SUCCESS;
}
private function getOrder($category)
{
$order = 1;
$reports = new ReportsProvider();
foreach ($reports->getAllReports() as $report) {
if ($report->getCategoryId() === $category) {
if ($report->getOrder() > $order) {
$order = $report->getOrder() + 1;
}
}
}
return $order;
}
private function getApiName($reportName)
{
$reportName = trim($reportName);
$reportName = str_replace(' ', '', $reportName);
$reportName = preg_replace("/[^A-Za-z0-9]/", '', $reportName);
$apiName = 'get' . ucfirst($reportName);
return $apiName;
}
/**
* @return string
* @throws \RuntimeException
*/
protected function getReportName()
{
$input = $this->getInput();
$validate = function ($reportName) {
if (empty($reportName)) {
throw new \InvalidArgumentException('Please enter the name of your report');
}
if (preg_match("/[^A-Za-z0-9 ]/", $reportName)) {
throw new \InvalidArgumentException('Only alpha numerical characters and whitespaces are allowed');
}
return $reportName;
};
$reportName = $input->getOption('reportname');
if (empty($reportName)) {
$reportName = $this->askAndValidate('Enter the name of your report, for instance "Browser Families": ', $validate);
} else {
$validate($reportName);
}
$reportName = ucfirst($reportName);
return $reportName;
}
/**
* @return string
* @throws \RuntimeException
*/
protected function getDocumentation()
{
$input = $this->getInput();
$validate = function ($documentation) {
if (empty($documentation)) {
return '';
}
return $documentation;
};
$documentation = $input->getOption('documentation');
if (empty($documentation)) {
$documentation = $this->askAndValidate('Enter a documentation that describes the data of your report (you can leave it empty and define it later): ', $validate);
} else {
$validate($documentation);
}
$documentation = ucfirst($documentation);
return $documentation;
}
/**
* @param string $pluginName
* @return string
* @throws \RuntimeException
*/
protected function getCategory($pluginName)
{
$input = $this->getInput();
$path = $this->getPluginPath($pluginName) . '/Reports/Base.php';
if (file_exists($path)) {
// category is already defined in base.php
return '';
}
$validate = function ($category) {
if (empty($category)) {
throw new \InvalidArgumentException('Please enter the name of the category your report belongs to');
}
return $category;
};
$category = $input->getOption('category');
$reports = new ReportsProvider();
$categories = array();
foreach ($reports->getAllReports() as $report) {
if ($report->getCategoryId()) {
$categories[] = Piwik::translate($report->getCategoryId());
}
}
$categories = array_values(array_unique($categories));
if (empty($category)) {
$category = $this->askAndValidate('Enter the report category, for instance "Visitor" (you can reuse any existing category or define a new one): ', $validate, \false, $categories);
} else {
$validate($category);
}
$translationKey = StaticContainer::get('Piwik\\Translation\\Translator')->findTranslationKeyForTranslation($category);
if (!empty($translationKey)) {
return $translationKey;
}
$category = ucfirst($category);
return $category;
}
/**
* @param string $pluginName
* @return array
* @throws \RuntimeException
*/
protected function getDimension($pluginName)
{
$input = $this->getInput();
$dimensions = array();
$dimensionNames = array();
$reports = new ReportsProvider();
foreach ($reports->getAllReports() as $report) {
$dimension = $report->getDimension();
if (is_object($dimension)) {
$name = $dimension->getName();
if (!empty($name)) {
$dimensions[$name] = get_class($dimension);
$dimensionNames[] = $name;
}
}
}
$plugin = Manager::getInstance()->loadPlugin($pluginName);
$dimensions = Dimension::getAllDimensions();
$dimensions = array_merge($dimensions, Dimension::getDimensions($plugin));
foreach ($dimensions as $dimension) {
$name = $dimension->getName();
if (!empty($name)) {
$dimensions[$name] = get_class($dimension);
$dimensionNames[] = $name;
}
}
$dimensionNames = array_values(array_unique($dimensionNames));
$validate = function ($dimension) use($dimensions) {
if (empty($dimension)) {
return '';
}
if (!empty($dimension) && !array_key_exists($dimension, $dimensions)) {
throw new \InvalidArgumentException('Leave dimension either empty or use an existing one. You can also create a new dimension by calling .console generate:dimension before generating this report.');
}
return $dimension;
};
$actualDimension = $input->getOption('dimension');
if (null === $actualDimension) {
$actualDimension = $this->askAndValidate('Enter the report dimension, for instance "Browser" (you can leave it either empty or use an existing one): ', $validate, null, $dimensionNames);
} else {
$validate($actualDimension);
}
if (empty($actualDimension)) {
return array('null', '');
}
$className = $dimensions[$actualDimension];
$parts = explode('\\', $className);
$name = end($parts);
return array('new ' . $name . '()', 'use ' . $className . ';');
}
/**
* @return string
* @throws \RuntimeException
*/
protected function getPluginName()
{
$pluginNames = $this->getPluginNames();
$invalidName = 'You have to enter a name of an existing plugin.';
return $this->askPluginNameAndValidate($pluginNames, $invalidName);
}
}