You are here

Home » API reference » Visitors 8.2 » VisitorsBlock.php

class VisitorsBlock in Visitors 8.2

Provides a 'Visitors' block.

Plugin annotation


@Block(
  id = "visitors_block",
  admin_label = @Translation("Visitors"),
  category = @Translation("Visitors")
)

Hierarchy

Expanded class hierarchy of VisitorsBlock

File

src/Plugin/Block/VisitorsBlock.php, line 21
Contains \Drupal\visitors\Plugin\Block\VisitorsBlock.

Namespace

Drupal\visitors\Plugin\Block
View source 
class VisitorsBlock extends BlockBase {
  protected $config;
  protected $items;

  /**
   * {@inheritdoc}
   */
  public function build() {
    $this->config = \Drupal::config('visitors.config');
    $this->items = array();
    $this
      ->_showTotalVisitors();
    $this
      ->_showUniqueVisitors();
    $this
      ->_showRegisteredUsersCount();
    $this
      ->_showLastRegisteredUser();
    $this
      ->_showPublishedNodes();
    $this
      ->_showUserIp();
    $this
      ->_showSinceDate();
    return array(
      'visitors_info' => array(
        '#theme' => 'item_list',
        '#items' => $this->items,
      ),
    );
  }

  /**
   * Display total visitors count to visitors block.
   */
  protected function _showTotalVisitors() {
    if ($this->config
      ->get('show_total_visitors')) {
      $query = \Drupal::database()
        ->select('visitors');
      $query
        ->addExpression('COUNT(*)');
      $count = $query
        ->execute()
        ->fetchField() + $this->config
        ->get('start_count_total_visitors');
      $this->items[] = t('Total Visitors: %visitors', array(
        '%visitors' => $count,
      ));
    }
  }

  /**
   * Display unique visitors count to visitors block.
   */
  protected function _showUniqueVisitors() {
    if ($this->config
      ->get('show_unique_visitor')) {
      $query = \Drupal::database()
        ->select('visitors');
      $query
        ->addExpression('COUNT(DISTINCT visitors_ip)');
      $unique_visitors = $query
        ->execute()
        ->fetchField();
      $this->items[] = t('Unique Visitors: %unique_visitors', array(
        '%unique_visitors' => $unique_visitors,
      ));
    }
  }

  /**
   * Display registered users count to visitors block.
   */
  protected function _showRegisteredUsersCount() {
    if ($this->config
      ->get('show_registered_users_count')) {
      $query = \Drupal::database()
        ->select('users');
      $query
        ->addExpression('COUNT(*)');
      $query
        ->condition('uid', '0', '>');
      $registered_users_count = $query
        ->execute()
        ->fetchField();
      $this->items[] = t('Registered Users: %registered_users_count', array(
        '%registered_users_count' => $registered_users_count,
      ));
    }
  }

  /**
   * Display last registered user to visitors block.
   */
  protected function _showLastRegisteredUser() {
    if ($this->config
      ->get('show_last_registered_user')) {
      $last_user_uid = \Drupal::database()
        ->select('users', 'u')
        ->fields('u', array(
        'uid',
      ))
        ->orderBy('uid', 'DESC')
        ->range(0, 1)
        ->execute()
        ->fetchField();
      $user = \Drupal::entityTypeManager()
        ->getStorage('user')
        ->load($last_user_uid);
      $username = array(
        '#theme' => 'username',
        '#account' => $user,
      );
      $this->items[] = t('Last Registered User: @last_user', array(
        '@last_user' => \Drupal::service('renderer')
          ->render($username),
      ));
    }
  }

  /**
   * Display published nodes count to visitors block.
   */
  protected function _showPublishedNodes() {
    if ($this->config
      ->get('show_published_nodes')) {
      $query = \Drupal::database()
        ->select('node', 'n');
      $query
        ->innerJoin('node_field_data', 'nfd', 'n.nid = nfd.nid');
      $query
        ->addExpression('COUNT(*)');
      $query
        ->condition('nfd.status', '1', '=');
      $nodes = $query
        ->execute()
        ->fetchField();
      $this->items[] = t('Published Nodes: %nodes', array(
        '%nodes' => $nodes,
      ));
    }
  }

  /**
   * Display user ip to visitors block.
   */
  protected function _showUserIp() {
    if ($this->config
      ->get('show_user_ip')) {
      $this->items[] = t('Your IP: %user_ip', array(
        '%user_ip' => \Drupal::request()
          ->getClientIp(),
      ));
    }
  }

  /**
   * Display the start date statistics to visitors block.
   */
  protected function _showSinceDate() {
    if ($this->config
      ->get('show_since_date')) {
      $query = \Drupal::database()
        ->select('visitors');
      $query
        ->addExpression('MIN(visitors_date_time)');
      $since_date = $query
        ->execute()
        ->fetchField();
      $this->items[] = t('Since: %since_date', array(
        '%since_date' => \Drupal::service('date.formatter')
          ->format($since_date, 'short'),
      ));
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BlockPluginInterface::BLOCK_LABEL_VISIBLE constant Indicates the block label (title) should be displayed to end users.
BlockPluginTrait::$transliteration protected property The transliteration service.
BlockPluginTrait::access public function
BlockPluginTrait::baseConfigurationDefaults protected function Returns generic default configuration for block plugins.
BlockPluginTrait::blockAccess protected function Indicates whether the block should be shown. 16
BlockPluginTrait::blockForm public function 16
BlockPluginTrait::blockSubmit public function 13
BlockPluginTrait::blockValidate public function 3
BlockPluginTrait::buildConfigurationForm public function Creates a generic configuration form for all block types. Individual block plugins can add elements to this form by overriding BlockBase::blockForm(). Most block plugins should not override this method unless they need to alter the generic form elements. 2
BlockPluginTrait::calculateDependencies public function
BlockPluginTrait::defaultConfiguration public function 19
BlockPluginTrait::getConfiguration public function 1
BlockPluginTrait::getMachineNameSuggestion public function 1
BlockPluginTrait::getPreviewFallbackString public function 3
BlockPluginTrait::label public function
BlockPluginTrait::setConfiguration public function
BlockPluginTrait::setConfigurationValue public function
BlockPluginTrait::setTransliteration public function Sets the transliteration service.
BlockPluginTrait::submitConfigurationForm public function Most block plugins should not override this method. To add submission handling for a specific block type, override BlockBase::blockSubmit().
BlockPluginTrait::transliteration protected function Wraps the transliteration service.
BlockPluginTrait::validateConfigurationForm public function Most block plugins should not override this method. To add validation for a specific block type, override BlockBase::blockValidate(). 1
BlockPluginTrait::__construct public function 22
ContextAwarePluginAssignmentTrait::addContextAssignmentElement protected function Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler protected function Wraps the context handler.
ContextAwarePluginBase::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginBase::$contexts Deprecated private property Data objects representing the contexts passed in the plugin configuration.
ContextAwarePluginBase::createContextFromConfiguration protected function Overrides ContextAwarePluginBase::createContextFromConfiguration
ContextAwarePluginBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts 9
ContextAwarePluginBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge 7
ContextAwarePluginBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags 4
ContextAwarePluginBase::getContext public function This code is identical to the Component in order to pick up a different Context class. Overrides ContextAwarePluginBase::getContext
ContextAwarePluginBase::getContextDefinition public function Overrides ContextAwarePluginBase::getContextDefinition
ContextAwarePluginBase::getContextDefinitions public function Overrides ContextAwarePluginBase::getContextDefinitions
ContextAwarePluginBase::getContextMapping public function Gets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::getContextMapping
ContextAwarePluginBase::getContexts public function Gets the defined contexts. Overrides ContextAwarePluginInterface::getContexts
ContextAwarePluginBase::getContextValue public function Gets the value for a defined context. Overrides ContextAwarePluginInterface::getContextValue
ContextAwarePluginBase::getContextValues public function Gets the values for all defined contexts. Overrides ContextAwarePluginInterface::getContextValues
ContextAwarePluginBase::setContext public function Set a context on this plugin. Overrides ContextAwarePluginBase::setContext
ContextAwarePluginBase::setContextMapping public function Sets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::setContextMapping
ContextAwarePluginBase::setContextValue public function Sets the value for a defined context. Overrides ContextAwarePluginBase::setContextValue
ContextAwarePluginBase::validateContexts public function Validates the set values for the defined contexts. Overrides ContextAwarePluginInterface::validateContexts
ContextAwarePluginBase::__get public function Implements magic __get() method.
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginWithFormsTrait::getFormClass public function
PluginWithFormsTrait::hasFormClass public function
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.
TypedDataTrait::$typedDataManager protected property The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager public function Gets the typed data manager. 2
TypedDataTrait::setTypedDataManager public function Sets the typed data manager. 2
VisitorsBlock::$config protected property
VisitorsBlock::$items protected property
VisitorsBlock::build public function Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
VisitorsBlock::_showLastRegisteredUser protected function Display last registered user to visitors block.
VisitorsBlock::_showPublishedNodes protected function Display published nodes count to visitors block.
VisitorsBlock::_showRegisteredUsersCount protected function Display registered users count to visitors block.
VisitorsBlock::_showSinceDate protected function Display the start date statistics to visitors block.
VisitorsBlock::_showTotalVisitors protected function Display total visitors count to visitors block.
VisitorsBlock::_showUniqueVisitors protected function Display unique visitors count to visitors block.
VisitorsBlock::_showUserIp protected function Display user ip to visitors block.