class NodeStatistics in Dashboards with Layout Builder 8

Show account info.

Plugin annotation

@Dashboard(
  id = "node_statistics",
  label = @Translation("Show node types."),
  category = @Translation("Statistics"),
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\dashboards\Plugin\DashboardBase implements ContainerFactoryPluginInterface, DashboardInterface uses StringTranslationTrait
    • class \Drupal\dashboards\Plugin\Dashboard\NodeStatistics uses ChartTrait

File

src/Plugin/Dashboard/NodeStatistics.php, line 22

Namespace

Drupal\dashboards\Plugin\Dashboard

class NodeStatistics extends DashboardBase {
  use ChartTrait;

  /**
   * Entity query.
   *
   * @var \Drupal\Core\Entity\Query\QueryInterface
   */
  protected $entityQuery;

  /**
   * Entity Type Manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeBundleInfoInterface
   */
  protected $entityTypeInfo;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, CacheBackendInterface $cache, QueryInterface $query_factory, EntityTypeBundleInfoInterface $entity_type_info) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $cache);
    $this->entityQuery = $query_factory;
    $this->entityTypeInfo = $entity_type_info;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('dashboards.cache'), $container
      ->get('entity_type.manager')
      ->getStorage('node')
      ->getQuery(), $container
      ->get('entity_type.bundle.info'));
  }

  /**
   * {@inheritdoc}
   */
  public function buildSettingsForm(array $form, FormStateInterface $form_state, array $configuration) : array {
    $form['chart_type'] = [
      '#type' => 'select',
      '#options' => $this
        ->getAllowedStyles(),
      '#default_value' => isset($configuration['chart_type']) ? $configuration['chart_type'] : 'pie',
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function buildRenderArray($configuration) : array {
    if (isset($configuration['chart_type'])) {
      $this
        ->setChartType($configuration['chart_type']);
    }
    $types = $this->entityTypeInfo
      ->getBundleInfo('node');
    $rows = [];
    $empty = TRUE;
    foreach ($types as $bundle => $type) {
      $data = $this->entityQuery
        ->condition('type', $bundle)
        ->count()
        ->execute();
      $rows[] = [
        $type['label'],
        $data,
      ];
      if ($data > 0) {
        $empty = FALSE;
      }
    }
    if ($empty) {
      $rows = [];
      $this
        ->setEmpty(TRUE);
    }
    $this
      ->setLabels([
      $this
        ->t('Node Type'),
      $this
        ->t('Count'),
    ]);
    $this
      ->setRows($rows);
    return $this
      ->renderChart($configuration);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ChartTrait::$empty	protected	property	Empty flag.
ChartTrait::$labels	protected	property	Labels.
ChartTrait::$rows	protected	property	Rows.
ChartTrait::$type	protected	property	Chart type.
ChartTrait::addLabel	public	function	Add a label.
ChartTrait::addRow	public	function	Add a row.
ChartTrait::getAllowedStyles	public	function	Get allowed styles.
ChartTrait::renderChart	public	function	Set all rows.
ChartTrait::setChartType	public	function	Add a label.
ChartTrait::setEmpty	public	function	Set this chart is empty.
ChartTrait::setLabels	public	function	Set all labels.
ChartTrait::setRows	public	function	Set all rows.
DashboardBase::$cache	protected	property	Cache backend.
DashboardBase::getCache	protected	function	Get cache for cid.
DashboardBase::massageFormValues	public	function	Validate settings form.
DashboardBase::setCache	protected	function	Set a new cache entry. Cache is prefixed by pluginid.
DashboardBase::validateForm	public	function	Validate settings form.	1
NodeStatistics::$entityQuery	protected	property	Entity query.
NodeStatistics::$entityTypeInfo	protected	property	Entity Type Manager.
NodeStatistics::buildRenderArray	public	function	Build render array. Overrides DashboardBase::buildRenderArray
NodeStatistics::buildSettingsForm	public	function	Build render array. Overrides DashboardBase::buildSettingsForm
NodeStatistics::create	public static	function	Creates an instance of the plugin. Overrides DashboardBase::create
NodeStatistics::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides DashboardBase::__construct
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.
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.