abstract class DocumentBaseWebformExporter in Webform 8.5

Defines abstract document exporter used to export YAML or JSON.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\webform\Plugin\WebformExporterBase implements WebformExporterInterface
      • class \Drupal\webform\Plugin\WebformExporter\DocumentBaseWebformExporter

1 file declares its use of DocumentBaseWebformExporter

WebformEntityPrintWebformExporter.php in modules/webform_entity_print/src/Plugin/WebformExporter/WebformEntityPrintWebformExporter.php

File

src/Plugin/WebformExporter/DocumentBaseWebformExporter.php, line 11

Namespace

Drupal\webform\Plugin\WebformExporter

abstract class DocumentBaseWebformExporter extends WebformExporterBase {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return parent::defaultConfiguration() + [
      'file_name' => 'submission-[webform_submission:serial]',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildConfigurationForm($form, $form_state);
    $form['file_name'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('File name'),
      '#description' => $this
        ->t('Used to create unique file names for exported submissions.'),
      '#required' => TRUE,
      '#default_value' => $this->configuration['file_name'],
    ];
    return $form;
  }

}

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
DocumentBaseWebformExporter::buildConfigurationForm	public	function	Form constructor. Overrides WebformExporterBase::buildConfigurationForm	1
DocumentBaseWebformExporter::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides WebformExporterBase::defaultConfiguration	1
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.
WebformExporterBase::$archive	protected	property	Cached archive object.
WebformExporterBase::$configFactory	protected	property	The configuration factory.
WebformExporterBase::$elementManager	protected	property	The webform element manager.
WebformExporterBase::$entityStorage	protected	property	The webform submission storage.
WebformExporterBase::$entityTypeManager	protected	property	The entity type manager.
WebformExporterBase::$logger	protected	property	A logger instance.
WebformExporterBase::$tokenManager	protected	property	The webform token manager.
WebformExporterBase::addToArchive	public	function	Add file, directory, or content to exporter archive. Overrides WebformExporterInterface::addToArchive
WebformExporterBase::addToTarArchive	protected	function	Add file, directory, or content to Tar archive.
WebformExporterBase::addToZipFile	protected	function	Add file, directory, or content to ZIP file.
WebformExporterBase::closeExport	public	function	Close export. Overrides WebformExporterInterface::closeExport
WebformExporterBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	1
WebformExporterBase::createExport	public	function	Create export. Overrides WebformExporterInterface::createExport
WebformExporterBase::description	public	function	Returns the results exporter description. Overrides WebformExporterInterface::description
WebformExporterBase::getArchiveFileExtension	public	function	Get archive file extension for a webform. Overrides WebformExporterInterface::getArchiveFileExtension
WebformExporterBase::getArchiveFileName	public	function	Get archive file name for a webform. Overrides WebformExporterInterface::getArchiveFileName
WebformExporterBase::getArchiveFilePath	public	function	Get archive file name and path for a webform. Overrides WebformExporterInterface::getArchiveFilePath
WebformExporterBase::getArchiveType	public	function	Get archive file type. Overrides WebformExporterInterface::getArchiveType
WebformExporterBase::getBaseFileName	public	function	Get export base file name without an extension. Overrides WebformExporterInterface::getBaseFileName
WebformExporterBase::getBatchLimit	public	function	Get the number of submissions to be exported with each batch. Overrides WebformExporterInterface::getBatchLimit	1
WebformExporterBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
WebformExporterBase::getExportFileName	public	function	Get export file name. Overrides WebformExporterInterface::getExportFileName
WebformExporterBase::getExportFilePath	public	function	Get export file path. Overrides WebformExporterInterface::getExportFilePath
WebformExporterBase::getFileExtension	public	function	Get export file extension. Overrides WebformExporterInterface::getFileExtension	3
WebformExporterBase::getFileTempDirectory	public	function	Get export file temp directory. Overrides WebformExporterInterface::getFileTempDirectory
WebformExporterBase::getSourceEntity	protected	function	Get the webform source entity whose submissions are being exported.
WebformExporterBase::getStatus	public	function	Returns the results exporter status. Overrides WebformExporterInterface::getStatus
WebformExporterBase::getSubmissionBaseName	public	function	Get webform submission base file name. Overrides WebformExporterInterface::getSubmissionBaseName
WebformExporterBase::getWebform	protected	function	Get the webform whose submissions are being exported.
WebformExporterBase::hasFiles	public	function	Determine if exporter can include uploaded files (in a zipped archive). Overrides WebformExporterInterface::hasFiles
WebformExporterBase::hasOptions	public	function	Determine if exporter has options. Overrides WebformExporterInterface::hasOptions
WebformExporterBase::isArchive	public	function	Determine if exporter generates an archive. Overrides WebformExporterInterface::isArchive
WebformExporterBase::isExcluded	public	function	Checks if the exporter is excluded via webform.settings. Overrides WebformExporterInterface::isExcluded
WebformExporterBase::label	public	function	Returns the results exporter label. Overrides WebformExporterInterface::label
WebformExporterBase::openExport	public	function	Open export. Overrides WebformExporterInterface::openExport
WebformExporterBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration	1
WebformExporterBase::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
WebformExporterBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
WebformExporterBase::writeFooter	public	function	Write footer to export. Overrides WebformExporterInterface::writeFooter	1
WebformExporterBase::writeHeader	public	function	Write header to export. Overrides WebformExporterInterface::writeHeader	3
WebformExporterBase::writeSubmission	public	function	Write submission to export. Overrides WebformExporterInterface::writeSubmission	6
WebformExporterBase::__construct	public	function	Constructs a WebformExporterBase object. Overrides PluginBase::__construct	1
WebformExporterInterface::ARCHIVE_TAR		constant	Tar archive.
WebformExporterInterface::ARCHIVE_ZIP		constant	ZIP file.