Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
100.00%
12 / 12
100.00%
3 / 3
 CRAP
100.00%
1 / 1
Bounce
100.00%
12 / 12
100.00%
3 / 3
 6
100.00%
1 / 1
 getFormula
100.00%
1 / 1
100.00%
1 / 1
 1
 query
100.00%
10 / 10
100.00%
1 / 1
 4
 usesGroupBy
100.00%
1 / 1
100.00%
1 / 1
 1
1<?php
2
3namespace Drupal\visitors\Plugin\views\field;
4
5use Drupal\views\Attribute\ViewsField;
6use Drupal\views\Plugin\views\field\FieldPluginBase;
7
8/**
9 * Field handler to display bounce rate.
10 */
11#[ViewsField("visitors_bounce")]
12class Bounce extends FieldPluginBase {
13
14  /**
15   * The formula for this handler.
16   *
17   * @var string|null
18   */
19  public $formula = "CASE WHEN ***table***.total_events = 1 THEN 1 ELSE 0 END";
20
21  /**
22   * Gets the prepared formula.
23   *
24   * @return string
25   *   The formula with the table placeholder replaced.
26   */
27  public function getFormula() {
28    return str_replace('***table***', $this->tableAlias, $this->formula);
29  }
30
31  /**
32   * {@inheritdoc}
33   */
34  public function query() {
35    $this->ensureMyTable();
36
37    // Get the formula and add it as a field.
38    $formula = $this->getFormula();
39
40    // Add the field with aggregation support.
41    $params = [];
42
43    // Always set a function for aggregation when grouping is enabled.
44    if ($this->view->display_handler->useGroupBy()) {
45      $params['function'] = !empty($this->options['group_type']) && $this->options['group_type'] != 'group'
46        ? $this->options['group_type']
47        : 'sum';
48
49      $params['orderby'] = FALSE;
50      $params['no_group'] = TRUE;
51    }
52
53    // Use addField with NULL table to indicate this is an expression/formula.
54    // This allows Views to properly apply aggregation functions to
55    // the expression.
56    $this->field_alias = $this->query->addField(NULL, $formula, $this->tableAlias . '__bounce', $params);
57  }
58
59  /**
60   * {@inheritdoc}
61   */
62  public function usesGroupBy() {
63    return FALSE;
64  }
65
66}