class Comments in Dashboards with Layout Builder 8
Same name and namespace in other branches
- 2.0.x modules/dashboards_comments/src/Plugin/Dashboard/Comments.php \Drupal\dashboards_comments\Plugin\Dashboard\Comments
Plugin for comment reports.
Plugin annotation
@Dashboard(
id = "comments_statistic",
label = @Translation("Comment per node type."),
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_comments\Plugin\Dashboard\Comments uses ChartTrait
- class \Drupal\dashboards\Plugin\DashboardBase implements ContainerFactoryPluginInterface, DashboardInterface uses StringTranslationTrait
Expanded class hierarchy of Comments
File
- modules/
dashboards_comments/ src/ Plugin/ Dashboard/ Comments.php, line 24
Namespace
Drupal\dashboards_comments\Plugin\DashboardView source
class Comments extends DashboardBase {
use ChartTrait;
/**
* Entity Type Manager.
*
* @var \Drupal\Core\Entity\EntityTypeBundleInfoInterface
*/
protected $entityTypeInfo;
/**
* Module Handler.
*
* @var \Drupal\Core\Extension\ModuleHandlerInterface
*/
protected $moduleHandler;
/**
* Database.
*
* @var \Drupal\Core\Database\Connection
*/
protected $database;
/**
* {@inheritdoc}
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, CacheBackendInterface $cache_backend, EntityTypeBundleInfoInterface $entity_type_info, ModuleHandlerInterface $module_handler, Connection $database) {
parent::__construct($configuration, $plugin_id, $plugin_definition, $cache_backend);
$this->entityTypeInfo = $entity_type_info;
$this->moduleHandler = $module_handler;
$this->database = $database;
}
/**
* {@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.bundle.info'), $container
->get('module_handler'), $container
->get('database'));
}
/**
* {@inheritdoc}
*/
public function buildSettingsForm(array $form, FormStateInterface $form_state, array $configuration) : array {
$options = [
'totalcount' => $this
->t('Total count'),
'daycount' => $this
->t('Dayly count'),
];
$form['count'] = [
'#type' => 'select',
'#options' => $options,
'#default_value' => isset($configuration['count']) ? $configuration['count'] : FALSE,
];
return $form;
}
/**
* {@inheritdoc}
*/
public function buildRenderArray($configuration) : array {
$stats = [];
$field = 'comment_count';
$cache = $this
->getCache($field);
if (!$cache) {
$query = $this->database
->select('node_field_data', 'nfd');
$query
->join('comment_entity_statistics', 'ces', 'ces.entity_id = nfd.nid');
$query
->fields('nfd', [
'type',
]);
$query
->addExpression('SUM(ces.' . $field . ')', 'count');
$query
->groupBy('type');
$rows = [];
$stats['types'] = $query
->execute()
->fetchAllAssoc('type');
foreach ($stats['types'] as $type => $count) {
$rows[] = [
$type,
$count->count,
];
}
$this
->setCache($field, $rows, CacheBackendInterface::CACHE_PERMANENT, [
'comment_list',
]);
}
else {
$rows = $cache->data;
}
$this
->setLabels([
$this
->t('Node Type'),
$this
->t('Count'),
]);
$this
->setRows($rows);
$build = $this
->renderChart($configuration);
$build['#cache'] = [
'tags' => [
'node_list',
],
];
return $build;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ChartTrait:: |
protected | property | Empty flag. | |
ChartTrait:: |
protected | property | Labels. | |
ChartTrait:: |
protected | property | Rows. | |
ChartTrait:: |
protected | property | Chart type. | |
ChartTrait:: |
public | function | Add a label. | |
ChartTrait:: |
public | function | Add a row. | |
ChartTrait:: |
public | function | Get allowed styles. | |
ChartTrait:: |
public | function | Set all rows. | |
ChartTrait:: |
public | function | Add a label. | |
ChartTrait:: |
public | function | Set this chart is empty. | |
ChartTrait:: |
public | function | Set all labels. | |
ChartTrait:: |
public | function | Set all rows. | |
Comments:: |
protected | property | Database. | |
Comments:: |
protected | property | Entity Type Manager. | |
Comments:: |
protected | property | Module Handler. | |
Comments:: |
public | function |
Build render array. Overrides DashboardBase:: |
|
Comments:: |
public | function |
Build render array. Overrides DashboardBase:: |
|
Comments:: |
public static | function |
Creates an instance of the plugin. Overrides DashboardBase:: |
|
Comments:: |
public | function |
Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides DashboardBase:: |
|
DashboardBase:: |
protected | property | Cache backend. | |
DashboardBase:: |
protected | function | Get cache for cid. | |
DashboardBase:: |
public | function | Validate settings form. | |
DashboardBase:: |
protected | function | Set a new cache entry. Cache is prefixed by pluginid. | |
DashboardBase:: |
public | function | Validate settings form. | 1 |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |