class Counter

Same name and namespace in other branches
  1. 11.x core/modules/views/src/Plugin/views/field/Counter.php \Drupal\views\Plugin\views\field\Counter

Field handler to show a counter of the current row.

Plugin annotation

@ViewsField("counter");

Hierarchy

Expanded class hierarchy of Counter

Related topics

1 file declares its use of Counter
CounterTest.php in core/modules/views/tests/src/Unit/Plugin/field/CounterTest.php
13 string references to 'Counter'
BigPipeTestController::trustedCallbacks in core/modules/big_pipe/tests/modules/big_pipe_test/src/BigPipeTestController.php
CounterTest::testCounterRandomPagerOffset in core/modules/views/tests/src/Unit/Plugin/field/CounterTest.php
Tests a counter field with a random pager offset.
CounterTest::testCounterRandomStart in core/modules/views/tests/src/Unit/Plugin/field/CounterTest.php
Tests a counter with a random start.
CounterTest::testCounterSecondPage in core/modules/views/tests/src/Unit/Plugin/field/CounterTest.php
Tests a counter field on the second page.
CounterTest::testSimpleCounter in core/modules/views/tests/src/Unit/Plugin/field/CounterTest.php
Tests a simple counter field.

... See full list

File

core/modules/views/src/Plugin/views/field/Counter.php, line 15

Namespace

Drupal\views\Plugin\views\field
View source
class Counter extends FieldPluginBase {
  use UncacheableFieldHandlerTrait;
  
  /**
   * {@inheritdoc}
   */
  public function usesGroupBy() {
    return FALSE;
  }
  
  /**
   * {@inheritdoc}
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['counter_start'] = [
      'default' => 1,
    ];
    return $options;
  }
  
  /**
   * {@inheritdoc}
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    $form['counter_start'] = [
      '#type' => 'textfield',
      '#title' => $this->t('Starting value'),
      '#default_value' => $this->options['counter_start'],
      '#description' => $this->t('Specify the number the counter should start at.'),
      '#size' => 2,
    ];
    parent::buildOptionsForm($form, $form_state);
  }
  
  /**
   * {@inheritdoc}
   */
  public function query() {
    // do nothing -- to override the parent query.
  }
  
  /**
   * {@inheritdoc}
   */
  public function getValue(ResultRow $values, $field = NULL) {
    // Note:  1 is subtracted from the counter start value below because the
    // counter value is incremented by 1 at the end of this function.
    $count = is_numeric($this->options['counter_start']) ? $this->options['counter_start'] - 1 : 0;
    $pager = $this->view->pager;
    // Get the base count of the pager.
    if ($pager->usePager()) {
      $count += $pager->getItemsPerPage() * $pager->getCurrentPage() + $pager->getOffset();
    }
    // Add the counter for the current site.
    $count += $this->view->row_index + 1;
    return $count;
  }

}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.