class DownloadCountController in Download Count 8

Returns responses for download_count module routes.

Hierarchy

• class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\download_count\Controller\DownloadCountController implements ContainerInjectionInterface

File

src/Controller/DownloadCountController.php, line 21

Namespace

Drupal\download_count\Controller

class DownloadCountController extends ControllerBase implements ContainerInjectionInterface {

  /**
   * Configuration factory.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

  /**
   * Current user object.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $currentUser;

  /**
   * Date Formatter.
   *
   * @var \Drupal\Core\Datetime\DateFormatterInterface
   */
  protected $dateFormatter;

  /**
   * Queue manager.
   *
   * @var \Drupal\Core\Queue\QueueInterface
   */
  protected $queue;

  /**
   * DownloadCountController constructor.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   Config Factory.
   * @param \Drupal\Core\Session\AccountInterface $current_user
   *   Current User.
   * @param \Drupal\Core\Datetime\DateFormatterInterface $date_formatter
   *   Date Formatter.
   * @param \Drupal\Core\Queue\QueueFactory $queue
   *   Queue Manager.
   */
  public function __construct(ConfigFactoryInterface $config_factory, AccountInterface $current_user, DateFormatterInterface $date_formatter, QueueFactory $queue) {
    $this->configFactory = $config_factory;
    $this->currentUser = $current_user;
    $this->dateFormatter = $date_formatter;
    $this->queue = $queue
      ->get('download_count');
  }

  /**
   * {@inheritDoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('current_user'), $container
      ->get('date.formatter'), $container
      ->get('queue'));
  }

  /**
   * Builds the fields info overview page.
   *
   * @return array
   *   Array of page elements to render.
   */
  public function downloadCountReport() {
    $build = [];
    $config = $this->configFactory
      ->get('download_count.settings');
    $build['#title'] = $config
      ->get('download_count_view_page_title');
    $total_downloads = 0;
    $item = 1;
    $limit = $config
      ->get('download_count_view_page_limit');
    $items_per_page = $config
      ->get('download_count_view_page_items');
    $page_header = $config
      ->get('download_count_view_page_header');
    $page_footer = $config
      ->get('download_count_view_page_footer');
    $output = '<div id="download-count-page">';
    $header = [
      [
        'data' => '#',
      ],
      [
        'data' => $this
          ->t('Count'),
        'field' => 'count',
        'sort' => 'desc',
      ],
      [
        'data' => $this
          ->t('FID'),
        'field' => 'FID',
      ],
      [
        'data' => $this
          ->t('Entity Type'),
        'field' => 'type',
      ],
      [
        'data' => $this
          ->t('Entity ID'),
        'field' => 'id',
      ],
      [
        'data' => $this
          ->t('File name'),
        'fi eld' => 'filename',
      ],
      [
        'data' => $this
          ->t('File Size'),
        'field' => 'file-size',
      ],
      [
        'data' => $this
          ->t('Total Size'),
        'field' => 'total-size',
      ],
      [
        'data' => $this
          ->t('Last Downloaded'),
        'field' => 'last',
      ],
    ];
    $connection = Database::getConnection();
    $query = $connection
      ->select('download_count', 'dc')
      ->fields('dc', [
      'type',
      'id',
    ])
      ->fields('f', [
      'filename',
      'fid',
      'filesize',
    ])
      ->groupBy('dc.type')
      ->groupBy('dc.id')
      ->groupBy('dc.fid')
      ->groupBy('f.filename')
      ->groupBy('f.filesize')
      ->groupBy('f.fid');
    $query
      ->addExpression('COUNT(*)', 'count');
    $query
      ->addExpression('COUNT(*) * f.filesize', 'total-size');
    $query
      ->addExpression('MAX(dc.timestamp)', 'last');
    $query
      ->join('file_managed', 'f', 'dc.fid = f.fid');
    if ($limit > 0) {
      $query
        ->range(0, $limit);
    }
    $query
      ->extend('Drupal\\Core\\Database\\Query\\TableSortExtender')
      ->orderByHeader($header);
    if ($items_per_page > 0) {
      $query
        ->extend('Drupal\\Core\\Database\\Query\\PagerSelectExtender')
        ->limit($items_per_page);
    }
    $view_all = '';
    if ($this->currentUser
      ->hasPermission('view all download count')) {
      $view_all = Link::fromTextAndUrl($this
        ->t('View All'), Url::fromRoute('download_count.details', [
        'download_count_entry' => 'all',
      ]))
        ->toString();
      $header[] = [
        'data' => $view_all,
      ];
    }
    $export_all = '';
    if ($this->currentUser
      ->hasPermission('export all download count')) {
      $export_all = Link::fromTextAndUrl($this
        ->t('Export All'), Url::fromRoute('download_count.export', [
        'download_count_entry' => 'all',
      ]))
        ->toString();
      $header[] = [
        'data' => $export_all,
      ];
    }
    $reset_all = '';
    if ($this->currentUser
      ->hasPermission('reset all download count')) {
      $reset_all = Link::fromTextAndUrl($this
        ->t('View All'), Url::fromRoute('download_count.reset', [
        'download_count_entry' => 'all',
      ]))
        ->toString();
      $header[] = [
        'data' => $reset_all,
      ];
    }
    $rows = [];
    $result = $query
      ->execute();
    foreach ($result as $file) {
      $row = [];
      $row[] = $item;
      $row[] = number_format($file->count);
      $row[] = $file->fid;
      $row[] = Html::escape($file->type);
      $row[] = $file->id;
      $row[] = Html::escape($file->filename);
      $row[] = format_size($file->filesize);
      $row[] = format_size($file->count * $file->filesize);
      $row[] = $this
        ->t('@time ago', [
        '@time' => $this->dateFormatter
          ->formatInterval(REQUEST_TIME - $file->last),
      ]);
      $query = $connection
        ->select('download_count', 'dc')
        ->fields('dc', [
        'dcid',
      ])
        ->groupBy('dc.dcid')
        ->condition('id', $file->id)
        ->condition('fid', $file->fid);
      $query
        ->addExpression('MAX(dc.timestamp)', 'last');
      $dcid = $query
        ->execute()
        ->fetchField();
      if ($view_all) {
        $row[] = Link::fromTextAndUrl($this
          ->t('Details'), Url::fromRoute('download_count.details', [
          'download_count_entry' => $dcid,
        ]))
          ->toString();
      }
      if ($export_all) {
        $row[] = Link::fromTextAndUrl($this
          ->t('Export'), Url::fromRoute('download_count.export', [
          'download_count_entry' => $dcid,
        ]))
          ->toString();
      }
      if ($reset_all) {
        $row[] = Link::fromTextAndUrl($this
          ->t('Reset'), Url::fromRoute('download_count.reset', [
          'download_count_entry' => $dcid,
        ]))
          ->toString();
      }
      $rows[] = $row;
      $item++;
      $total_downloads += $file->count;
    }
    $build['#attached'] = [
      'library' => [
        "download_count/global-styling-css",
      ],
    ];
    if (!empty($page_header['value'])) {
      $output .= '<div id="download-count-header">' . Html::escape($page_header['value'], $page_header['format']) . '</div>';
    }
    $output .= '<div id="download-count-total-top">' . $this
      ->t('Total Downloads:') . ' ' . number_format($total_downloads) . '</div>';
    $table = [
      '#theme' => 'table',
      '#header' => $header,
      '#rows' => $rows,
      '#attributes' => [
        'id' => 'download-count-table',
      ],
      '#empty' => $this
        ->t('No files have been downloaded.'),
    ];
    $output .= render($table);
    $output .= '<div id="download-count-total-bottom">' . $this
      ->t('Total Downloads:') . ' ' . number_format($total_downloads) . '</div>';
    if ($items_per_page > 0) {
      $pager = [
        '#theme' => 'pager',
        'attributes' => [
          'tags' => [],
        ],
      ];
      $output .= render($pager);
    }
    if (!empty($page_footer['value'])) {
      $output .= '<div id="download-count-footer">' . Html::escape($page_footer['value'], $page_footer['format']) . '</div>';
    }
    $output .= '</div>';
    $build['#markup'] = $output;
    return $build;
  }

  /**
   * Download_count details page callback.
   */
  public function downloadCountDetails($download_count_entry = NULL) {
    $config = $this->configFactory
      ->get('download_count.settings');
    $build = [];
    $build['#attached'] = [
      'library' => [
        "download_count/global-styling-css",
      ],
    ];
    $last_cron = $config
      ->get('download_count_last_cron');
    if ($download_count_entry != NULL) {
      $connection = Database::getConnection();
      $query = $connection
        ->select('download_count', 'dc');
      $query
        ->innerjoin('file_managed', 'f', 'dc.fid = f.fid');
      $query
        ->fields('dc', [
        'dcid',
        'fid',
        'uid',
        'type',
        'id',
        'ip_address',
        'referrer',
        'timestamp',
      ]);
      $query
        ->fields('f', [
        'filename',
        'uri',
        'filemime',
        'filesize',
      ]);
      $query
        ->condition('dc.dcid', $download_count_entry);
      $dc_entry = $query
        ->execute()
        ->fetchObject();
    }
    else {
      $dc_entry = 'all';
    }
    $output = Link::fromTextAndUrl($this
      ->t('&#0171; Back to summary'), Url::fromRoute('download_count.reports'))
      ->toString();
    $connection = Database::getConnection();
    $query = $connection
      ->select('download_count_cache', 'dc');
    $query
      ->addExpression('COUNT(dc.count)', 'count');
    if (!is_object($dc_entry)) {
      $build['#title'] = $this
        ->t('Download Count Details - All Files');
    }
    else {
      $build['#title'] = $this
        ->t('Download Count Details - @filename from @type @id', [
        '@filename' => $dc_entry->filename,
        '@type' => $dc_entry->type,
        '@id' => $dc_entry->id,
      ]);
      $query
        ->condition('dc.type', $dc_entry->type);
      $query
        ->condition('dc.id', $dc_entry->id);
      $query
        ->condition('dc.fid', $dc_entry->fid);
    }
    $result = $query
      ->execute()
      ->fetchField();
    $total = number_format($result);
    if ($last_cron > 0) {
      $output .= '<p>Current as of ' . $this->dateFormatter
        ->format($last_cron, 'long') . ' with ' . number_format($this->queue
        ->numberOfItems()) . ' items still queued to cache.</p>';
    }
    else {
      $output .= '<p>No download count data has been cached. You may want to check Drupal cron.</p>';
    }
    $output .= '<div id="download-count-total-top"><strong>' . $this
      ->t('Total Downloads:') . '</strong> ' . $total . '</div>';

    // Determine first day of week (from date module if set, 'Sunday' if not).
    if ($config
      ->get('date_first_day') == 0) {
      $week_format = '%U';
    }
    else {
      $week_format = '%u';
    }
    $sparkline_type = $config
      ->get('download_count_sparklines');

    // Base query for all files for all intervals.
    $query = $connection
      ->select('download_count_cache', 'dc')
      ->groupBy('time_interval');
    $query
      ->addExpression('SUM(dc.count)', 'count');
    $query
      ->orderBy('dc.date', 'DESC');

    // Details for a specific download and entity.
    if ($dc_entry != 'all') {
      $query
        ->condition('type', $dc_entry->type, '=');
      $query
        ->condition('id', $dc_entry->id, '=');
      $query
        ->condition('fid', $dc_entry->fid, '=');
    }

    // Daily data.
    $query
      ->addExpression("FROM_UNIXTIME(date, '%Y-%m-%d')", 'time_interval');
    $query
      ->range(0, $config
      ->get('download_count_details_daily_limit'));
    $result = $query
      ->execute();
    $daily = $this
      ->downloadCountDetailsTable($result, 'Daily', 'Day');
    $output .= render($daily['output']);
    if ($sparkline_type != 'none') {
      $values['daily'] = implode(',', array_reverse($daily['values']));
      $output .= '<div class="download-count-sparkline-daily">' . $this
        ->t('Rendering Sparkline...') . '</div>';
    }
    $expressions =& $query
      ->getExpressions();

    // Weekly data.
    $expressions['time_interval']['expression'] = "FROM_UNIXTIME(date, '{$week_format}')";
    $query
      ->range(0, $config
      ->get('download_count_details_weekly_limit'));
    $result = $query
      ->execute();
    $weekly = $this
      ->downloadCountDetailsTable($result, 'Weekly', 'Week');
    $output .= render($weekly['output']);
    if ($sparkline_type != 'none') {
      $values['weekly'] = implode(',', array_reverse($weekly['values']));
      $output .= '<div class="download-count-sparkline-weekly">' . $this
        ->t('Rendering Sparkline...') . '</div>';
    }

    // Monthly data.
    $expressions['time_interval']['expression'] = "FROM_UNIXTIME(date, '%Y-%m')";
    $query
      ->range(0, $config
      ->get('download_count_details_monthly_limit'));
    $result = $query
      ->execute();
    $monthly = $this
      ->downloadCountDetailsTable($result, 'Monthly', 'Month');
    $output .= render($monthly['output']);
    if ($sparkline_type != 'none') {
      $values['monthly'] = implode(',', array_reverse($monthly['values']));
      $output .= '<div class="download-count-sparkline-monthly">' . $this
        ->t('Rendering Sparkline...') . '</div>';
    }

    // Yearly data.
    $expressions['time_interval']['expression'] = "FROM_UNIXTIME(date, '%Y')";
    $query
      ->range(0, $config
      ->get('download_count_details_yearly_limit'));
    $result = $query
      ->execute();
    $yearly = $this
      ->downloadCountDetailsTable($result, 'Yearly', 'Year');
    $output .= render($yearly['output']);
    if ($sparkline_type != 'none') {
      $values['yearly'] = implode(',', array_reverse($yearly['values']));
      $output .= '<div class="download-count-sparkline-yearly">' . $this
        ->t('Rendering Sparkline...') . '</div>';
    }
    $output .= '<div id="download-count-total-bottom"><strong>' . $this
      ->t('Total Downloads:') . '</strong> ' . $total . '</div>';
    if ($sparkline_type != 'none') {
      $build['#attached']['library'][] = "download_count/sparkline";
      $build['#attached']['drupalSettings']['download_count'] = [
        'values' => $values,
        'type' => $sparkline_type,
        'min' => $config
          ->get('download_count_sparkline_min'),
        'height' => $config
          ->get('download_count_sparkline_height'),
        'width' => $config
          ->get('download_count_sparkline_width'),
      ];
    }
    $build['#markup'] = $output;
    return $build;
  }

  /**
   * Create and output details table.
   */
  public function downloadCountDetailsTable($result, $caption, $range) {
    $header = [
      [
        'data' => $this
          ->t('#'),
        'class' => 'number',
      ],
      [
        'data' => $this
          ->t('@range', [
          '@range' => $range,
        ]),
        'class' => 'range',
      ],
      [
        'data' => $this
          ->t('Downloads'),
        'class' => 'count',
      ],
    ];
    $count = 1;
    $rows = [];
    $values = [];
    foreach ($result as $download) {
      $row = [];
      $row[] = $count;
      $row[] = $download->time_interval;
      $row[] = number_format($download->count);
      $values[] = $download->count;
      $rows[] = $row;
      $count++;
    }
    $output = [
      '#theme' => 'table',
      '#header' => $header,
      '#rows' => $rows,
      '#attributes' => [
        'id' => 'download-count-' . Unicode::strtolower($caption),
        'class' => 'download-count-details download-count-table',
      ],
      '#caption' => $caption,
      '#sticky' => FALSE,
    ];
    return [
      'output' => $output,
      'values' => $values,
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ControllerBase::$entityFormBuilder	protected	property	The entity form builder.
ControllerBase::$entityManager	protected	property	The entity manager.
ControllerBase::$entityTypeManager	protected	property	The entity type manager.
ControllerBase::$formBuilder	protected	property	The form builder.	2
ControllerBase::$keyValue	protected	property	The key-value storage.	1
ControllerBase::$languageManager	protected	property	The language manager.	1
ControllerBase::$moduleHandler	protected	property	The module handler.	2
ControllerBase::$stateService	protected	property	The state service.
ControllerBase::cache	protected	function	Returns the requested cache bin.
ControllerBase::config	protected	function	Retrieves a configuration object.
ControllerBase::container	private	function	Returns the service container.
ControllerBase::currentUser	protected	function	Returns the current user.	1
ControllerBase::entityFormBuilder	protected	function	Retrieves the entity form builder.
ControllerBase::entityManager Deprecated	protected	function	Retrieves the entity manager service.
ControllerBase::entityTypeManager	protected	function	Retrieves the entity type manager.
ControllerBase::formBuilder	protected	function	Returns the form builder service.	2
ControllerBase::keyValue	protected	function	Returns a key/value storage collection.	1
ControllerBase::languageManager	protected	function	Returns the language manager service.	1
ControllerBase::moduleHandler	protected	function	Returns the module handler.	2
ControllerBase::redirect	protected	function	Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state	protected	function	Returns the state storage service.
DownloadCountController::$configFactory	protected	property	Configuration factory. Overrides ControllerBase::$configFactory
DownloadCountController::$currentUser	protected	property	Current user object. Overrides ControllerBase::$currentUser
DownloadCountController::$dateFormatter	protected	property	Date Formatter.
DownloadCountController::$queue	protected	property	Queue manager.
DownloadCountController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
DownloadCountController::downloadCountDetails	public	function	Download_count details page callback.
DownloadCountController::downloadCountDetailsTable	public	function	Create and output details table.
DownloadCountController::downloadCountReport	public	function	Builds the fields info overview page.
DownloadCountController::__construct	public	function	DownloadCountController constructor.
LinkGeneratorTrait::$linkGenerator	protected	property	The link generator.	1
LinkGeneratorTrait::getLinkGenerator Deprecated	protected	function	Returns the link generator.
LinkGeneratorTrait::l Deprecated	protected	function	Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated	public	function	Sets the link generator service.
LoggerChannelTrait::$loggerFactory	protected	property	The logger channel factory service.
LoggerChannelTrait::getLogger	protected	function	Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory	public	function	Injects the logger channel factory.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator	protected	property	The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated	protected	function	Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated	public	function	Sets the URL generator service.
UrlGeneratorTrait::url Deprecated	protected	function	Generates a URL or path for a specific route based on the given parameters.