PKPStatsQueryBuilder.inc.php

<?php
 
namespace PKP\Services\QueryBuilders;
 
use Illuminate\Database\Capsule\Manager as Capsule;
 
class PKPStatsQueryBuilder {
 
   protected $assocIds = [];
 
   protected $assocTypes = [];
 
   protected $contextIds = [];
 
   protected $dateEnd;
 
   protected $dateStart;
 
   protected $fileTypes;
 
   protected $sectionIds = [];
 
   protected $submissionIds = [];
 
   public function filterByContexts($contextIds) {
      $this->contextIds = is_array($contextIds) ? $contextIds : [$contextIds];
      return $this;
   }
 
   public function filterBySubmissions($submissionIds) {
      $this->submissionIds = is_array($submissionIds) ? $submissionIds : [$submissionIds];
      return $this;
   }
 
   public function filterByAssocTypes($assocTypes) {
      $this->assocTypes = is_array($assocTypes) ? $assocTypes : [$assocTypes];
      return $this;
   }
 
   public function filterByAssocIds($assocIds) {
      $this->assocIds = is_array($assocIds) ? $assocIds : [$assocIds];
      return $this;
   }
 
   public function filterByFileTypes($fileTypes) {
      $this->fileTypes = is_array($fileTypes) ? $fileTypes : [$fileTypes];
      return $this;
   }
 
   public function filterBySections($sectionIds) {
      $this->sectionIds = is_array($sectionIds) ? $sectionIds : [$sectionIds];
      return $this;
   }
 
   public function before($dateEnd) {
      $this->dateEnd = str_replace('-', '', $dateEnd);
      return $this;
   }
 
   public function after($dateStart) {
      $this->dateStart = str_replace('-', '', $dateStart);
      return $this;
   }
 
   public function getRecords() {
      return $this->_getObject()->select('*');
   }
 
   public function getSum($groupBy = []) {
      $q = $this->_getObject();
 
      $q->select(array_merge(
         [Capsule::raw('SUM(metric) as metric')],
         $groupBy
      ));
 
      if (!empty($groupBy)) {
         $q->groupBy($groupBy);
      }
 
      return $q;
   }
 
   public function getTimeline($date) {
      $q = $this->_getObject();
      $q->select(Capsule::raw('SUM(metric) as metric'));
      if (strlen($date) === 10) {
         $q->where(STATISTICS_DIMENSION_DAY, '=', str_replace('-', '', $date));
      } else {
         $q->where(STATISTICS_DIMENSION_MONTH, '=', str_replace('-', '', $date));
      }
      return $q;
   }
 
   public function getSubmissionIds() {
      return $this->_getObject()
         ->select('submission_id')
         ->groupBy('submission_id');
   }
 
   protected function _getObject() {
      $q = Capsule::table('metrics');
 
      if (!empty($this->contextIds)) {
         $q->whereIn(STATISTICS_DIMENSION_CONTEXT_ID, $this->contextIds);
      }
 
      if (!empty($this->submissionIds)) {
         $q->whereIn(STATISTICS_DIMENSION_SUBMISSION_ID, $this->submissionIds);
      }
 
      if (!empty($this->sectionIds)) {
         $q->whereIn(STATISTICS_DIMENSION_PKP_SECTION_ID, $this->sectionIds);
      }
 
      if (!empty($this->assocTypes)) {
         $q->whereIn(STATISTICS_DIMENSION_ASSOC_TYPE, $this->assocTypes);
 
         if (!empty($this->assocIds)) {
            $q->whereIn(STATISTICS_DIMENSION_ASSOC_ID, $this->assocIds);
         }
      }
 
      if (!empty($this->fileTypes)) {
         $q->whereIn(STATISTICS_DIMENSION_FILE_TYPE, $this->fileTypes);
      }
 
      $q->whereBetween(STATISTICS_DIMENSION_DAY, [$this->dateStart, $this->dateEnd]);
 
      $q->where(STATISTICS_DIMENSION_METRIC_TYPE, '=', METRIC_TYPE_COUNTER);
 
      \HookRegistry::call('Stats::queryObject', array($q, $this));
 
      return $q;
   }
}