'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', 'Archiver.addRecordBuilders' => 'addRecordBuilders', 'Segment.filterSegments' => 'filterSegments', ); return $hooks; } public function addRecordBuilders(array &$recordBuilders): void { $recordBuilders[] = new ProductRecord(ProductRecord::SKU_FIELD, ProductRecord::ITEMS_SKU_RECORD_NAME); $recordBuilders[] = new ProductRecord(ProductRecord::NAME_FIELD, ProductRecord::ITEMS_NAME_RECORD_NAME); $recordBuilders[] = new ProductRecord(ProductRecord::CATEGORY_FIELD, ProductRecord::ITEMS_CATEGORY_RECORD_NAME, [ ProductRecord::CATEGORY2_FIELD, ProductRecord::CATEGORY3_FIELD, ProductRecord::CATEGORY4_FIELD, ProductRecord::CATEGORY5_FIELD, ]); } 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', 'orderByName' => true], $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); } /** * Adds Goal metrics (conversions, conversion rate, revenue) to the metadata of all * other reports that support 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, ]; // special goal metrics for Actions page reports $pageGoalMetrics = array_merge($goalMetrics, [ 'nb_conversions_attrib' => Piwik::translate('Goals_ColumnConversions'), 'revenue_attrib' => Piwik::translate('General_ColumnRevenue'), ]); unset($pageGoalMetrics['revenue']); $pageGoalProcessedMetrics = array_merge($goalProcessedMetrics, [ 'nb_conversions_page_rate' => Piwik::translate('Goals_ConversionRatePageViewedBeforeGeneric'), ]); $pageGoalMetricTypes = array_merge($goalMetricTypes, [ 'nb_conversions_attrib' => Dimension::TYPE_NUMBER, 'revenue_attrib' => Dimension::TYPE_MONEY, 'nb_conversions_page_rate' => Dimension::TYPE_PERCENT, ]); unset($pageGoalMetricTypes['revenue']); // special goal metrics for Actions entry page reports $entryPageGoalMetrics = array_merge($goalMetrics, [ 'nb_conversions_entry' => Piwik::translate('Goals_ColumnConversions'), 'revenue_entry' => Piwik::translate('General_ColumnRevenue'), ]); unset($entryPageGoalMetrics['revenue']); $entryPageGoalProcessedMetrics = array_merge($goalProcessedMetrics, [ 'revenue_per_entry' => Piwik::translate('General_ColumnValuePerEntry'), 'nb_conversions_entry_rate' => Piwik::translate('General_ColumnConversionRate'), ]); $entryPageGoalMetricTypes = array_merge($goalMetricTypes, [ 'nb_conversions_entry' => Dimension::TYPE_NUMBER, 'revenue_entry' => Dimension::TYPE_MONEY, 'revenue_per_entry' => Dimension::TYPE_NUMBER, 'nb_conversions_entry_rate' => Dimension::TYPE_PERCENT, ]); unset($entryPageGoalMetricTypes['revenue']); // add ecommerce metrics if idGoal is an ecommerce goal $idGoal = \Piwik\Request::fromRequest()->getParameter('idGoal', ''); if ($idGoal === Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_ORDER || $idGoal === Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_CART) { $extraEcommerceProcessedMetrics = [ 'avg_order_revenue' => Piwik::translate('General_AverageOrderValue'), 'items' => Piwik::translate('General_PurchasedProducts'), ]; $extraEcommerceMetricTypes = [ 'avg_order_revenue' => Dimension::TYPE_MONEY, 'itmes' => Dimension::TYPE_NUMBER, ]; $pageGoalProcessedMetrics = array_merge($pageGoalProcessedMetrics, $extraEcommerceProcessedMetrics); $entryPageGoalProcessedMetrics = array_merge($entryPageGoalProcessedMetrics, $extraEcommerceProcessedMetrics); $pageGoalMetricTypes = array_merge($pageGoalMetricTypes, $extraEcommerceMetricTypes); $entryPageGoalMetricTypes = array_merge($entryPageGoalMetricTypes, $extraEcommerceMetricTypes); } $reportsWithGoals = self::getAllReportsWithGoalMetrics(); foreach ($reportsWithGoals as $reportWithGoals) { $goalMetricsToUse = $goalMetrics; $goalProcessedMetricsToUse = $goalProcessedMetrics; $goalMetricTypesToUse = $goalMetricTypes; $request = $reportWithGoals['module'] . '.' . $reportWithGoals['action']; if (in_array($request, AddColumnsProcessedMetricsGoal::ACTIONS_PAGE_REPORTS_WITH_GOAL_METRICS)) { $goalMetricsToUse = $pageGoalMetrics; $goalProcessedMetricsToUse = $pageGoalProcessedMetrics; $goalMetricTypesToUse = $pageGoalMetricTypes; } elseif (in_array($request, AddColumnsProcessedMetricsGoal::ACTIONS_ENTRY_PAGE_REPORTS_WITH_GOAL_METRICS)) { $goalMetricsToUse = $entryPageGoalMetrics; $goalProcessedMetricsToUse = $entryPageGoalProcessedMetrics; $goalMetricTypesToUse = $entryPageGoalMetricTypes; } // Select this report from the API metadata array // and add the Goal metrics to it foreach ($reports as &$apiReportToUpdate) { if ( $apiReportToUpdate['module'] == $reportWithGoals['module'] && $apiReportToUpdate['action'] == $reportWithGoals['action'] && empty($apiReportToUpdate['parameters']) ) { $apiReportToUpdate['metricsGoal'] = $goalMetricsToUse; $apiReportToUpdate['processedMetricsGoal'] = $goalProcessedMetricsToUse; $apiReportToUpdate['metricTypesGoal'] = $goalMetricTypesToUse; 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_GoalNameHelpText'; $translationKeys[] = 'Goals_GoalNamePlaceholder'; $translationKeys[] = 'Goals_GoalDescriptionHelpText'; $translationKeys[] = 'Goals_GoalDescriptionPlaceholder'; $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_EventName'; $translationKeys[] = 'Goals_YouCanEnableEcommerceReports'; $translationKeys[] = 'Goals_CategoryTextGeneral_Actions'; $translationKeys[] = 'General_ForExampleShort'; $translationKeys[] = 'General_PleaseSpecifyValue'; $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'; $translationKeys[] = 'Goals_GoalCreated'; $translationKeys[] = 'Goals_GoalUpdated'; $translationKeys[] = 'Goals_ViewGoalReport'; } public function filterSegments(SegmentsList &$list, array $idSites) { $limitSegmentsSettingEnabled = false; if (empty($idSites)) { $limitSegmentsSettingEnabled = LimitSegments::getInstance()->getValue(); } else { foreach ($idSites as $idsite) { $limitSegmentsSettingEnabled |= LimitSegments::getInstance($idsite)->getValue(); } } if ($limitSegmentsSettingEnabled) { $list->remove('Goals_Conversion', 'orderId'); } } }