class ContentOverview in Total Control Admin Dashboard 3.0.x

Same name and namespace in other branches

8.2 src/Plugin/Block/ContentOverview.php \Drupal\total_control\Plugin\Block\ContentOverview

Provides a 'Content Overview'.

Plugin annotation


@Block(
id = "content_overview",
admin_label = @Translation("Content Overview"),
category = @Translation("Dashboard")
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Block\BlockBase implements BlockPluginInterface, ContextAwarePluginInterface, PluginWithFormsInterface, PreviewFallbackInterface uses BlockPluginTrait, ContextAwarePluginAssignmentTrait, ContextAwarePluginTrait
    class \Drupal\total_control\Plugin\Block\ContentOverview implements BlockPluginInterface, ContainerFactoryPluginInterface

Expanded class hierarchy of ContentOverview

File

src/Plugin/Block/ContentOverview.php, line 27

Namespace

Drupal\total_control\Plugin\Block

View source

class ContentOverview 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 ContentOverview 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() {
    $items = [];
    $types = $this->entityTypeManager
      ->getStorage('node_type')
      ->loadMultiple();
    $config = $this
      ->getConfiguration();
    foreach ($types as $type => $object) {

      // Compare against type option on pane config.
      if (!array_key_exists($type, $config['total_control_types_overview']) || (isset($config['total_control_types_overview']) && $config['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($type_count, '1 ' . $object
          ->get('name') . ' item', '@count ' . $object
          ->get('name') . ' items');

        // Check if comments module is enabled.
        if ($this->moduleHandler
          ->moduleExists('comment')) {

          // Compare against comment options on pane config.
          if (!array_key_exists($type, $config['total_control_comments_overview']) || (isset($config['total_control_comments_overview']) && $config['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($comment_count, '1 comment', '@count comments');

            // Compare against spam option checkbox on pane config.
            if (isset($config['total_control_spam_overview']) && $config['total_control_spam_overview'] == 1) {
              $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($spam_count, '1 spam', '@count spam');
            }
          }
        }
        $line = $content_data[$type];
        $line .= isset($content_data[$type . '_comments']) ? ' with ' . $content_data[$type . '_comments'] : '';
        $line .= isset($content_data[$type . '_comments_spam']) ? ' (' . $content_data[$type . '_comments_spam'] . ')' : '';
        $items[] = $line;
      }
    }
    if (empty($items)) {
      $markup_data = $this
        ->t('No content available.') . ' ' . Link::fromTextAndUrl($this
        ->t('Add content'), new Url('node.add_page'))
        ->toString();
      return [
        '#type' => 'markup',
        '#markup' => $markup_data,
      ];
    }
    $body_data = [
      '#theme' => 'item_list',
      '#list_type' => 'ul',
      '#items' => $items,
    ];
    $markup_data = $this->renderer
      ->render($body_data);
    return [
      '#type' => 'markup',
      '#markup' => $markup_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['total_control_types_overview'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Show post counts for the following content types'),
      '#options' => $type_defaults,
      '#default_value' => $config['total_control_types_overview'],
    ];
    $form['total_control_comments_overview'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Show comment counts for the following content types'),
      '#options' => $type_defaults,
      '#default_value' => $config['total_control_comments_overview'],
    ];
    $spam_options = [
      0 => $this
        ->t('no'),
      1 => $this
        ->t('Yes'),
    ];
    $form['total_control_spam_overview'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Include spam counts with comments'),
      '#options' => $spam_options,
      '#default_value' => $config['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['total_control_types_overview'] = $values['total_control_types_overview'];
    $this->configuration['total_control_comments_overview'] = $values['total_control_comments_overview'];
    $this->configuration['total_control_spam_overview'] = $values['total_control_spam_overview'];
  }

}

Members

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

You are here

class ContentOverview in Total Control Admin Dashboard 3.0.x

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation