114 lines
4.7 KiB
PHP
114 lines
4.7 KiB
PHP
<?php
|
|
/**
|
|
* Piwik - Open source web analytics
|
|
*
|
|
* @link http://piwik.org
|
|
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
|
|
*
|
|
*/
|
|
namespace Piwik\Plugins\VisitorInterest;
|
|
|
|
use Piwik\Archive;
|
|
use Piwik\DataTable;
|
|
use Piwik\Metrics;
|
|
use Piwik\Piwik;
|
|
|
|
/**
|
|
* VisitorInterest API lets you access two Visitor Engagement reports: number of visits per number of pages,
|
|
* and number of visits per visit duration.
|
|
*
|
|
* @method static \Piwik\Plugins\VisitorInterest\API getInstance()
|
|
*/
|
|
class API extends \Piwik\Plugin\API
|
|
{
|
|
protected function getDataTable($name, $idSite, $period, $date, $segment, $column = Metrics::INDEX_NB_VISITS)
|
|
{
|
|
Piwik::checkUserHasViewAccess($idSite);
|
|
$archive = Archive::build($idSite, $period, $date, $segment);
|
|
$dataTable = $archive->getDataTable($name);
|
|
$dataTable->queueFilter('ReplaceColumnNames');
|
|
return $dataTable;
|
|
}
|
|
|
|
public function getNumberOfVisitsPerVisitDuration($idSite, $period, $date, $segment = false)
|
|
{
|
|
$dataTable = $this->getDataTable(Archiver::TIME_SPENT_RECORD_NAME, $idSite, $period, $date, $segment);
|
|
$dataTable->queueFilter('Sort', array('label', 'asc', true));
|
|
$dataTable->queueFilter('BeautifyTimeRangeLabels', array(
|
|
Piwik::translate('VisitorInterest_BetweenXYSeconds'),
|
|
Piwik::translate('VisitorInterest_OneMinute'),
|
|
Piwik::translate('VisitorInterest_PlusXMin')));
|
|
return $dataTable;
|
|
}
|
|
|
|
public function getNumberOfVisitsPerPage($idSite, $period, $date, $segment = false)
|
|
{
|
|
$dataTable = $this->getDataTable(Archiver::PAGES_VIEWED_RECORD_NAME, $idSite, $period, $date, $segment);
|
|
$dataTable->queueFilter('Sort', array('label', 'asc', true));
|
|
$dataTable->queueFilter('BeautifyRangeLabels', array(
|
|
Piwik::translate('VisitorInterest_OnePage'),
|
|
Piwik::translate('VisitorInterest_NPages')));
|
|
return $dataTable;
|
|
}
|
|
|
|
/**
|
|
* Returns a DataTable that associates counts of days (N) with the count of visits that
|
|
* occurred within N days of the last visit.
|
|
*
|
|
* @param int $idSite The site to select data from.
|
|
* @param string $period The period type.
|
|
* @param string $date The date type.
|
|
* @param string|bool $segment The segment.
|
|
* @return DataTable the archived report data.
|
|
*/
|
|
public function getNumberOfVisitsByDaysSinceLast($idSite, $period, $date, $segment = false)
|
|
{
|
|
$dataTable = $this->getDataTable(
|
|
Archiver::DAYS_SINCE_LAST_RECORD_NAME, $idSite, $period, $date, $segment, Metrics::INDEX_NB_VISITS);
|
|
$dataTable->queueFilter('BeautifyRangeLabels', array(Piwik::translate('General_OneDay'), Piwik::translate('General_NDays')));
|
|
return $dataTable;
|
|
}
|
|
|
|
/**
|
|
* Returns a DataTable that associates ranges of visit numbers with the count of visits
|
|
* whose visit number falls within those ranges.
|
|
*
|
|
* @param int $idSite The site to select data from.
|
|
* @param string $period The period type.
|
|
* @param string $date The date type.
|
|
* @param string|bool $segment The segment.
|
|
* @return DataTable the archived report data.
|
|
*/
|
|
public function getNumberOfVisitsByVisitCount($idSite, $period, $date, $segment = false)
|
|
{
|
|
$dataTable = $this->getDataTable(
|
|
Archiver::VISITS_COUNT_RECORD_NAME, $idSite, $period, $date, $segment, Metrics::INDEX_NB_VISITS);
|
|
|
|
$dataTable->queueFilter('BeautifyRangeLabels', array(
|
|
Piwik::translate('General_OneVisit'), Piwik::translate('General_NVisits')));
|
|
|
|
// add visit percent column
|
|
self::addVisitsPercentColumn($dataTable);
|
|
|
|
return $dataTable;
|
|
}
|
|
|
|
/**
|
|
* Utility function that adds a visit percent column to a data table,
|
|
* regardless of whether the data table is an data table array or just
|
|
* a data table.
|
|
*
|
|
* @param DataTable $dataTable The data table to modify.
|
|
*/
|
|
private static function addVisitsPercentColumn($dataTable)
|
|
{
|
|
if ($dataTable instanceof DataTable\Map) {
|
|
foreach ($dataTable->getDataTables() as $table) {
|
|
self::addVisitsPercentColumn($table);
|
|
}
|
|
} else {
|
|
$totalVisits = array_sum($dataTable->getColumn(Metrics::INDEX_NB_VISITS));
|
|
$dataTable->queueFilter('ColumnCallbackAddColumnPercentage', array('nb_visits_percentage', 'nb_visits', $totalVisits));
|
|
}
|
|
}
|
|
}
|