coderkun/questlab
1
0
Fork 0
Code Issues 15 Pull requests Projects Releases Wiki Activity

update Piwik to version 2.16 (fixes #91)

Browse source
This commit is contained in:
oliver 2016-04-10 18:55:57 +02:00
commit d885a4baa9
5833 changed files with 418860 additions and 226988 deletions
Download patch file Download diff file Expand all files Collapse all files

192
www/analytics/plugins/Events/Events.php
View file

@ -1,6 +1,6 @@
<?php
/**
* Piwik - Open source web analytics
* Piwik - free/libre analytics platform
*
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
@ -9,43 +9,31 @@
namespace Piwik\Plugins\Events;
use Piwik\Common;
use Piwik\Menu\MenuMain;
use Piwik\DataTable;
use Piwik\Piwik;
use Piwik\Plugin\Report;
use Piwik\Plugin\ViewDataTable;
use Piwik\WidgetsList;
use Piwik\Plugins\CoreVisualizations\Visualizations\HtmlTable\AllColumns;
/**
*/
class Events extends \Piwik\Plugin
{
/**
* @see Piwik\Plugin::getListHooksRegistered
* @see Piwik\Plugin::registerEvents
*/
public function getListHooksRegistered()
public function registerEvents()
{
return array(
'API.getSegmentDimensionMetadata' => 'getSegmentsMetadata',
'Metrics.getDefaultMetricTranslations' => 'addMetricTranslations',
'API.getReportMetadata' => 'getReportMetadata',
'Menu.Reporting.addItems' => 'addMenus',
'WidgetsList.addWidgets' => 'addWidgets',
'ViewDataTable.configure' => 'configureViewDataTable',
'Metrics.getDefaultMetricDocumentationTranslations' => 'addMetricDocumentationTranslations',
'Metrics.getDefaultMetricTranslations' => 'addMetricTranslations',
'ViewDataTable.configure' => 'configureViewDataTable',
'Live.getAllVisitorDetails' => 'extendVisitorDetails',
'AssetManager.getStylesheetFiles' => 'getStylesheetFiles',
);
}
public function addWidgets()
{
foreach(self::getLabelTranslations() as $apiMethod => $labels) {
$params = array(
'secondaryDimension' => API::getInstance()->getDefaultSecondaryDimension($apiMethod)
);
WidgetsList::add('Events_Events', $labels[0], 'Events', $apiMethod, $params);
}
}
public function addMenus()
public function extendVisitorDetails(&$visitor, $details)
{
MenuMain::getInstance()->add('General_Actions', 'Events_Events', array('module' => 'Events', 'action' => 'index'), true, 30);
$visitor['events'] = $details['visit_total_events'];
}
public function addMetricTranslations(&$translations)
@ -53,6 +41,11 @@ class Events extends \Piwik\Plugin
$translations = array_merge($translations, $this->getMetricTranslations());
}
public function addMetricDocumentationTranslations(&$translations)
{
$translations = array_merge($translations, $this->getMetricDocumentation());
}
public function getMetricDocumentation()
{
$documentation = array(
@ -94,7 +87,7 @@ class Events extends \Piwik\Plugin
/**
* @return array
*/
static public function getLabelTranslations()
public static function getLabelTranslations()
{
return array(
'getCategory' => array('Events_EventCategories', 'Events_EventCategory'),
@ -103,77 +96,6 @@ class Events extends \Piwik\Plugin
);
}
public function getSegmentsMetadata(&$segments)
{
$sqlFilter = '\\Piwik\\Tracker\\TableLogAction::getIdActionFromSegment';
foreach($this->metadataDimensions as $dimension => $metadata) {
$segments[] = array(
'type' => 'dimension',
'category' => 'Events_Events',
'name' => $metadata[0],
'segment' => $dimension,
'sqlSegment' => $metadata[1],
'sqlFilter' => $sqlFilter,
);
}
$segments[] = array(
'type' => 'metric',
'category' => Piwik::translate('General_Visit'),
'name' => 'Events_TotalEvents',
'segment' => 'events',
'sqlSegment' => 'log_visit.visit_total_events',
'acceptedValues' => 'To select all visits who triggered an Event, use: &segment=events>0',
);
// $segments[] = array(
// 'type' => 'metric',
// 'category' => 'Events_Events',
// 'name' => 'Events_EventValue',
// 'segment' => 'eventValue',
// 'sqlSegment' => 'log_link_visit_action.custom_float',
// 'sqlFilter' => '\\Piwik\\Plugins\\Events\\Events::getSegmentEventValue'
// );
}
//
// public static function getSegmentEventValue($valueToMatch, $sqlField, $matchType, $segmentName)
// {
// $andActionisNotEvent = \Piwik\Plugins\Actions\Archiver::getWhereClauseActionIsNotEvent();
// $andActionisEvent = str_replace("IS NULL", "IS NOT NULL", $andActionisNotEvent);
//
// return array(
// 'extraWhere' => $andActionisEvent,
// 'bind' => $valueToMatch
// );
// }
public function getReportMetadata(&$reports)
{
$metrics = $this->getMetricTranslations();
$documentation = $this->getMetricDocumentation();
$labelTranslations = $this->getLabelTranslations();
$order = 0;
foreach($labelTranslations as $action => $translations) {
$secondaryDimension = $this->getSecondaryDimensionFromRequest();
$actionToLoadSubtables = API::getInstance()->getActionToLoadSubtables($action, $secondaryDimension);
$reports[] = array(
'category' => Piwik::translate('Events_Events'),
'name' => Piwik::translate($translations[0]),
'module' => 'Events',
'action' => $action,
'dimension' => Piwik::translate($translations[1]),
'metrics' => $metrics,
'metricsDocumentation' => $documentation,
'processedMetrics' => false,
'actionToLoadSubTables' => $actionToLoadSubtables,
'order' => $order++
);
}
}
/**
* Given getCategory, returns "Event Categories"
*
@ -211,7 +133,7 @@ class Events extends \Piwik\Plugin
public function configureViewDataTable(ViewDataTable $view)
{
if($view->requestConfig->getApiModuleToRequest() != 'Events') {
if ($view->requestConfig->getApiModuleToRequest() != 'Events') {
return;
}
@ -220,30 +142,60 @@ class Events extends \Piwik\Plugin
$secondaryDimension = $this->getSecondaryDimensionFromRequest();
$view->config->subtable_controller_action = API::getInstance()->getActionToLoadSubtables($apiMethod, $secondaryDimension);
$view->config->columns_to_display = array('label', 'nb_events', 'sum_event_value');
if (Common::getRequestVar('pivotBy', false) === false) {
$view->config->columns_to_display = array('label', 'nb_events', 'sum_event_value');
}
$view->config->show_flatten_table = true;
$view->config->show_table_all_columns = false;
$view->requestConfig->filter_sort_column = 'nb_events';
if ($view->isViewDataTableId(AllColumns::ID)) {
$view->config->filters[] = function (DataTable $table) use ($view) {
$columsToDisplay = array('label');
$columns = $table->getColumns();
if (in_array('nb_visits', $columns)) {
$columsToDisplay[] = 'nb_visits';
}
if (in_array('nb_uniq_visitors', $columns)) {
$columsToDisplay[] = 'nb_uniq_visitors';
}
$view->config->columns_to_display = array_merge($columsToDisplay, array('nb_events', 'sum_event_value', 'avg_event_value', 'min_event_value', 'max_event_value'));
if (!in_array($view->requestConfig->filter_sort_column, $view->config->columns_to_display)) {
$view->requestConfig->filter_sort_column = 'nb_events';
}
};
$view->config->show_pivot_by_subtable = false;
}
$labelTranslation = $this->getColumnTranslation($apiMethod);
$view->config->addTranslation('label', $labelTranslation);
$view->config->addTranslations($this->getMetricTranslations());
$this->addRelatedReports($view, $secondaryDimension);
$this->addTooltipEventValue($view);
$subtableReport = Report::factory('Events', $view->config->subtable_controller_action);
$view->config->pivot_by_dimension = $subtableReport->getDimension()->getId();
$view->config->pivot_by_column = 'nb_events';
}
protected function addRelatedReports($view, $secondaryDimension)
private function addRelatedReports($view, $secondaryDimension)
{
if(empty($secondaryDimension)) {
if (empty($secondaryDimension)) {
// eg. Row Evolution
return;
}
$view->config->show_related_reports = true;
$apiMethod = $view->requestConfig->getApiMethodToRequest();
$secondaryDimensions = API::getInstance()->getSecondaryDimensions($apiMethod);
if(empty($secondaryDimensions)) {
if (empty($secondaryDimensions)) {
return;
}
@ -254,7 +206,7 @@ class Events extends \Piwik\Plugin
. Piwik::translate('Events_SwitchToSecondaryDimension', '');
foreach($secondaryDimensions as $dimension) {
if($dimension == $secondaryDimension) {
if ($dimension == $secondaryDimension) {
// don't show as related report the currently selected dimension
continue;
}
@ -269,13 +221,16 @@ class Events extends \Piwik\Plugin
}
protected function addTooltipEventValue($view)
private function addTooltipEventValue(ViewDataTable $view)
{
// Creates the tooltip message for Event Value column
$tooltipCallback = function ($hits, $min, $max, $avg) {
if (!$hits) {
return false;
}
$avg = $avg ?: 0;
$msgEventMinMax = Piwik::translate("Events_EventValueTooltip", array($hits, "<br />", $min, $max));
$msgEventAvg = Piwik::translate("Events_AvgEventValue", $avg);
return $msgEventMinMax . "<br/>" . $msgEventAvg;
@ -283,24 +238,29 @@ class Events extends \Piwik\Plugin
// Add tooltip metadata column to the DataTable
$view->config->filters[] = array('ColumnCallbackAddMetadata',
array(
array(
'nb_events',
'min_event_value',
'max_event_value',
'avg_event_value'
),
'sum_event_value_tooltip',
$tooltipCallback
)
array(
array(
'nb_events',
'min_event_value',
'max_event_value',
'avg_event_value'
),
'sum_event_value_tooltip',
$tooltipCallback
)
);
}
/**
* @return mixed
*/
protected function getSecondaryDimensionFromRequest()
public function getSecondaryDimensionFromRequest()
{
return Common::getRequestVar('secondaryDimension', false, 'string');
}
public function getStylesheetFiles(&$stylesheets)
{
$stylesheets[] = "plugins/Events/stylesheets/datatable.less";
}
}