You are here

Home » API reference » Webform 6.x

TableWebformExporter.php in Webform 6.x

Same filename and directory in other branches
  1. 8.5 src/Plugin/WebformExporter/TableWebformExporter.php

Namespace

Drupal\webform\Plugin\WebformExporter

File

src/Plugin/WebformExporter/TableWebformExporter.php
View source 
<?php

namespace Drupal\webform\Plugin\WebformExporter;

use Drupal\Core\Form\FormStateInterface;
use Drupal\webform\WebformSubmissionInterface;

/**
 * Defines a HTML table exporter.
 *
 * @WebformExporter(
 *   id = "table",
 *   label = @Translation("HTML Table"),
 *   description = @Translation("Exports results as an HTML table."),
 * )
 */
class TableWebformExporter extends TabularBaseWebformExporter {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return parent::defaultConfiguration() + [
      'excel' => FALSE,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildConfigurationForm($form, $form_state);
    $form['excel'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Open HTML table in Excel'),
      '#description' => $this
        ->t('If checked, the download file extension will be change from .html to .xls.'),
      '#return_value' => TRUE,
      '#default_value' => $this->configuration['excel'],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function writeHeader() {
    $header = $this
      ->buildHeader();
    $file_handle = $this->fileHandle;
    if ($this->configuration['source_entity']) {
      $title = $this->configuration['source_entity']
        ->label();
    }
    elseif ($this->configuration['webform']) {
      $title = $this->configuration['webform']
        ->label();
    }
    else {
      $title = '';
    }
    $thead = [];
    foreach ($header as $item) {
      $thead[] = '<th>' . htmlentities($item) . '</th>';
    }
    fwrite($file_handle, '<!doctype html>');
    fwrite($file_handle, '<html>');
    fwrite($file_handle, '<head>');

    // Force Excel to keep field values containing p- or br-tags within the same
    // cell.
    fwrite($file_handle, '<style>p, br {mso-data-placement:same-cell;}</style>');
    fwrite($file_handle, '<meta charset="utf-8">');
    if ($title) {
      fwrite($file_handle, '<title>' . $title . '</title>');
    }
    fwrite($file_handle, '</head>');
    fwrite($file_handle, '<body>');
    fwrite($file_handle, '<table border="1">');
    fwrite($file_handle, '<thead><tr bgcolor="#cccccc" valign="top">');
    fwrite($file_handle, implode(PHP_EOL, $thead));
    fwrite($file_handle, '</tr></thead>');
    fwrite($file_handle, '<tbody>');
  }

  /**
   * {@inheritdoc}
   */
  public function writeSubmission(WebformSubmissionInterface $webform_submission) {
    $record = $this
      ->buildRecord($webform_submission);
    $file_handle = $this->fileHandle;
    $row = [];
    foreach ($record as $item) {
      $row[] = '<td>' . nl2br(htmlentities($item)) . '</td>';
    }
    fwrite($file_handle, '<tr valign="top">');
    fwrite($file_handle, implode(PHP_EOL, $row));
    fwrite($file_handle, '</tr>');
  }

  /**
   * {@inheritdoc}
   */
  public function writeFooter() {
    $file_handle = $this->fileHandle;
    fwrite($file_handle, '</tbody>');
    fwrite($file_handle, '</table>');
    fwrite($file_handle, '</body>');
    fwrite($file_handle, '</html>');
  }

  /**
   * {@inheritdoc}
   */
  public function getFileExtension() {
    return $this->configuration['excel'] ? 'xls' : 'html';
  }

}

Classes

Namesort descending Description
TableWebformExporter Defines a HTML table exporter.