Alex Savenko / analytics

  <?php
  /**
   * Created by PhpStorm.
   * User: Alex Savenko
   * Date: 09.02.2017
   * Time: 18:12
   */
  
  namespace App\Controllers;
  
  

  use App\Model\Project;

  use Google_Client;
  use Google_Service_AnalyticsReporting;
  use Google_Service_AnalyticsReporting_DateRange;

  use Google_Service_AnalyticsReporting_Dimension;

  use Google_Service_AnalyticsReporting_GetReportsRequest;
  use Google_Service_AnalyticsReporting_Metric;
  use Google_Service_AnalyticsReporting_ReportRequest;

  use PhalconRest\Mvc\Controllers\CrudResourceController;

  
  class GaController extends CrudResourceController {
  

      const SECRET_JSON = 'ca4a1bd8aa14.json';
      const VIEW_ID = '119240817';

      const SCOPE = 'https://www.googleapis.com/auth/analytics.readonly';

      public function getAction() {
  

          /** user params **/

          $user_id    = $this->request->get('user_id')?? '1';
          $view_id    = $this->request->get('view_id');
          $chart      = $this->request->get('chart') ?? false;

  
          /** google params **/

          $get_metrics        = $this->request->get('metric') ?? 'users';
          $get_dimensions     = $this->request->get('dimension');
          $get_start_date     = $this->request->get('start') ?? '30daysAgo';
          $get_end_date       = $this->request->get('end') ?? 'today';
          $filter_expression  = $this->request->get('filter');

          if (empty($view_id)) {

              $result = [];

              $projects = Project::find(['user_id' => $user_id]);

              foreach ($projects as $project) {

                  $view_id = (string)$project->ga_view_id;

                  if (!empty($view_id)) {

                      $result[] = $this->sendGaRequest($project->name, $view_id, $get_metrics, $get_dimensions, $get_start_date, $get_end_date, $chart, $filter_expression);

                  }

              }
          }
          else {

              $project = Project::findFirst(['ga_view_id' => $view_id]);

              $result = $this->sendGaRequest($project->name , $view_id, $get_metrics, $get_dimensions, $get_start_date, $get_end_date, $chart, $filter_expression);

          }

          return $result;

  
      }
  

      /**
       * Send request to Google Analytics Reporting API
       *
       * @param   string  $project_name
       * @param   string  $view
       * @param   string  $get_metrics
       * @param   string  $get_dimensions
       * @param   string  $start
       * @param   string  $end
       * @param   bool    $chart
       * @param   string  $filter_expression
       * @return  array
       */

      public function sendGaRequest($project_name, $view, $get_metrics, $get_dimensions, $start, $end, $chart = false, $filter_expression = null) {

          putenv('GOOGLE_APPLICATION_CREDENTIALS=/var/www/phalcon/'.self::SECRET_JSON);
          $client = new Google_Client();
          $client->useApplicationDefaultCredentials();

          $client->setScopes([self::SCOPE]);

          $analytics = new Google_Service_AnalyticsReporting($client);
  

          /** Create the DateRange object. **/

          $dateRange = new Google_Service_AnalyticsReporting_DateRange();

          $dateRange->setStartDate($start);
          $dateRange->setEndDate($end);

          /** Create the Metrics object. **/

          $metrics = [];

          $get_metrics = explode(',', $get_metrics);

          foreach ($get_metrics as $metric) {
              $metrics_obj = new Google_Service_AnalyticsReporting_Metric();
              $metrics_obj->setExpression('ga:'.$metric);

              $metrics_obj->setAlias('ga:'.$metric);

              $metrics[] = $metrics_obj;
          }

          /** Create the Dimensions object.  **/

          if (!empty($get_dimensions)) {

              $dimensions = [];
              $get_dimensions = explode(',', $get_dimensions);
              foreach ($get_dimensions as $dimension) {
                  $dimension_obj = new Google_Service_AnalyticsReporting_Dimension();
                  $dimension_obj->setName("ga:".$dimension);
                  $dimensions[] = $dimension_obj;
              }

          }

          /** Create the ReportRequest object.  **/

          $request = new Google_Service_AnalyticsReporting_ReportRequest();

          $request->setViewId($view);

          $request->setDateRanges($dateRange);

          $request->setIncludeEmptyRows(true);

          if (!empty($dimensions)) {
              $request->setDimensions(array($dimensions));
          }

          $request->setMetrics(array($metrics));

          if (!empty($filter_expression)) {
              $request->setFiltersExpression("ga:".$filter_expression);
          }

          $body = new Google_Service_AnalyticsReporting_GetReportsRequest();

          $body->setReportRequests(array($request));

          $response =  $analytics->reports->batchGet($body);

          /** can be refactored (code below 2 rows)  **/

          $response = $response->toSimpleObject();

          $response = $response->reports[0]['data']['rows'];

          if ($chart) {
              $result = self::responseChartTransform($response, $project_name);
          } else {
              $result = self::responseDataTransform($response, $project_name);
          }

          return $result;

  
      }
  

      /**
       * Data-transformer for tables. Used by default.
       *
       * @param   array   $response
       * @param   string  $project_name
       * @return  array
       */

      public static function responseDataTransform(array $response, $project_name) {

          $result = [];

          foreach ($response as $item) {

  
              $metric_val = $item['metrics'][0]['values'];
              $dimension_val = $item['dimensions'][0];
  

              $result['name'] = $project_name;
  

              if (count($metric_val) > 1) {

                  for ($i = 0; $i < count($metric_val); $i++) {
                      $result[$dimension_val][] = $metric_val[$i];

                  }
              } else {
                  $result[$dimension_val] = $metric_val[0];
              }

          }
  

          return $result;

      }

      /**
       * Data-transformer for charts, when query string contains "?chart=true"
       *
       * @param   array   $response
       * @param   string  $project_name
       * @return  array
       */

      public static function responseChartTransform(array $response, $project_name) {
  
          $result = [];

          foreach ($response as $item) {
  
              $metric_val = $item['metrics'][0]['values'];

              $result['name'] = $project_name;

  
              if (count($metric_val) > 1) {
                  for ($i = 0; $i < count($metric_val); $i++) {

                      $result['data'][] = (int)$metric_val[$i];

                  }
              } else {

                  $result['data'][] = (int)$metric_val[0];

              }
          }
  
          return $result;
  
      }
  

      /**
       * without usage, from google docs.
       */

      public function printResults($reports) {
          $res = '';
          for ( $reportIndex = 0; $reportIndex < count( $reports ); $reportIndex++ ) {
              $report = $reports[ $reportIndex ];
              $header = $report->getColumnHeader();
              $dimensionHeaders = $header->getDimensions();
              $metricHeaders = $header->getMetricHeader()->getMetricHeaderEntries();
              $rows = $report->getData()->getRows();
  
              for ( $rowIndex = 0; $rowIndex < count($rows); $rowIndex++) {
                  $row = $rows[ $rowIndex ];
                  $dimensions = $row->getDimensions();
                  $metrics = $row->getMetrics();
                  for ($i = 0; $i < count($dimensionHeaders) && $i < count($dimensions); $i++) {
                      print($dimensionHeaders[$i] . ": " . $dimensions[$i] . "\n");
                  }
  
                  for ($j = 0; $j < count( $metricHeaders ) && $j < count( $metrics ); $j++) {
                      $entry = $metricHeaders[$j];
                      $values = $metrics[$j];
                      //print("Metric type: " . $entry->getType() . "\n" );
                      for ( $valueIndex = 0; $valueIndex < count( $values->getValues() ); $valueIndex++ ) {
                          $value = $values->getValues()[ $valueIndex ];
                          $res .= "<b>" . $entry->getName() . "</b>: " . $value . '<br/>';
                      }
                  }
              }
          }
  
          return $res;
      }
  

  }