You are here

Home » API reference » Varbase Total Control Dashboard 8.6 » VarbaseContentOverview.php

class VarbaseContentOverview in Varbase Total Control Dashboard 8.6

Same name and namespace in other branches
  1. 8 src/Plugin/Block/VarbaseContentOverview.php \Drupal\varbase_total_control\Plugin\Block\VarbaseContentOverview
  2. 8.5 src/Plugin/Block/VarbaseContentOverview.php \Drupal\varbase_total_control\Plugin\Block\VarbaseContentOverview
  3. 9.0.x src/Plugin/Block/VarbaseContentOverview.php \Drupal\varbase_total_control\Plugin\Block\VarbaseContentOverview

Provides a 'Varbase Content Overview'.

Plugin annotation


@Block(
id = "varbase_content_overview",
admin_label = @Translation("My Site Overview"),
category = @Translation("Dashboard")
)

Hierarchy

Expanded class hierarchy of VarbaseContentOverview

File

src/Plugin/Block/VarbaseContentOverview.php, line 28

Namespace

Drupal\varbase_total_control\Plugin\Block
View source 
class VarbaseContentOverview extends BlockBase implements BlockPluginInterface, ContainerFactoryPluginInterface {

  /**
   * The module handler service.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * The database connection.
   *
   * @var \Drupal\Core\Database\Connection
   */
  protected $connection;

  /**
   * The translation manager.
   *
   * @var \Drupal\Core\StringTranslation\TranslationInterface
   */
  protected $stringTranslation;

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The renderer service.
   *
   * @var Drupal\Core\Render\RendererInterface
   */
  protected $renderer;

  /**
   * Creates a VarbaseContentOverview block instance.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler service.
   * @param \Drupal\Core\Database\Connection $connection
   *   The database connection.
   * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
   *   The translation manager.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\Core\Render\RendererInterface $renderer
   *   The renderer service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, ModuleHandlerInterface $module_handler, Connection $connection, TranslationInterface $string_translation, EntityTypeManagerInterface $entity_type_manager, RendererInterface $renderer) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->moduleHandler = $module_handler;
    $this->connection = $connection;
    $this->stringTranslation = $string_translation;
    $this->entityTypeManager = $entity_type_manager;
    $this->renderer = $renderer;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('module_handler'), $container
      ->get('database'), $container
      ->get('string_translation'), $container
      ->get('entity_type.manager'), $container
      ->get('renderer'));
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    $header = [
      [
        'data' => $this
          ->t('Content'),
      ],
      [
        'data' => $this
          ->t('Discussion'),
      ],
    ];
    $rows = [];
    $types = $this->entityTypeManager
      ->getStorage('node_type')
      ->loadMultiple();
    $config = $this
      ->getConfiguration();
    $comments_exist = $this->moduleHandler
      ->moduleExists('comment');
    $spam = isset($config['varbase_total_control_spam_overview']) && $config['varbase_total_control_spam_overview'] == 1;
    foreach ($types as $type => $object) {

      // Compare against type option on pane config.
      if (!array_key_exists($type, $config['varbase_total_control_types_overview']) || (isset($config['varbase_total_control_types_overview']) && $config['varbase_total_control_types_overview'][$type]) == $type) {
        $type_query = $this->connection
          ->query("SELECT count(*) FROM {node_field_data} WHERE type = :type and status = 1", [
          ':type' => $type,
        ]);
        $type_count = $type_query
          ->fetchField();
        $content_data[$type] = $this->stringTranslation
          ->formatPlural(number_format($type_count, 0, '.', ''), '<span class="num">1</span> ' . $object
          ->get('name') . ' item', '<span class="num">@count</span> ' . $object
          ->get('name') . ' items');

        // Check if comments module is enabled.
        if ($comments_exist) {

          // Compare against comment options on pane config.
          if (!array_key_exists($type, $config['varbase_total_control_comments_overview']) || (isset($config['varbase_total_control_comments_overview']) && $config['varbase_total_control_comments_overview'][$type]) == $type) {
            $comment_query = $this->connection
              ->query("SELECT count(DISTINCT c.cid) FROM {comment} c INNER JOIN {comment_field_data} n ON c.cid = n.cid INNER JOIN {node} node WHERE n.entity_id = node.nid AND node.type = :type AND n.status = 1", [
              ':type' => $type,
            ]);
            $comment_count = $comment_query
              ->fetchField();
            $content_data[$type . '_comments'] = $this->stringTranslation
              ->formatPlural(number_format($comment_count), '<span class="comment"><span class="num">@count</span> Comment</span>', '<span class="comment"><span class="num">@count</span> Comments</span>');

            // Compare against spam option checkbox on pane config.
            if ($spam) {
              $spam_query = $this->connection
                ->query("SELECT count(DISTINCT c.cid) FROM {comment} c INNER JOIN {comment_field_data} n ON c.cid = n.cid INNER JOIN {node} node WHERE n.entity_id = node.nid AND node.type = :type AND n.status = 0", [
                ':type' => $type,
              ]);
              $spam_count = $spam_query
                ->fetchField();
              $content_data[$type . '_comments_spam'] = $this->stringTranslation
                ->formatPlural(number_format($spam_count), '<span class="spam"><span class="num">@count</span> Spam</span>', '<span class="spam"><span class="num">@count</span> Spams</span>');
            }
          }
        }
        $options = [
          'type' => $type,
        ];
        $link = Link::fromTextAndUrl($content_data[$type], new Url('system.admin_content', $options));
        if ($comments_exist && isset($content_data[$type . '_comments_spam'])) {
          $comment = !empty($content_data[$type . '_comments_spam']) ? Markup::create($content_data[$type . '_comments']
            ->render() . $content_data[$type . '_comments_spam']
            ->render()) : Markup::create($content_data[$type . '_comments']
            ->render());
          $rows[] = [
            'data' => [
              [
                'data' => $link
                  ->toString(),
                'class' => [
                  'type',
                ],
              ],
              [
                'data' => $comment,
                'class' => [
                  'discussion',
                ],
              ],
            ],
          ];
        }
        else {
          $header = [
            [
              'data' => $this
                ->t('Content'),
            ],
          ];
          $rows[] = [
            'data' => [
              $link,
            ],
          ];
        }
      }
    }
    $body_data = [
      '#theme' => 'table',
      '#header' => $header,
      '#rows' => $rows,
    ];
    $makup_data = $this->renderer
      ->render($body_data);
    return [
      '#type' => 'markup',
      '#markup' => $makup_data,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state) {
    $form = parent::blockForm($form, $form_state);
    $config = $this
      ->getConfiguration();
    $types = $this->entityTypeManager
      ->getStorage('node_type')
      ->loadMultiple();
    $type_defaults = [];
    foreach ($types as $type => $object) {
      if (!array_key_exists($type, $type_defaults)) {
        $type_defaults[$type] = $type;
      }
    }
    $form['varbase_total_control_types_overview'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Show post counts for the following content types'),
      '#options' => $type_defaults,
      '#default_value' => $config['varbase_total_control_types_overview'],
    ];
    $form['varbase_total_control_comments_overview'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Show comment counts for the following content types'),
      '#options' => $type_defaults,
      '#default_value' => $config['varbase_total_control_comments_overview'],
    ];
    $spam_options = [
      0 => $this
        ->t('no'),
      1 => $this
        ->t('Yes'),
    ];
    $form['varbase_total_control_spam_overview'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Include spam counts with comments'),
      '#options' => $spam_options,
      '#default_value' => $config['varbase_total_control_spam_overview'],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, FormStateInterface $form_state) {
    parent::blockSubmit($form, $form_state);
    $values = $form_state
      ->getValues();
    $this->configuration['varbase_total_control_types_overview'] = $values['varbase_total_control_types_overview'];
    $this->configuration['varbase_total_control_comments_overview'] = $values['varbase_total_control_comments_overview'];
    $this->configuration['varbase_total_control_spam_overview'] = $values['varbase_total_control_spam_overview'];
  }

}

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::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
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::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
VarbaseContentOverview::$connection protected property The database connection.
VarbaseContentOverview::$entityTypeManager protected property The entity type manager.
VarbaseContentOverview::$moduleHandler protected property The module handler service.
VarbaseContentOverview::$renderer protected property The renderer service.
VarbaseContentOverview::$stringTranslation protected property The translation manager. Overrides StringTranslationTrait::$stringTranslation
VarbaseContentOverview::blockForm public function Returns the configuration form elements specific to this block plugin. Overrides BlockPluginTrait::blockForm
VarbaseContentOverview::blockSubmit public function Adds block type-specific submission handling for the block form. Overrides BlockPluginTrait::blockSubmit
VarbaseContentOverview::build public function Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
VarbaseContentOverview::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
VarbaseContentOverview::__construct public function Creates a VarbaseContentOverview block instance. Overrides BlockPluginTrait::__construct