public function WebformSubmissionStorage::getColumns in Webform 6.x

Same name and namespace in other branches

1. 8.5 src/WebformSubmissionStorage.php \Drupal\webform\WebformSubmissionStorage::getColumns()

Get submission columns used to display results table.

Parameters

\Drupal\webform\WebformInterface|null $webform: A webform.

\Drupal\Core\Entity\EntityInterface|null $source_entity: A webform submission source entity.

\Drupal\Core\Session\AccountInterface|null $account: A user account.

bool $include_elements: Flag that include all form element in the list of columns.

Return value

array An associative array of columns keyed by name.

Overrides WebformSubmissionStorageInterface::getColumns

5 calls to WebformSubmissionStorage::getColumns()

WebformSubmissionStorage::getCustomColumns in src/WebformSubmissionStorage.php

Get customized submission columns used to display custom table.

WebformSubmissionStorage::getDefaultColumns in src/WebformSubmissionStorage.php

Get default submission columns used to display results.

WebformSubmissionStorage::getSubmissionsColumns in src/WebformSubmissionStorage.php

Get submissions columns.

WebformSubmissionStorage::getUserColumns in src/WebformSubmissionStorage.php

Get user submission columns used to display results.

WebformSubmissionStorage::getUsersSubmissionsColumns in src/WebformSubmissionStorage.php

Get user submissions columns.

File

src/WebformSubmissionStorage.php, line 710

Class

WebformSubmissionStorage

Defines the webform submission storage.

Namespace

Drupal\webform

Code

public function getColumns(WebformInterface $webform = NULL, EntityInterface $source_entity = NULL, AccountInterface $account = NULL, $include_elements = TRUE) {
  $view_any = $webform && $webform
    ->access('submission_view_any') ? TRUE : FALSE;
  $columns = [];

  // Serial number.
  $columns['serial'] = [
    'title' => $this
      ->t('#'),
  ];

  // Submission ID.
  $columns['sid'] = [
    'title' => $this
      ->t('SID'),
  ];

  // Submission label.
  $columns['label'] = [
    'title' => $this
      ->t('Submission title'),
    'sort' => FALSE,
  ];

  // UUID.
  $columns['uuid'] = [
    'title' => $this
      ->t('UUID'),
  ];

  // Draft.
  $columns['in_draft'] = [
    'title' => $this
      ->t('In draft'),
  ];
  if (empty($account)) {

    // Sticky (Starred/Unstarred).
    $columns['sticky'] = [
      'title' => $this
        ->t('Starred'),
    ];

    // Locked.
    $columns['locked'] = [
      'title' => $this
        ->t('Locked'),
    ];

    // Notes.
    $columns['notes'] = [
      'title' => $this
        ->t('Notes'),
    ];
  }

  // Created.
  $columns['created'] = [
    'title' => $this
      ->t('Created'),
  ];

  // Completed.
  $columns['completed'] = [
    'title' => $this
      ->t('Completed'),
  ];

  // Changed.
  $columns['changed'] = [
    'title' => $this
      ->t('Changed'),
  ];

  // Source entity.
  if ($view_any && empty($source_entity)) {
    $columns['entity'] = [
      'title' => $this
        ->t('Submitted to'),
      'sort' => FALSE,
    ];
  }

  // Submitted by.
  if (empty($account)) {
    $columns['uid'] = [
      'title' => $this
        ->t('User'),
    ];
  }

  // Submission language.
  if ($view_any && $this->moduleHandler
    ->moduleExists('language')) {
    $columns['langcode'] = [
      'title' => $this
        ->t('Language'),
    ];
  }

  // Remote address.
  $columns['remote_addr'] = [
    'title' => $this
      ->t('IP address'),
  ];

  // Webform and source entity for entity.webform_submission.collection.
  // @see /admin/structure/webform/submissions/manage
  if (empty($webform) && empty($source_entity)) {
    $columns['webform_id'] = [
      'title' => $this
        ->t('Webform'),
    ];
    $columns['entity'] = [
      'title' => $this
        ->t('Submitted to'),
      'sort' => FALSE,
    ];
  }

  // Webform elements.
  if ($webform && $include_elements) {
    $elements = $webform
      ->getElementsInitializedFlattenedAndHasValue('view');
    foreach ($elements as $element) {

      /** @var \Drupal\webform\Plugin\WebformElementInterface $element_plugin */
      $element_plugin = $this->elementManager
        ->createInstance($element['#type']);

      // Replace tokens which can be used in an element's #title.
      $element_plugin
        ->replaceTokens($element, $webform);
      $columns += $element_plugin
        ->getTableColumn($element);
    }
  }

  // Operations.
  $columns['operations'] = [
    'title' => $this
      ->t('Operations'),
    'sort' => FALSE,
  ];

  // Add name and format to all columns.
  foreach ($columns as $name => &$column) {
    $column['name'] = $name;
    $column['format'] = 'value';
  }
  return $columns;
}