You are here

Home » API reference » Visitors 8.2 » CityHits.php

class CityHits in Visitors 8.2

Hierarchy

Expanded class hierarchy of CityHits

File

src/Controller/Report/CityHits.php, line 18
Contains Drupal\visitors\Controller\Report\CityHits.

Namespace

Drupal\visitors\Controller\Report
View source 
class CityHits extends ControllerBase {

  /**
   * The date service.
   *
   * @var \Drupal\Core\Datetime\DateFormatterInterface
   */
  protected $date;

  /**
   * The form builder service.
   *
   * @var \Drupal\Core\Form\FormBuilderInterface
   */
  protected $formBuilder;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('date.formatter'), $container
      ->get('form_builder'));
  }

  /**
   * Constructs a CityHits object.
   *
   * @param \Drupal\Core\Datetime\DateFormatterInterface $date
   *   The date service.
   *
   * @param \Drupal\Core\Form\FormBuilderInterface $form_builder
   *   The form builder service.
   */
  public function __construct(DateFormatterInterface $date_formatter, FormBuilderInterface $form_builder) {
    $this->date = $date_formatter;
    $this->formBuilder = $form_builder;
  }

  /**
   * Returns a city hits page.
   *
   * @return array
   *   A render array representing the city hits page content.
   */
  public function display($country, $city) {
    $form = $this->formBuilder
      ->getForm('Drupal\\visitors\\Form\\DateFilter');
    $header = $this
      ->_getHeader();
    return array(
      '#title' => t('Hits from') . ' ' . t($city) . ', ' . t($country),
      'visitors_date_filter_form' => $form,
      'visitors_table' => array(
        '#type' => 'table',
        '#header' => $header,
        '#rows' => $this
          ->_getData($header, $country, $city),
      ),
      'visitors_pager' => array(
        '#type' => 'pager',
      ),
    );
  }

  /**
   * Returns a table header configuration.
   *
   * @return array
   *   A render array representing the table header info.
   */
  protected function _getHeader() {
    return array(
      '#' => array(
        'data' => t('#'),
      ),
      'visitors_id' => array(
        'data' => t('ID'),
        'field' => 'visitors_id',
        'specifier' => 'visitors_id',
        'class' => array(
          RESPONSIVE_PRIORITY_LOW,
        ),
        'sort' => 'desc',
      ),
      'visitors_date_time' => array(
        'data' => t('Date'),
        'field' => 'visitors_date_time',
        'specifier' => 'visitors_date_time',
        'class' => array(
          RESPONSIVE_PRIORITY_LOW,
        ),
      ),
      'visitors_url' => array(
        'data' => t('URL'),
        'field' => 'visitors_url',
        'specifier' => 'visitors_url',
        'class' => array(
          RESPONSIVE_PRIORITY_LOW,
        ),
      ),
      'u.name' => array(
        'data' => t('User'),
        'field' => 'u.name',
        'specifier' => 'u.name',
        'class' => array(
          RESPONSIVE_PRIORITY_LOW,
        ),
      ),
      '' => array(
        'data' => t('Operations'),
      ),
    );
  }

  /**
   * Returns a table content.
   *
   * @param array $header
   *   Table header configuration.
   *
   * @return array
   *   Array representing the table content.
   */
  protected function _getData($header, $country, $city) {
    $items_per_page = \Drupal::config('visitors.config')
      ->get('items_per_page');
    $original_country = $country == '(none)' ? '' : $country;
    $original_city = $city == '(none)' ? '' : $city;
    $query = \Drupal::database()
      ->select('visitors', 'v')
      ->extend('Drupal\\Core\\Database\\Query\\PagerSelectExtender')
      ->extend('Drupal\\Core\\Database\\Query\\TableSortExtender');
    $query
      ->leftJoin('users_field_data', 'u', 'u.uid=v.visitors_id');
    $query
      ->fields('v', array(
      'visitors_id',
      'visitors_uid',
      'visitors_date_time',
      'visitors_title',
      'visitors_path',
      'visitors_url',
    ));
    $query
      ->fields('u', array(
      'name',
      'uid',
    ));
    $query
      ->condition('v.visitors_country_name', $original_country);
    $query
      ->condition('v.visitors_city', $original_city);
    visitors_date_filter_sql_condition($query);
    $query
      ->orderByHeader($header);
    $query
      ->limit($items_per_page);
    $count_query = \Drupal::database()
      ->select('visitors', 'v');
    $count_query
      ->addExpression('COUNT(*)');
    $count_query
      ->condition('v.visitors_country_name', $original_country);
    $count_query
      ->condition('v.visitors_city', $original_city);
    visitors_date_filter_sql_condition($count_query);
    $query
      ->setCountQuery($count_query);
    $results = $query
      ->execute();
    $rows = array();
    $page = isset($_GET['page']) ? (int) $_GET['page'] : '';
    $i = 0 + $page * $items_per_page;
    foreach ($results as $data) {
      $user = \Drupal::entityTypeManager()
        ->getStorage('user')
        ->load($data->visitors_uid);
      $username = array(
        '#type' => 'username',
        '#account' => $user,
      );
      $rows[] = array(
        ++$i,
        $data->visitors_id,
        $this->date
          ->format($data->visitors_date_time, 'short'),
        /*check_plain(
            $data->visitors_title) . '<br/>' . l($data->visitors_path,
            $data->visitors_url
          ),*/
        $data->visitors_url,
        \Drupal::service('renderer')
          ->render($username),
        Link::fromTextAndUrl($this
          ->t('details'), Url::fromRoute('visitors.hit_details', array(
          "hit_id" => $data->visitors_id,
        ))),
      );
    }
    return $rows;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CityHits::$date protected property The date service.
CityHits::$formBuilder protected property The form builder service. Overrides ControllerBase::$formBuilder
CityHits::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
CityHits::display public function Returns a city hits page.
CityHits::_getData protected function Returns a table content.
CityHits::_getHeader protected function Returns a table header configuration.
CityHits::__construct public function Constructs a CityHits object.
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityManager protected property The entity manager.
ControllerBase::$entityTypeManager protected property The entity type manager.
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.
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.