abstract class DocumentBaseYamlFormExporter in YAML Form 8

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\yamlform\YamlFormExporterBase implements YamlFormExporterInterface
      • class \Drupal\yamlform\Plugin\YamlFormExporter\DocumentBaseYamlFormExporter

File

src/Plugin/YamlFormExporter/DocumentBaseYamlFormExporter.php, line 11

Namespace

Drupal\yamlform\Plugin\YamlFormExporter

abstract class DocumentBaseYamlFormExporter extends YamlFormExporterBase {

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

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    if (isset($form['file_name'])) {
      return $form;
    }
    $form['file_name'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('File name'),
      '#description' => $this
        ->t('Submission file names must be unique.'),
      '#required' => TRUE,
      '#default_value' => $this->configuration['file_name'],
      '#states' => [
        'visible' => [
          [
            ':input.js-yamlform-exporter' => [
              'value' => 'json',
            ],
          ],
          'or',
          [
            ':input.js-yamlform-exporter' => [
              'value' => 'yaml',
            ],
          ],
        ],
      ],
    ];
    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
DocumentBaseYamlFormExporter::buildConfigurationForm	public	function	Form constructor. Overrides YamlFormExporterBase::buildConfigurationForm
DocumentBaseYamlFormExporter::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides YamlFormExporterBase::defaultConfiguration
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.
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::closeExport	public	function	Close export. Overrides YamlFormExporterInterface::closeExport
YamlFormExporterBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
YamlFormExporterBase::createExport	public	function	Create export. Overrides YamlFormExporterInterface::createExport
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::getFileExtension	public	function	Get export file extension. Overrides YamlFormExporterInterface::getFileExtension	2
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::openExport	public	function	Open export. Overrides YamlFormExporterInterface::openExport
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::writeFooter	public	function	Write footer to export. Overrides YamlFormExporterInterface::writeFooter	1
YamlFormExporterBase::writeHeader	public	function	Write header to export. Overrides YamlFormExporterInterface::writeHeader	2
YamlFormExporterBase::writeSubmission	public	function	Write submission to export. Overrides YamlFormExporterInterface::writeSubmission	4
YamlFormExporterBase::__construct	public	function	Constructs a Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct