class Submissions in Dashboards with Layout Builder 8

Same name and namespace in other branches

2.0.x modules/dashboards_webform/src/Plugin/Dashboard/Submissions.php \Drupal\dashboards_webform\Plugin\Dashboard\Submissions

Show account info.

Plugin annotation


@Dashboard(
  id = "webform_submissions",
  label = @Translation("Submission statistic."),
  category = @Translation("Webform"),
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\dashboards\Plugin\DashboardBase implements ContainerFactoryPluginInterface, DashboardInterface uses StringTranslationTrait
  - class \Drupal\dashboards_webform\Plugin\Dashboard\Submissions uses ChartTrait

Expanded class hierarchy of Submissions

File

modules/dashboards_webform/src/Plugin/Dashboard/Submissions.php, line 22

Namespace

Drupal\dashboards_webform\Plugin\Dashboard

View source

class Submissions extends DashboardBase {
  use ChartTrait;

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

  /**
   * EntityTypeManagerInterface definition.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, CacheBackendInterface $cache_backend, Connection $database, EntityTypeManagerInterface $entity_type_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $cache_backend);
    $this->database = $database;
    $this->entityTypeManager = $entity_type_manager;
  }

  /**
   * {@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('database'), $container
      ->get('entity_type.manager'));
  }

  /**
   * {@inheritdoc}
   */
  public function buildSettingsForm(array $form, FormStateInterface $form_state, array $configuration) : array {
    $webform = FALSE;
    if (!empty($configuration['webform'])) {
      $webform = $this->entityTypeManager
        ->getStorage('webform')
        ->load($configuration['webform']);
    }
    $form['webform'] = [
      '#type' => 'entity_autocomplete',
      '#target_type' => 'webform',
      '#selection_handler' => 'default',
      '#default_value' => $webform,
    ];
    $form['period'] = [
      '#type' => 'select',
      '#options' => [
        'hour' => $this
          ->t('Hour'),
        'day' => $this
          ->t('Day'),
        'week' => $this
          ->t('Week'),
        'month' => $this
          ->t('Month'),
      ],
      '#default_value' => isset($configuration['period']) ? $configuration['period'] : 'day',
    ];
    $form['date'] = [
      '#type' => 'select',
      '#options' => [
        'today' => $this
          ->t('Today'),
        'yesterday' => $this
          ->t('Yesterday'),
        'this_week' => $this
          ->t('This week'),
        'this_month' => $this
          ->t('This month'),
        'last_three_months' => $this
          ->t('Last 3 months'),
        'last_six_months' => $this
          ->t('Last 6 months'),
        'year' => $this
          ->t('This year'),
      ],
      '#default_value' => isset($configuration['date']) ? $configuration['date'] : 'today',
    ];
    $form['chart_type'] = [
      '#type' => 'select',
      '#options' => $this
        ->getAllowedStyles(),
      '#default_value' => isset($configuration['chart_type']) ? $configuration['chart_type'] : 'bar',
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function buildRenderArray($configuration) : array {
    $field = $configuration['period'];
    $cid = md5(serialize([
      $configuration['period'],
      $configuration['date'],
    ]));
    $dateLabel = $this
      ->t('Date');
    $cache = $this
      ->getCache($cid);
    $cache = FALSE;
    if (!$cache) {
      $query = $this->database
        ->select('webform_submission', 'ws');
      if (isset($configuration['webform'])) {
        $query
          ->condition('webform_id', $configuration['webform']);
      }
      switch ($configuration['date']) {
        case 'yesterday':
          $query
            ->condition('ws.created', [
            strtotime('yesterday'),
            strtotime('today'),
          ], 'BETWEEN');
          break;
        case 'this_week':
          $query
            ->condition('ws.created', strtotime('this week'), '>=');
          break;
        case 'this_month':
          $query
            ->condition('ws.created', strtotime('first day of this month'), '>=');
          break;
        case 'last_three_months':
          $query
            ->condition('ws.created', strtotime('first day of this month -3 months'), '>=');
          break;
        case 'last_six_months':
          $query
            ->condition('ws.created', strtotime('first day of this month -6 months'), '>=');
          break;
        case 'year':
          $query
            ->condition('ws.created', strtotime('first day of january this year'), '>=');
          break;
        default:
          $query
            ->condition('ws.created', strtotime('yesterday'), '>=');
          break;
      }
      switch ($field) {
        case 'week':
          $query
            ->addExpression('CONCAT(YEAR(FROM_UNIXTIME(ws.created)), \'-\', WEEK(FROM_UNIXTIME(ws.created)))', 'date');
          break;
        case 'month':
          $query
            ->addExpression('CONCAT(YEAR(FROM_UNIXTIME(ws.created)), \'-\', MONTH(FROM_UNIXTIME(ws.created)))', 'date');
          break;
        case 'hour':
          $query
            ->addExpression('CONCAT(YEAR(FROM_UNIXTIME(ws.created)), \'-\', MONTH(FROM_UNIXTIME(ws.created)),\'-\', DAY(FROM_UNIXTIME(ws.created)), \' \', HOUR(FROM_UNIXTIME(ws.created)),\':00\')', 'date');
          break;
        default:
          $query
            ->addExpression('CONCAT(YEAR(FROM_UNIXTIME(ws.created)), \'-\', MONTH(FROM_UNIXTIME(ws.created)), \'-\', DAY(FROM_UNIXTIME(ws.created)))', 'date');
          break;
      }
      $query
        ->addExpression('COUNT(*)', 'count');
      $query
        ->groupBy('date');
      $query
        ->groupBy('webform_id');
      $query
        ->orderBy('webform_id');
      $query
        ->fields('ws', [
        'webform_id',
      ]);
      $result = $query
        ->execute()
        ->fetchAll();
      $rows = [];
      $labels = [];
      foreach ($result as $r) {
        $labels[$r->webform_id] = $r->webform_id;
      }
      foreach ($labels as $key => $label) {
        foreach ($result as $r) {
          if ($r->webform_id != $label) {
            continue;
          }
          $rows[$r->date][$key] = $r->count;
        }
      }
      foreach ($rows as $key => $row) {
        foreach ($labels as $label) {
          if (!isset($row[$label])) {
            $rows[$key][$label] = 0;
          }
        }
      }
      foreach ($rows as $key => $row) {
        array_unshift($rows[$key], $key);
      }
      usort($rows, function ($a, $b) {
        return strcmp($a[0], $b[0]);
      });
      $labels = array_merge([
        $dateLabel,
      ], $labels);
      $this
        ->setCache($cid, [
        'labels' => $labels,
        'rows' => $rows,
      ], time() + 1800, [
        'node_list',
      ]);
    }
    else {
      $rows = $cache->data['rows'];
      $labels = $cache->data['labels'];
    }
    $this
      ->setLabels($labels);
    $this
      ->setRows($rows);
    $this
      ->setChartType($configuration['chart_type']);
    $build = $this
      ->renderChart($configuration);
    $build['#cache'] = [
      'tags' => [
        'node_list',
      ],
    ];
    return $build;
  }

}

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
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.
Submissions::$database	protected	property	Database.
Submissions::$entityTypeManager	protected	property	EntityTypeManagerInterface definition.
Submissions::buildRenderArray	public	function	Build render array. Overrides DashboardBase::buildRenderArray
Submissions::buildSettingsForm	public	function	Build render array. Overrides DashboardBase::buildSettingsForm
Submissions::create	public static	function	Creates an instance of the plugin. Overrides DashboardBase::create
Submissions::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides DashboardBase::__construct

You are here

class Submissions in Dashboards with Layout Builder 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation