diff options
Diffstat (limited to 'plugins/VisitsSummary/API.php')
| -rw-r--r-- | plugins/VisitsSummary/API.php | 274 |
1 files changed, 132 insertions, 142 deletions
diff --git a/plugins/VisitsSummary/API.php b/plugins/VisitsSummary/API.php index 9294e03b74..0864c517b5 100644 --- a/plugins/VisitsSummary/API.php +++ b/plugins/VisitsSummary/API.php @@ -17,146 +17,136 @@ */ class Piwik_VisitsSummary_API { - static private $instance = null; - /** - * @return Piwik_VisitsSummary_API - */ - static public function getInstance() - { - if (self::$instance == null) - { - self::$instance = new self; - } - return self::$instance; - } - - public function get( $idSite, $period, $date, $segment = false, $columns = false) - { - Piwik::checkUserHasViewAccess( $idSite ); - $archive = Piwik_Archive::build($idSite, $period, $date, $segment ); - - // array values are comma separated - $columns = Piwik::getArrayFromApiParameter($columns); - $tempColumns = array(); - - $bounceRateRequested = $actionsPerVisitRequested = $averageVisitDurationRequested = false; - if(!empty($columns)) - { - // make sure base metrics are there for processed metrics - if(false !== ($bounceRateRequested = array_search('bounce_rate', $columns))) - { - if (!in_array('nb_visits', $columns)) $tempColumns[] = 'nb_visits'; - if (!in_array('bounce_count', $columns)) $tempColumns[] = 'bounce_count'; - unset($columns[$bounceRateRequested]); - } - if(false !== ($actionsPerVisitRequested = array_search('nb_actions_per_visit', $columns))) - { - if (!in_array('nb_visits', $columns)) $tempColumns[] = 'nb_visits'; - if (!in_array('nb_actions', $columns)) $tempColumns[] = 'nb_actions'; - unset($columns[$actionsPerVisitRequested]); - } - if(false !== ($averageVisitDurationRequested = array_search('avg_time_on_site', $columns))) - { - if (!in_array('nb_visits', $columns)) $tempColumns[] = 'nb_visits'; - if (!in_array('sum_visit_length', $columns)) $tempColumns[] = 'sum_visit_length'; - unset($columns[$averageVisitDurationRequested]); - } - $tempColumns = array_unique($tempColumns); - rsort($tempColumns); - $columns = array_merge($columns, $tempColumns); - } - else - { - $bounceRateRequested = $actionsPerVisitRequested = $averageVisitDurationRequested = true; - $columns = array( - 'nb_visits', - 'nb_actions', - 'nb_visits_converted', - 'bounce_count', - 'sum_visit_length', - 'max_actions' - ); - if(Piwik::isUniqueVisitorsEnabled($period)) - { - $columns = array_merge(array('nb_uniq_visitors'), $columns); - } - // Force reindex from 0 to N otherwise the SQL bind will fail - $columns = array_values($columns); - } - - $dataTable = $archive->getDataTableFromNumeric($columns); - - // Process ratio metrics from base metrics, when requested - if($bounceRateRequested !== false) - { - $dataTable->filter('ColumnCallbackAddColumnPercentage', array('bounce_rate', 'bounce_count', 'nb_visits', 0)); - } - if($actionsPerVisitRequested !== false) - { - $dataTable->filter('ColumnCallbackAddColumnQuotient', array('nb_actions_per_visit', 'nb_actions', 'nb_visits', 1)); - } - if($averageVisitDurationRequested !== false) - { - $dataTable->filter('ColumnCallbackAddColumnQuotient', array('avg_time_on_site', 'sum_visit_length', 'nb_visits', 0)); - } - - // remove temp metrics that were used to compute processed metrics - $dataTable->deleteColumns($tempColumns); - - return $dataTable; - } - - protected function getNumeric( $idSite, $period, $date, $segment, $toFetch ) - { - Piwik::checkUserHasViewAccess( $idSite ); - $archive = Piwik_Archive::build($idSite, $period, $date, $segment ); - $dataTable = $archive->getNumeric($toFetch); - return $dataTable; - } - - public function getVisits( $idSite, $period, $date, $segment = false ) - { - return $this->getNumeric( $idSite, $period, $date, $segment, 'nb_visits'); - } - - public function getUniqueVisitors( $idSite, $period, $date, $segment = false ) - { - return $this->getNumeric( $idSite, $period, $date, $segment, 'nb_uniq_visitors'); - } - - public function getActions( $idSite, $period, $date, $segment = false ) - { - return $this->getNumeric( $idSite, $period, $date, $segment, 'nb_actions'); - } - - public function getMaxActions( $idSite, $period, $date, $segment = false ) - { - return $this->getNumeric( $idSite, $period, $date, $segment, 'max_actions'); - } - - public function getBounceCount( $idSite, $period, $date, $segment = false ) - { - return $this->getNumeric( $idSite, $period, $date, $segment, 'bounce_count'); - } - - public function getVisitsConverted( $idSite, $period, $date, $segment = false ) - { - return $this->getNumeric( $idSite, $period, $date, $segment, 'nb_visits_converted'); - } - - public function getSumVisitsLength( $idSite, $period, $date, $segment = false ) - { - return $this->getNumeric( $idSite, $period, $date, $segment, 'sum_visit_length'); - } - - public function getSumVisitsLengthPretty( $idSite, $period, $date, $segment = false ) - { - $table = $this->getSumVisitsLength( $idSite, $period, $date, $segment ); - if($table instanceof Piwik_DataTable_Array) { - $table->filter('ColumnCallbackReplace', array(0, array('Piwik', 'getPrettyTimeFromSeconds'))); - } else { - $table = Piwik::getPrettyTimeFromSeconds($table); - } - return $table; - } + static private $instance = null; + + /** + * @return Piwik_VisitsSummary_API + */ + static public function getInstance() + { + if (self::$instance == null) { + self::$instance = new self; + } + return self::$instance; + } + + public function get($idSite, $period, $date, $segment = false, $columns = false) + { + Piwik::checkUserHasViewAccess($idSite); + $archive = Piwik_Archive::build($idSite, $period, $date, $segment); + + // array values are comma separated + $columns = Piwik::getArrayFromApiParameter($columns); + $tempColumns = array(); + + $bounceRateRequested = $actionsPerVisitRequested = $averageVisitDurationRequested = false; + if (!empty($columns)) { + // make sure base metrics are there for processed metrics + if (false !== ($bounceRateRequested = array_search('bounce_rate', $columns))) { + if (!in_array('nb_visits', $columns)) $tempColumns[] = 'nb_visits'; + if (!in_array('bounce_count', $columns)) $tempColumns[] = 'bounce_count'; + unset($columns[$bounceRateRequested]); + } + if (false !== ($actionsPerVisitRequested = array_search('nb_actions_per_visit', $columns))) { + if (!in_array('nb_visits', $columns)) $tempColumns[] = 'nb_visits'; + if (!in_array('nb_actions', $columns)) $tempColumns[] = 'nb_actions'; + unset($columns[$actionsPerVisitRequested]); + } + if (false !== ($averageVisitDurationRequested = array_search('avg_time_on_site', $columns))) { + if (!in_array('nb_visits', $columns)) $tempColumns[] = 'nb_visits'; + if (!in_array('sum_visit_length', $columns)) $tempColumns[] = 'sum_visit_length'; + unset($columns[$averageVisitDurationRequested]); + } + $tempColumns = array_unique($tempColumns); + rsort($tempColumns); + $columns = array_merge($columns, $tempColumns); + } else { + $bounceRateRequested = $actionsPerVisitRequested = $averageVisitDurationRequested = true; + $columns = array( + 'nb_visits', + 'nb_actions', + 'nb_visits_converted', + 'bounce_count', + 'sum_visit_length', + 'max_actions' + ); + if (Piwik::isUniqueVisitorsEnabled($period)) { + $columns = array_merge(array('nb_uniq_visitors'), $columns); + } + // Force reindex from 0 to N otherwise the SQL bind will fail + $columns = array_values($columns); + } + + $dataTable = $archive->getDataTableFromNumeric($columns); + + // Process ratio metrics from base metrics, when requested + if ($bounceRateRequested !== false) { + $dataTable->filter('ColumnCallbackAddColumnPercentage', array('bounce_rate', 'bounce_count', 'nb_visits', 0)); + } + if ($actionsPerVisitRequested !== false) { + $dataTable->filter('ColumnCallbackAddColumnQuotient', array('nb_actions_per_visit', 'nb_actions', 'nb_visits', 1)); + } + if ($averageVisitDurationRequested !== false) { + $dataTable->filter('ColumnCallbackAddColumnQuotient', array('avg_time_on_site', 'sum_visit_length', 'nb_visits', 0)); + } + + // remove temp metrics that were used to compute processed metrics + $dataTable->deleteColumns($tempColumns); + + return $dataTable; + } + + protected function getNumeric($idSite, $period, $date, $segment, $toFetch) + { + Piwik::checkUserHasViewAccess($idSite); + $archive = Piwik_Archive::build($idSite, $period, $date, $segment); + $dataTable = $archive->getNumeric($toFetch); + return $dataTable; + } + + public function getVisits($idSite, $period, $date, $segment = false) + { + return $this->getNumeric($idSite, $period, $date, $segment, 'nb_visits'); + } + + public function getUniqueVisitors($idSite, $period, $date, $segment = false) + { + return $this->getNumeric($idSite, $period, $date, $segment, 'nb_uniq_visitors'); + } + + public function getActions($idSite, $period, $date, $segment = false) + { + return $this->getNumeric($idSite, $period, $date, $segment, 'nb_actions'); + } + + public function getMaxActions($idSite, $period, $date, $segment = false) + { + return $this->getNumeric($idSite, $period, $date, $segment, 'max_actions'); + } + + public function getBounceCount($idSite, $period, $date, $segment = false) + { + return $this->getNumeric($idSite, $period, $date, $segment, 'bounce_count'); + } + + public function getVisitsConverted($idSite, $period, $date, $segment = false) + { + return $this->getNumeric($idSite, $period, $date, $segment, 'nb_visits_converted'); + } + + public function getSumVisitsLength($idSite, $period, $date, $segment = false) + { + return $this->getNumeric($idSite, $period, $date, $segment, 'sum_visit_length'); + } + + public function getSumVisitsLengthPretty($idSite, $period, $date, $segment = false) + { + $table = $this->getSumVisitsLength($idSite, $period, $date, $segment); + if ($table instanceof Piwik_DataTable_Array) { + $table->filter('ColumnCallbackReplace', array(0, array('Piwik', 'getPrettyTimeFromSeconds'))); + } else { + $table = Piwik::getPrettyTimeFromSeconds($table); + } + return $table; + } } |