public function GoogleAnalyticsCounterController::dashboard in Google Analytics Counter 8.3

1 string reference to 'GoogleAnalyticsCounterController::dashboard'

google_analytics_counter.routing.yml in ./google_analytics_counter.routing.yml

google_analytics_counter.routing.yml

File

src/Controller/GoogleAnalyticsCounterController.php, line 115

Class

GoogleAnalyticsCounterController

Class GoogleAnalyticsCounterController.

Namespace

Drupal\google_analytics_counter\Controller

Code

public function dashboard() {
  if (!$this->authManager
    ->isAuthenticated() === TRUE) {
    $build = [];
    $this->messageManager
      ->notAuthenticatedMessage();

    // Add a link to the revoke form.
    $build = $this->messageManager
      ->revokeAuthenticationMessage($build);
    return $build;
  }
  $build = [];
  $build['intro'] = [
    '#type' => 'html_tag',
    '#tag' => 'h4',
    '#value' => $this
      ->t('Information on this page is updated during cron runs.') . '</h4>',
  ];

  // Information from Google.
  $build['google_info'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Information from Google Analytics API'),
    '#open' => TRUE,
  ];

  // Get and format total pageviews.
  $t_args = $this->messageManager
    ->setStartDateEndDate();
  $t_args += [
    '%total_pageviews' => number_format($this->state
      ->get('google_analytics_counter.total_pageviews')),
  ];
  $build['google_info']['total_pageviews'] = [
    '#type' => 'html_tag',
    '#tag' => 'p',
    '#value' => $this
      ->t('%total_pageviews pageviews were recorded by Google Analytics for this view between %start_date - %end_date.', $t_args),
  ];

  // Get and format total paths.
  $t_args = $this->messageManager
    ->setStartDateEndDate();
  $t_args += [
    '%total_paths' => number_format($this->state
      ->get('google_analytics_counter.total_paths')),
  ];
  $build['google_info']['total_paths'] = [
    '#type' => 'html_tag',
    '#tag' => 'p',
    '#value' => $this
      ->t('%total_paths paths were recorded by Google Analytics for this view between %start_date - %end_date.', $t_args),
  ];

  // Get the most recent query or print helpful message for site builders.
  if (!$this->state
    ->get('google_analytics_counter.most_recent_query')) {
    $t_args = [
      '%most_recent_query' => 'No query has been run yet or Google is not running queries from your system. See the module\'s README.md or Google\'s documentation.',
    ];
  }
  else {
    $t_args = [
      '%most_recent_query' => $this->state
        ->get('google_analytics_counter.most_recent_query'),
    ];
  }
  $build['google_info']['google_query'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Recent query to Google'),
    '#open' => FALSE,
  ];
  $build['google_info']['google_query']['most_recent_query'] = [
    '#type' => 'html_tag',
    '#tag' => 'p',
    '#value' => $this
      ->t('%most_recent_query', $t_args) . '<br /><br />' . $this
      ->t('The access_token needs to be included with the query. Get the access_token with <em>drush state-get google_analytics_counter.access_token</em>'),
  ];

  // If available, print dataLastRefreshed from Google.
  if ($this->state
    ->get('google_analytics_counter.data_last_refreshed')) {
    $data_last_refreshed = $this->dateFormatter
      ->format($this->state
      ->get('google_analytics_counter.data_last_refreshed'), 'custom', 'M d, Y h:i:sa') . $this
      ->t(' is when Google last refreshed analytics data.');
  }
  else {
    $data_last_refreshed = "Google's last refreshed analytics data is currently unavailable.";
  }
  $t_arg = [
    '%data_last_refreshed' => $data_last_refreshed,
  ];
  $build['google_info']['data_last_refreshed'] = [
    '#type' => 'html_tag',
    '#tag' => 'p',
    '#value' => $this
      ->t('%data_last_refreshed', $t_arg),
  ];

  // Print a message about Google quotas with an embedded link to Analytics API.
  $t_args = [
    ':href' => $this->messageManager
      ->googleProjectName(),
    '@href' => 'Analytics API',
  ];
  $build['google_info']['daily_quota'] = [
    '#type' => 'html_tag',
    '#tag' => 'p',
    '#value' => $this
      ->t('Refer to your <a href=:href target="_blank">@href</a> page to view quotas.', $t_args),
  ];

  // Information from Drupal.
  $build['drupal_info'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Information from this site'),
    '#open' => TRUE,
  ];
  $build['drupal_info']['number_paths_stored'] = [
    '#type' => 'html_tag',
    '#tag' => 'p',
    '#value' => $this
      ->t('%num_of_results paths are currently stored in the local database table.', [
      '%num_of_results' => number_format(GoogleAnalyticsCounterHelper::getCount('google_analytics_counter')),
    ]),
  ];
  $build['drupal_info']['total_nodes'] = [
    '#type' => 'html_tag',
    '#tag' => 'p',
    '#value' => $this
      ->t('%totalnodes nodes are published on this site.', [
      '%totalnodes' => number_format($this->state
        ->get('google_analytics_counter.total_nodes')),
    ]),
  ];
  $build['drupal_info']['total_nodes_with_pageviews'] = [
    '#type' => 'html_tag',
    '#tag' => 'p',
    '#value' => $this
      ->t('%num_of_results nodes on this site have pageview counts <em>greater than zero</em>.', [
      '%num_of_results' => number_format(GoogleAnalyticsCounterHelper::getCount('google_analytics_counter_storage')),
    ]),
  ];
  $t_args = [
    '%num_of_results' => number_format(GoogleAnalyticsCounterHelper::getCount('google_analytics_counter_storage_all_nodes')),
  ];
  $build['drupal_info']['total_nodes_equal_zero'] = [
    '#type' => 'html_tag',
    '#tag' => 'p',
    '#value' => $this
      ->t('%num_of_results nodes on this site have pageview counts.<br /><strong>Note:</strong> The nodes on this site that have pageview counts should equal the number of published nodes.', $t_args),
  ];
  $t_args = [
    '%queue_count' => number_format(GoogleAnalyticsCounterHelper::getCount('queue')),
    ':href' => Url::fromRoute('google_analytics_counter.admin_settings_form', [], [
      'absolute' => TRUE,
    ])
      ->toString(),
    '@href' => 'settings form',
  ];
  $build['drupal_info']['queue_count'] = [
    '#type' => 'html_tag',
    '#tag' => 'p',
    '#value' => $this
      ->t('%queue_count items are in the queue. The number of items in the queue should be 0 after cron runs.<br />Having 0 items in the queue confirms that pageview counts are up to date. Increase Queue Time on the <a href=:href>@href</a> to process all the queued items.', $t_args),
  ];

  // Top Twenty Results.
  $build['drupal_info']['top_twenty_results'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Top Twenty Results'),
    '#open' => TRUE,
  ];

  // Top Twenty Results for Google Analytics Counter table.
  $build['drupal_info']['top_twenty_results']['counter'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('The pages visited'),
    '#open' => FALSE,
    '#attributes' => [
      'class' => [
        'google-analytics-counter-counter',
      ],
    ],
  ];
  $build['drupal_info']['top_twenty_results']['counter']['summary'] = [
    '#type' => 'html_tag',
    '#tag' => 'p',
    '#value' => $this
      ->t("The pages visited, listed by URI. The URI is the portion of a page's URL following the domain name; for example, the URI portion of www.example.com/contact.html is /contact.html."),
  ];
  $rows = $this->messageManager
    ->getTopTwentyResults('google_analytics_counter');

  // Display table.
  $build['drupal_info']['top_twenty_results']['counter']['table'] = [
    '#type' => 'table',
    '#header' => [
      $this
        ->t('Pagepath'),
      $this
        ->t('Pageviews'),
    ],
    '#rows' => $rows,
  ];

  // Top Twenty Results for Google Analytics Counter Storage table.
  $build['drupal_info']['top_twenty_results']['storage'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Pageviews'),
    '#open' => FALSE,
    '#attributes' => [
      'class' => [
        'google-analytics-counter-storage',
      ],
    ],
  ];
  $build['drupal_info']['top_twenty_results']['storage']['summary'] = [
    '#type' => 'html_tag',
    '#tag' => 'p',
    '#value' => $this
      ->t('Pageviews is the total number of pages viewed. Pageviews include node/id, aliases, international, and redirects, amongst other pages Google has determined belong to the pageview.'),
  ];
  $rows = $this->messageManager
    ->getTopTwentyResults('google_analytics_counter_storage');

  // Display table.
  $build['drupal_info']['top_twenty_results']['storage']['table'] = [
    '#type' => 'table',
    '#header' => [
      $this
        ->t('Nid'),
      $this
        ->t('Pageview Total'),
    ],
    '#rows' => $rows,
  ];

  // Cron Information.
  $build['cron_information'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Cron Information'),
    '#open' => TRUE,
  ];
  $build['cron_information']['last_cron_run'] = [
    '#type' => 'html_tag',
    '#tag' => 'p',
    '#value' => $this
      ->t("Last run: %time ago.", [
      '%time' => $this->dateFormatter
        ->formatTimeDiffSince($this->state
        ->get('system.cron_last')),
    ]),
  ];

  // Run cron immediately.
  $destination = \Drupal::destination()
    ->getAsArray();
  $t_args = [
    ':href' => Url::fromRoute('system.run_cron', [], [
      'absolute' => TRUE,
      'query' => $destination,
    ])
      ->toString(),
    '@href' => 'Run cron immediately.',
  ];
  $build['cron_information']['run_cron'] = [
    '#type' => 'html_tag',
    '#tag' => 'p',
    '#value' => $this
      ->t('<a href=:href>@href</a>', $t_args),
  ];

  // Add a link to the revoke form.
  $build = $this->messageManager
    ->revokeAuthenticationMessage($build);
  return $build;
}