class Referers in Visitors 8.2

Same name in this branch

8.2 src/Form/Referers.php \Drupal\visitors\Form\Referers
8.2 src/Controller/Report/Referers.php \Drupal\visitors\Controller\Report\Referers

Hierarchy

class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\visitors\Controller\Report\Referers

Expanded class hierarchy of Referers

2 string references to 'Referers'

visitors.links.menu.yml in ./visitors.links.menu.yml: visitors.links.menu.yml
visitors.routing.yml in ./visitors.routing.yml: visitors.routing.yml

File

src/Controller/Report/Referers.php, line 23: Contains Drupal\visitors\Controller\Report\Referers.

Namespace

Drupal\visitors\Controller\Report

View source

class Referers 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 Referers 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 referers page.
   *
   * @return array
   *   A render array representing the referers page content.
   */
  public function display() {
    $form = $this->formBuilder
      ->getForm('Drupal\\visitors\\Form\\Referers');
    $header = $this
      ->_getHeader();
    return array(
      'visitors_date_filter_form' => $form,
      'visitors_table' => array(
        '#type' => 'table',
        '#header' => $header,
        '#rows' => $this
          ->_getData($header),
      ),
      '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_referer' => array(
        'data' => t('Referer'),
        'field' => 'visitors_referer',
        'specifier' => 'visitors_referer',
        'class' => array(
          RESPONSIVE_PRIORITY_LOW,
        ),
      ),
      'count' => array(
        'data' => t('Count'),
        'field' => 'count',
        'specifier' => 'count',
        'class' => array(
          RESPONSIVE_PRIORITY_LOW,
        ),
        'sort' => 'desc',
      ),
    );
  }

  /**
   * Returns a table content.
   *
   * @param array $header
   *   Table header configuration.
   *
   * @return array
   *   Array representing the table content.
   */
  protected function _getData($header) {
    $items_per_page = \Drupal::config('visitors.config')
      ->get('items_per_page');
    $query = \Drupal::database()
      ->select('visitors', 'v')
      ->extend('Drupal\\Core\\Database\\Query\\PagerSelectExtender')
      ->extend('Drupal\\Core\\Database\\Query\\TableSortExtender');
    $query
      ->addExpression('COUNT(*)', 'count');
    $query
      ->fields('v', array(
      'visitors_referer',
    ));
    visitors_date_filter_sql_condition($query);
    $this
      ->_setReferersCondition($query);
    $query
      ->groupBy('visitors_referer');
    $query
      ->orderByHeader($header);
    $query
      ->limit($items_per_page);
    $count_query = \Drupal::database()
      ->select('visitors', 'v');
    $count_query
      ->addExpression('COUNT(DISTINCT visitors_referer)');
    visitors_date_filter_sql_condition($count_query);
    $this
      ->_setReferersCondition($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) {
      $rows[] = array(
        ++$i,
        empty($data->visitors_referer) ? $this
          ->t('No Referer') : $data->visitors_referer,
        $data->count,
      );
    }
    return $rows;
  }

  /**
   * Build sql query from referer type value.
   */
  protected function _setReferersCondition(&$query) {
    switch ($_SESSION['referer_type']) {
      case REFERER_TYPE_INTERNAL_PAGES:
        $query
          ->condition('visitors_referer', sprintf('%%%s%%', $_SERVER['HTTP_HOST']), 'LIKE');
        $query
          ->condition('visitors_referer', '', '<>');
        break;
      case REFERER_TYPE_EXTERNAL_PAGES:
        $query
          ->condition('visitors_referer', sprintf('%%%s%%', $_SERVER['HTTP_HOST']), 'NOT LIKE');
        break;
      default:
        break;
    }
    return $query;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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.
Referers::$date	protected	property	The date service.
Referers::$formBuilder	protected	property	The form builder service. Overrides ControllerBase::$formBuilder
Referers::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
Referers::display	public	function	Returns a referers page.
Referers::_getData	protected	function	Returns a table content.
Referers::_getHeader	protected	function	Returns a table header configuration.
Referers::_setReferersCondition	protected	function	Build sql query from referer type value.
Referers::__construct	public	function	Constructs a Referers object.
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.

You are here

class Referers in Visitors 8.2

Hierarchy

File

Namespace

Members

API Navigation