%PDF-
%PDF-
Mini Shell
Mini Shell
<?php
/**
* Matomo - 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\Goals;
use Piwik\API\Request;
use Piwik\Columns\ComputedMetricFactory;
use Piwik\Columns\Dimension;
use Piwik\Columns\MetricsList;
use Piwik\Common;
use Piwik\Piwik;
use Piwik\Plugin\ArchivedMetric;
use Piwik\Plugin\ComputedMetric;
use Piwik\Plugin\ReportsProvider;
use Piwik\Plugins\CoreHome\SystemSummary;
use Piwik\Tracker\GoalManager;
use Piwik\Category\Subcategory;
/**
*
*/
class Goals extends \Piwik\Plugin
{
public static function getReportsWithGoalMetrics()
{
$dimensions = self::getAllReportsWithGoalMetrics();
$dimensionsByGroup = array();
foreach ($dimensions as $dimension) {
$group = $dimension['category'];
// move "Custom Variables" report to the "Goals/Sales by User attribute" category
if ($dimension['module'] === 'CustomVariables'
|| $dimension['action'] == 'getVisitInformationPerServerTime') {
$group = 'VisitsSummary_VisitsSummary';
}
unset($dimension['category']);
$dimensionsByGroup[$group][] = $dimension;
}
return $dimensionsByGroup;
}
public static function getGoalIdFromGoalColumn($columnName)
{
if (strpos($columnName, 'goal_') === 0) {
$column = str_replace(array('goal_'), '', $columnName);
return (int) $column;
}
}
public static function makeGoalColumn($idGoal, $column, $forceInt = true)
{
if ($forceInt) { // in non-archiver code idGoal can be, eg, ecommerceOrder
$idGoal = (int) $idGoal;
}
return 'goal_'. $idGoal . '_' . $column;
}
public static function getGoalColumns($idGoal)
{
$columns = array(
'nb_conversions',
'nb_visits_converted',
'revenue',
);
if ($idGoal === false) {
return $columns;
}
// Orders
if ($idGoal === GoalManager::IDGOAL_ORDER) {
$columns = array_merge($columns, array(
'revenue_subtotal',
'revenue_tax',
'revenue_shipping',
'revenue_discount',
));
}
// Abandoned carts & orders
if ($idGoal <= GoalManager::IDGOAL_ORDER) {
$columns[] = 'items';
}
return $columns;
}
/**
* @see \Piwik\Plugin::registerEvents
*/
public function registerEvents()
{
$hooks = array(
'AssetManager.getStylesheetFiles' => 'getStylesheetFiles',
'Tracker.Cache.getSiteAttributes' => 'fetchGoalsFromDb',
'API.getReportMetadata.end' => 'getReportMetadataEnd',
'SitesManager.deleteSite.end' => 'deleteSiteGoals',
'Translate.getClientSideTranslationKeys' => 'getClientSideTranslationKeys',
'Metrics.getDefaultMetricTranslations' => 'addMetricTranslations',
'Metrics.getDefaultMetricSemanticTypes' => 'addMetricSemanticTypes',
'Category.addSubcategories' => 'addSubcategories',
'Metric.addMetrics' => 'addMetrics',
'Metric.addComputedMetrics' => 'addComputedMetrics',
'System.addSystemSummaryItems' => 'addSystemSummaryItems',
);
return $hooks;
}
public function addSystemSummaryItems(&$systemSummary)
{
$goalModel = new Model();
$numGoals = $goalModel->getActiveGoalCount();
$systemSummary[] = new SystemSummary\Item($key = 'goals', Piwik::translate('Goals_NGoals', $numGoals), $value = null, array('module' => 'Goals', 'action' => 'manage'), $icon = 'icon-goal', $order = 7);
}
public function addComputedMetrics(MetricsList $list, ComputedMetricFactory $computedMetricFactory)
{
$idSite = Common::getRequestVar('idSite', 0, 'int');
$goals = Request::processRequest('Goals.getGoals', ['idSite' => $idSite, 'filter_limit' => '-1'], $default = []);
foreach ($goals as $goal) {
$metric = $computedMetricFactory->createComputedMetric('goal_' . $goal['idgoal'] . '_conversion', 'nb_uniq_visitors', ComputedMetric::AGGREGATION_RATE);
$goalName = '"' . Piwik::translate('Goals_GoalX', $goal['name']) . '"';
$metricName = Piwik::translate('Goals_ConversionRate', $goalName);
$metric->setTranslatedName($metricName);
$list->addMetric($metric);
}
}
public function addMetrics(MetricsList $metricsList)
{
$idSite = Common::getRequestVar('idSite', 0, 'int');
$goals = Request::processRequest('Goals.getGoals', ['idSite' => $idSite, 'filter_limit' => '-1'], $default = []);
foreach ($goals as $goal) {
$custom = new GoalDimension($goal, 'idgoal', 'Conversions goal "' . $goal['name'] . '" (ID ' . $goal['idgoal'] .' )');
$custom->setType(Dimension::TYPE_NUMBER);
$custom->setSqlSegment('count(distinct log_conversion.idvisit, log_conversion.buster)');
$metric = new ArchivedMetric($custom, ArchivedMetric::AGGREGATION_SUM);
$metric->setQuery('count(distinct log_conversion.idvisit, log_conversion.buster)');
$metric->setTranslatedName($custom->getName());
$metric->setDocumentation('The number of times this goal was converted.');
$metric->setCategory($custom->getCategoryId());
$metric->setName('goal_' . $goal['idgoal'] . '_conversion');
$metricsList->addMetric($metric);
$custom = new GoalDimension($goal, 'revenue', 'Revenue goal "' . $goal['name'] . '" (ID ' . $goal['idgoal'] .' )');
$custom->setType(Dimension::TYPE_MONEY);
$metric = new ArchivedMetric($custom, ArchivedMetric::AGGREGATION_SUM);
$metric->setTranslatedName($custom->getName());
$metric->setName('goal_' . $goal['idgoal'] . '_revenue');
$metric->setDocumentation('The amount of revenue that was generated by converting this goal.');
$metric->setCategory($custom->getCategoryId());
$metricsList->addMetric($metric);
$custom = new GoalDimension($goal, 'visitor_seconds_since_first', 'Days to conversion goal "' . $goal['name'] . '" (ID ' . $goal['idgoal'] .' )');
$custom->setType(Dimension::TYPE_NUMBER);
$metric = new ArchivedMetric($custom, ArchivedMetric::AGGREGATION_SUM);
$metric->setTranslatedName($custom->getName());
$metric->setCategory($custom->getCategoryId());
$metric->setDocumentation('The number of days it took a visitor to convert this goal.');
$metric->setName('goal_' . $goal['idgoal'] . '_daystoconversion');
$metric->setQuery('sum(floor(log_visit.visitor_seconds_since_first / 86400))');
$metricsList->addMetric($metric);
$custom = new GoalDimension($goal, 'visitor_count_visits', 'Visits to conversion goal "' . $goal['name'] . '" (ID ' . $goal['idgoal'] .' )');
$custom->setType(Dimension::TYPE_NUMBER);
$metric = new ArchivedMetric($custom, ArchivedMetric::AGGREGATION_SUM);
$metric->setTranslatedName($custom->getName());
$metric->setCategory($custom->getCategoryId());
$metric->setDocumentation('The number of visits it took a visitor to convert this goal.');
$metric->setName('goal_' . $goal['idgoal'] . '_visitstoconversion');
$metricsList->addMetric($metric);
}
}
public function addSubcategories(&$subcategories)
{
$idSite = Common::getRequestVar('idSite', 0, 'int');
if (!$idSite) {
// fallback for eg API.getReportMetadata which uses idSites
$idSite = Common::getRequestVar('idSites', 0, 'int');
if (!$idSite) {
return;
}
}
$goals = Request::processRequest('Goals.getGoals', ['idSite' => $idSite, 'filter_limit' => '-1'], $default = []);
$order = 900;
foreach ($goals as $goal) {
$category = new Subcategory();
$category->setName($goal['name']);
$category->setCategoryId('Goals_Goals');
$category->setId($goal['idgoal']);
$category->setOrder($order++);
$subcategories[] = $category;
}
}
public function addMetricTranslations(&$translations)
{
$metrics = array(
'orders' => 'General_EcommerceOrders',
'ecommerce_revenue' => 'General_ProductRevenue',
'revenue_per_visit' => 'General_ColumnValuePerVisit',
'quantity' => 'General_Quantity',
'avg_price' => 'General_AveragePrice',
'avg_quantity' => 'General_AverageQuantity',
'revenue_subtotal' => 'General_Subtotal',
'revenue_tax' => 'General_Tax',
'revenue_shipping' => 'General_Shipping',
'revenue_discount' => 'General_Discount',
'avg_order_revenue' => 'General_AverageOrderValue'
);
$metrics = array_map(array('\\Piwik\\Piwik', 'translate'), $metrics);
$translations = array_merge($translations, $metrics);
}
public function addMetricSemanticTypes(array &$types): void
{
$goalMetricTypes = array(
'orders' => Dimension::TYPE_NUMBER,
'ecommerce_revenue' => Dimension::TYPE_MONEY,
'quantity' => Dimension::TYPE_NUMBER,
'revenue_subtotal' => Dimension::TYPE_MONEY,
'revenue_tax' => Dimension::TYPE_MONEY,
'revenue_shipping' => Dimension::TYPE_MONEY,
'revenue_discount' => Dimension::TYPE_MONEY,
'avg_order_revenue' => Dimension::TYPE_MONEY,
'items' => Dimension::TYPE_NUMBER,
);
$types = array_merge($types, $goalMetricTypes);
}
/**
* Delete goals recorded for this site
*/
public function deleteSiteGoals($idSite)
{
$model = new Model();
$model->deleteGoalsForSite($idSite);
}
/**
* Returns the Metadata for the Goals plugin API.
* The API returns general Goal metrics: conv, conv rate and revenue globally
* and for each goal.
*
* Also, this will update metadata of all other reports that have Goal segmentation
*/
public function getReportMetadataEnd(&$reports, $info)
{
// Processed in AddColumnsProcessedMetricsGoal
// These metrics will also be available for some reports, for each goal
// Example: Conversion rate for Goal 2 for the keyword 'piwik'
$goalProcessedMetrics = array(
'revenue_per_visit' => Piwik::translate('General_ColumnValuePerVisit'),
);
$goalMetrics = array(
'nb_conversions' => Piwik::translate('Goals_ColumnConversions'),
'conversion_rate' => Piwik::translate('General_ColumnConversionRate'),
'revenue' => Piwik::translate('General_ColumnRevenue')
);
$goalMetricTypes = [
'revenue_per_visit' => Dimension::TYPE_MONEY,
'nb_conversions' => Dimension::TYPE_NUMBER,
'conversion_rate' => Dimension::TYPE_PERCENT,
'revenue' => Dimension::TYPE_MONEY,
];
$reportsWithGoals = self::getAllReportsWithGoalMetrics();
foreach ($reportsWithGoals as $reportWithGoals) {
// Select this report from the API metadata array
// and add the Goal metrics to it
foreach ($reports as &$apiReportToUpdate) {
// We do not add anything for Action reports, as no overall metrics are processed there at the moment
if ($apiReportToUpdate['module'] === 'Actions') {
continue;
}
if ($apiReportToUpdate['module'] == $reportWithGoals['module']
&& $apiReportToUpdate['action'] == $reportWithGoals['action']
&& empty($apiReportToUpdate['parameters'])
) {
$apiReportToUpdate['metricsGoal'] = $goalMetrics;
$apiReportToUpdate['processedMetricsGoal'] = $goalProcessedMetrics;
$apiReportToUpdate['metricTypesGoal'] = $goalMetricTypes;
break;
}
}
}
}
private static function getAllReportsWithGoalMetrics()
{
$reportsWithGoals = array();
$reports = new ReportsProvider();
foreach ($reports->getAllReports() as $report) {
if ($report->hasGoalMetrics() && $report->isEnabled()) {
$reportsWithGoals[] = array(
'category' => $report->getCategoryId(),
'name' => $report->getName(),
'module' => $report->getModule(),
'action' => $report->getAction(),
'parameters' => $report->getParameters()
);
}
}
$reportsWithGoals[] = array('category' => 'General_Visit',
'name' => Piwik::translate('Goals_VisitsUntilConv'),
'module' => 'Goals',
'action' => 'getVisitsUntilConversion',
'viewDataTable' => 'table',
);
$reportsWithGoals[] = array('category' => 'General_Visit',
'name' => Piwik::translate('Goals_DaysToConv'),
'module' => 'Goals',
'action' => 'getDaysToConversion',
'viewDataTable' => 'table',
);
/**
* Triggered when gathering all reports that contain Goal metrics. The list of reports
* will be displayed on the left column of the bottom of every _Goals_ page.
*
* If plugins define reports that contain goal metrics (such as **conversions** or **revenue**),
* they can use this event to make sure their reports can be viewed on Goals pages.
*
* **Example**
*
* public function getReportsWithGoalMetrics(&$reports)
* {
* $reports[] = array(
* 'category' => Piwik::translate('MyPlugin_myReportCategory'),
* 'name' => Piwik::translate('MyPlugin_myReportDimension'),
* 'module' => 'MyPlugin',
* 'action' => 'getMyReport'
* );
* }
*
* @param array &$reportsWithGoals The list of arrays describing reports that have Goal metrics.
* Each element of this array must be an array with the following
* properties:
*
* - **category**: The report category. This should be a translated string.
* - **name**: The report's translated name.
* - **module**: The plugin the report is in, eg, `'UserCountry'`.
* - **action**: The API method of the report, eg, `'getCountry'`.
* @ignore
* @deprecated since 2.5.0
*/
Piwik::postEvent('Goals.getReportsWithGoalMetrics', array(&$reportsWithGoals));
return $reportsWithGoals;
}
public function getStylesheetFiles(&$stylesheets)
{
$stylesheets[] = "plugins/Goals/stylesheets/goals.less";
}
public function fetchGoalsFromDb(&$array, $idSite)
{
// add the 'goal' entry in the website array
$array['goals'] = API::getInstance()->getGoals($idSite);
}
public function getClientSideTranslationKeys(&$translationKeys)
{
$translationKeys[] = 'Goals_AddGoal';
$translationKeys[] = 'Goals_AddNewGoal';
$translationKeys[] = 'Goals_UpdateGoal';
$translationKeys[] = 'Goals_DeleteGoalConfirm';
$translationKeys[] = 'Goals_Ecommerce';
$translationKeys[] = 'Goals_Optional';
$translationKeys[] = 'Goals_TimeInMinutes';
$translationKeys[] = 'Goals_Pattern';
$translationKeys[] = 'Goals_ClickToViewThisGoal';
$translationKeys[] = 'Goals_ManageGoals';
$translationKeys[] = 'Goals_GoalName';
$translationKeys[] = 'Goals_GoalIsTriggeredWhen';
$translationKeys[] = 'Goals_ThereIsNoGoalToManage';
$translationKeys[] = 'Goals_ManuallyTriggeredUsingJavascriptFunction';
$translationKeys[] = 'Goals_VisitUrl';
$translationKeys[] = 'Goals_ClickOutlink';
$translationKeys[] = 'Goals_SendEvent';
$translationKeys[] = 'Goals_GoalIsTriggered';
$translationKeys[] = 'Goals_WhereThe';
$translationKeys[] = 'Goals_URL';
$translationKeys[] = 'Goals_Contains';
$translationKeys[] = 'Goals_IsExactly';
$translationKeys[] = 'Goals_MatchesExpression';
$translationKeys[] = 'Goals_AllowMultipleConversionsPerVisit';
$translationKeys[] = 'Goals_HelpOneConversionPerVisit';
$translationKeys[] = 'Goals_DefaultRevenueHelp';
$translationKeys[] = 'Goals_DefaultRevenueLabel';
$translationKeys[] = 'Goals_GoalRevenue';
$translationKeys[] = 'Goals_Filename';
$translationKeys[] = 'Goals_ExternalWebsiteUrl';
$translationKeys[] = 'Goals_VisitDuration';
$translationKeys[] = 'Goals_AtLeastMinutes';
$translationKeys[] = 'Goals_VisitPageTitle';
$translationKeys[] = 'Intl_NMinutes';
$translationKeys[] = 'Goals_PageTitle';
$translationKeys[] = 'Goals_UseEventValueAsRevenue';
$translationKeys[] = 'Goals_EventValueAsRevenueHelp';
$translationKeys[] = 'Goals_EventValueAsRevenueHelp2';
$translationKeys[] = 'Events_EventCategory';
$translationKeys[] = 'Goals_WhereVisitedPageManuallyCallsJavascriptTrackerLearnMore';
$translationKeys[] = 'Goals_LearnMoreAboutGoalTrackingDocumentation';
$translationKeys[] = 'Goals_EcommerceReports';
$translationKeys[] = 'SitesManager_WebsitesManagement';
$translationKeys[] = 'Goals_CaseSensitive';
$translationKeys[] = 'Goals_Download';
$translationKeys[] = 'Events_EventAction';
$translationKeys[] = 'Events_EventCategory';
$translationKeys[] = 'Events_EventName';
$translationKeys[] = 'Goals_YouCanEnableEcommerceReports';
$translationKeys[] = 'Goals_CategoryTextGeneral_Actions';
$translationKeys[] = 'General_ForExampleShort';
$translationKeys[] = 'General_Id';
$translationKeys[] = 'General_Description';
$translationKeys[] = 'General_ColumnRevenue';
$translationKeys[] = 'General_Edit';
$translationKeys[] = 'General_Delete';
$translationKeys[] = 'General_OperationGreaterThan';
$translationKeys[] = 'General_Yes';
$translationKeys[] = 'General_No';
$translationKeys[] = 'General_OrCancel';
}
}
Zerion Mini Shell 1.0