You are here

Home » API reference » Opigno dashboard 3.x » UserStatisticsBlock.php

class UserStatisticsBlock in Opigno dashboard 3.x

The user statistics block.

@Block( id = "opigno_user_stats_block", admin_label = @Translation("User statistics"), category = @Translation("Dashboard"), )

@package Drupal\opigno_dashboard\Plugin\Block

Hierarchy

Expanded class hierarchy of UserStatisticsBlock

File

src/Plugin/Block/UserStatisticsBlock.php, line 19

Namespace

Drupal\opigno_dashboard\Plugin\Block
View source 
class UserStatisticsBlock extends SiteHeaderBlock implements ContainerFactoryPluginInterface {

  /**
   * {@inheritdoc}
   */
  public function build() {
    if (!$this->user instanceof UserInterface) {
      return [
        '#cache' => [
          'max-age' => 0,
        ],
      ];
    }
    if ($this->user
      ->isAnonymous()) {
      return [
        '#cache' => [
          'max-age' => -1,
        ],
      ];
    }
    $stats = $this->statsManager
      ->renderUserStatistics(7);
    return [
      '#theme' => 'opigno_dashboard_user_statistics_block',
      '#user_name' => $this->user
        ->getDisplayName(),
      '#uid' => (int) $this->user
        ->id(),
      '#user_picture' => $this->statsManager
        ->getUserPicture($this->user, 'user_profile'),
      '#role' => $this->statsManager
        ->getUserRole(),
      '#stats' => $stats,
      '#attached' => $stats['#attached'] ?? [],
    ];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BlockBase::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm 2
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. Aliased as: traitBuildConfigurationForm
BlockPluginTrait::calculateDependencies public function
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
ContextAwarePluginAssignmentTrait::addContextAssignmentElement protected function Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler protected function Wraps the context handler.
ContextAwarePluginTrait::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginTrait::$initializedContextConfig protected property Tracks whether the context has been initialized from configuration.
ContextAwarePluginTrait::getCacheMaxAge public function 7
ContextAwarePluginTrait::getContext public function
ContextAwarePluginTrait::getContextDefinition public function
ContextAwarePluginTrait::getContextDefinitions public function
ContextAwarePluginTrait::getContextMapping public function
ContextAwarePluginTrait::getContexts public function
ContextAwarePluginTrait::getContextValue public function
ContextAwarePluginTrait::getContextValues public function
ContextAwarePluginTrait::getPluginDefinition abstract protected function 1
ContextAwarePluginTrait::setContext public function 1
ContextAwarePluginTrait::setContextMapping public function
ContextAwarePluginTrait::setContextValue public function
ContextAwarePluginTrait::validateContexts public function
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
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::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 Implements \Drupal\Core\Plugin\PluginWithFormsInterface::getFormClass().
PluginWithFormsTrait::hasFormClass public function Implements \Drupal\Core\Plugin\PluginWithFormsInterface::hasFormClass().
SiteHeaderBlock::$isUserPage protected property If the current page is a user page.
SiteHeaderBlock::$menuTree protected property The menu link tree service.
SiteHeaderBlock::$notificationsManager protected property Notifications manager service.
SiteHeaderBlock::$pmService protected property The private messages manager service.
SiteHeaderBlock::$statsManager protected property The user statistics manager.
SiteHeaderBlock::$user protected property The current user.
SiteHeaderBlock::buildUserDropdownMenu private function Prepare the user dropdown menu.
SiteHeaderBlock::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
SiteHeaderBlock::defaultConfiguration public function Overrides BlockPluginTrait::defaultConfiguration
SiteHeaderBlock::getCacheContexts public function Overrides ContextAwarePluginTrait::getCacheContexts
SiteHeaderBlock::getCacheTags public function Overrides ContextAwarePluginTrait::getCacheTags
SiteHeaderBlock::__construct public function Overrides BlockPluginTrait::__construct
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
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.
UserStatisticsBlock::build public function Builds and returns the renderable array for this block plugin. Overrides SiteHeaderBlock::build