class TableYamlFormExporter in YAML Form 8

Defines a HTML table exporter.

Plugin annotation


@YamlFormExporter(
  id = "table",
  label = @Translation("HTML Table"),
  description = @Translation("Exports results as an HTML table."),
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\yamlform\YamlFormExporterBase implements YamlFormExporterInterface
    class \Drupal\yamlform\Plugin\YamlFormExporter\TabularBaseYamlFormExporter uses FileHandleTraitYamlFormExporter
    class \Drupal\yamlform\Plugin\YamlFormExporter\TableYamlFormExporter

Expanded class hierarchy of TableYamlFormExporter

File

src/Plugin/YamlFormExporter/TableYamlFormExporter.php, line 17

Namespace

Drupal\yamlform\Plugin\YamlFormExporter

View source

class TableYamlFormExporter extends TabularBaseYamlFormExporter {

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

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    if (isset($form['excel'])) {
      return $form;
    }
    $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.'),
      '#default_value' => $this->configuration['excel'],
      '#states' => [
        'visible' => [
          [
            ':input.js-yamlform-exporter' => [
              'value' => 'table',
            ],
          ],
        ],
      ],
    ];
    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['yamlform']) {
      $title = $this->configuration['yamlform']
        ->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>');
    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("\n", $thead));
    fwrite($file_handle, '</tr></thead>');
    fwrite($file_handle, '<tbody>');
  }

  /**
   * {@inheritdoc}
   */
  public function writeSubmission(YamlFormSubmissionInterface $yamlform_submission) {
    $record = $this
      ->buildRecord($yamlform_submission);
    $file_handle = $this->fileHandle;
    $row = [];
    foreach ($record as $item) {
      $row[] = '<td>' . htmlentities($item) . '</td>';
    }
    fwrite($file_handle, '<tr valign="top">');
    fwrite($file_handle, implode("\n", $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';
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
FileHandleTraitYamlFormExporter::$fileHandle	protected	property	A file handler resource.
FileHandleTraitYamlFormExporter::closeExport	public	function
FileHandleTraitYamlFormExporter::createExport	public	function
FileHandleTraitYamlFormExporter::openExport	public	function
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
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.
TableYamlFormExporter::buildConfigurationForm	public	function	Form constructor. Overrides YamlFormExporterBase::buildConfigurationForm
TableYamlFormExporter::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides YamlFormExporterBase::defaultConfiguration
TableYamlFormExporter::getFileExtension	public	function	Get export file extension. Overrides YamlFormExporterBase::getFileExtension
TableYamlFormExporter::writeFooter	public	function	Write footer to export. Overrides YamlFormExporterBase::writeFooter
TableYamlFormExporter::writeHeader	public	function	Write header to export. Overrides YamlFormExporterBase::writeHeader
TableYamlFormExporter::writeSubmission	public	function	Write submission to export. Overrides YamlFormExporterBase::writeSubmission
TabularBaseYamlFormExporter::$elements	protected	property	An associative array containing form elements keyed by name.
TabularBaseYamlFormExporter::$fieldDefinitions	protected	property	An associative array containing a form's field definitions.
TabularBaseYamlFormExporter::buildHeader	protected	function	Build export header using form submission field definitions and form element columns.
TabularBaseYamlFormExporter::buildRecord	protected	function	Build export record using a form submission.
TabularBaseYamlFormExporter::formatRecordFieldDefinitionValue	protected	function	Get the field definition value from a form submission entity.
TabularBaseYamlFormExporter::getElements	protected	function	Get form elements.
TabularBaseYamlFormExporter::getFieldDefinitions	protected	function	Get a form's field definitions.
YamlFormExporterBase::$elementManager	protected	property	The form element manager.
YamlFormExporterBase::$entityStorage	protected	property	Form submission storage.
YamlFormExporterBase::$entityTypeManager	protected	property	The entity type manager.
YamlFormExporterBase::$logger	protected	property	A logger instance.
YamlFormExporterBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
YamlFormExporterBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
YamlFormExporterBase::description	public	function	Returns the results exporter description. Overrides YamlFormExporterInterface::description
YamlFormExporterBase::getArchiveFileName	public	function	Get archive file name for a form. Overrides YamlFormExporterInterface::getArchiveFileName
YamlFormExporterBase::getArchiveFilePath	public	function	Get archive file name and path for a form. Overrides YamlFormExporterInterface::getArchiveFilePath
YamlFormExporterBase::getBaseFileName	public	function	Get export base file name without an extension. Overrides YamlFormExporterInterface::getBaseFileName
YamlFormExporterBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurablePluginInterface::getConfiguration
YamlFormExporterBase::getExportFileName	public	function	Get export file name. Overrides YamlFormExporterInterface::getExportFileName
YamlFormExporterBase::getExportFilePath	public	function	Get export file path. Overrides YamlFormExporterInterface::getExportFilePath
YamlFormExporterBase::getFileTempDirectory	public	function	Get export file temp directory. Overrides YamlFormExporterInterface::getFileTempDirectory
YamlFormExporterBase::getSourceEntity	protected	function	Get the form source entity whose submissions are being exported.
YamlFormExporterBase::getStatus	public	function	Returns the results exporter status. Overrides YamlFormExporterInterface::getStatus
YamlFormExporterBase::getSubmissionBaseName	public	function	Get form submission base file name. Overrides YamlFormExporterInterface::getSubmissionBaseName
YamlFormExporterBase::getYamlForm	protected	function	Get the form whose submissions are being exported.
YamlFormExporterBase::hasOptions	public	function	Determine if exporter has options. Overrides YamlFormExporterInterface::hasOptions
YamlFormExporterBase::isArchive	public	function	Determine if exporter generates an archive. Overrides YamlFormExporterInterface::isArchive
YamlFormExporterBase::label	public	function	Returns the results exporter label. Overrides YamlFormExporterInterface::label
YamlFormExporterBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurablePluginInterface::setConfiguration	1
YamlFormExporterBase::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
YamlFormExporterBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
YamlFormExporterBase::__construct	public	function	Constructs a Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct

You are here

class TableYamlFormExporter in YAML Form 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation