interface YamlFormExporterInterface in YAML Form 8

Defines the interface for results exporters.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface; interface \Drupal\Component\Plugin\ConfigurablePluginInterface; interface \Drupal\Core\Plugin\PluginFormInterface; interface \Drupal\Core\Plugin\ContainerFactoryPluginInterface
  • interface \Drupal\yamlform\YamlFormExporterInterface

See also

\Drupal\yamlform\Annotation\YamlFormExporter

\Drupal\yamlform\YamlFormExporterBase

\Drupal\yamlform\YamlFormExporterManager

\Drupal\yamlform\YamlFormExporterManagerInterface

Plugin API

File

src/YamlFormExporterInterface.php, line 19

Namespace

Drupal\yamlform

interface YamlFormExporterInterface extends PluginInspectionInterface, ConfigurablePluginInterface, PluginFormInterface, ContainerFactoryPluginInterface {

  /**
   * Returns the results exporter label.
   *
   * @return string
   *   The results exporter label.
   */
  public function label();

  /**
   * Returns the results exporter description.
   *
   * @return string
   *   The results exporter description.
   */
  public function description();

  /**
   * Determine if exporter generates an archive.
   *
   * @return bool
   *   TRUE if exporter generates an archive.
   */
  public function isArchive();

  /**
   * Determine if exporter has options.
   *
   * @return bool
   *   TRUE if export has options.
   */
  public function hasOptions();

  /**
   * Returns the results exporter status.
   *
   * @return bool
   *   TRUE is the results exporter is available.
   */
  public function getStatus();

  /**
   * Create export.
   */
  public function createExport();

  /**
   * Open export.
   */
  public function openExport();

  /**
   * Close export.
   */
  public function closeExport();

  /**
   * Write header to export.
   */
  public function writeHeader();

  /**
   * Write submission to export.
   *
   * @param \Drupal\yamlform\YamlFormSubmissionInterface $yamlform_submission
   *   A form submission.
   */
  public function writeSubmission(YamlFormSubmissionInterface $yamlform_submission);

  /**
   * Write footer to export.
   */
  public function writeFooter();

  /**
   * Get export file temp directory.
   *
   * @return string
   *   The export file temp directory..
   */
  public function getFileTempDirectory();

  /**
   * Get form submission base file name.
   *
   * @param \Drupal\yamlform\YamlFormSubmissionInterface $yamlform_submission
   *   A form submission.
   *
   * @return string
   *   Form submission's base file name.
   */
  public function getSubmissionBaseName(YamlFormSubmissionInterface $yamlform_submission);

  /**
   * Get export file extension.
   *
   * @return string
   *   A file extension.
   */
  public function getFileExtension();

  /**
   * Get export base file name without an extension.
   *
   * @return string
   *   A base file name.
   */
  public function getBaseFileName();

  /**
   * Get export file name.
   *
   * @return string
   *   A file name.
   */
  public function getExportFileName();

  /**
   * Get export file path.
   *
   * @return string
   *   A file path.
   */
  public function getExportFilePath();

  /**
   * Get archive file name and path for a form.
   *
   * @return string
   *   Archive file name and path for a form
   */
  public function getArchiveFilePath();

  /**
   * Get archive file name for a form.
   *
   * @return string
   *   Archive file name.
   */
  public function getArchiveFileName();

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurablePluginInterface::defaultConfiguration	public	function	Gets default configuration for this plugin.	1
ConfigurablePluginInterface::getConfiguration	public	function	Gets this plugin's configuration.	1
ConfigurablePluginInterface::setConfiguration	public	function	Sets the configuration for this plugin instance.	1
ContainerFactoryPluginInterface::create	public static	function	Creates an instance of the plugin.	112
DependentPluginInterface::calculateDependencies	public	function	Calculates dependencies for the configured plugin.	19
PluginFormInterface::buildConfigurationForm	public	function	Form constructor.	36
PluginFormInterface::submitConfigurationForm	public	function	Form submission handler.	32
PluginFormInterface::validateConfigurationForm	public	function	Form validation handler.	18
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2
YamlFormExporterInterface::closeExport	public	function	Close export.	1
YamlFormExporterInterface::createExport	public	function	Create export.	1
YamlFormExporterInterface::description	public	function	Returns the results exporter description.	1
YamlFormExporterInterface::getArchiveFileName	public	function	Get archive file name for a form.	1
YamlFormExporterInterface::getArchiveFilePath	public	function	Get archive file name and path for a form.	1
YamlFormExporterInterface::getBaseFileName	public	function	Get export base file name without an extension.	1
YamlFormExporterInterface::getExportFileName	public	function	Get export file name.	1
YamlFormExporterInterface::getExportFilePath	public	function	Get export file path.	1
YamlFormExporterInterface::getFileExtension	public	function	Get export file extension.	1
YamlFormExporterInterface::getFileTempDirectory	public	function	Get export file temp directory.	1
YamlFormExporterInterface::getStatus	public	function	Returns the results exporter status.	1
YamlFormExporterInterface::getSubmissionBaseName	public	function	Get form submission base file name.	1
YamlFormExporterInterface::hasOptions	public	function	Determine if exporter has options.	1
YamlFormExporterInterface::isArchive	public	function	Determine if exporter generates an archive.	1
YamlFormExporterInterface::label	public	function	Returns the results exporter label.	1
YamlFormExporterInterface::openExport	public	function	Open export.	1
YamlFormExporterInterface::writeFooter	public	function	Write footer to export.	1
YamlFormExporterInterface::writeHeader	public	function	Write header to export.	1
YamlFormExporterInterface::writeSubmission	public	function	Write submission to export.	1