class WebformExporter in Webform 8.5

Defines a results exporter annotation object.

Plugin Namespace: Plugin\WebformExporter.

For a working example, see \Drupal\webform\Plugin\WebformExporter\DelimitedText/WebformExporter

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\webform\Annotation\WebformExporter

See also

hook_webform_exporter_info_alter()

\Drupal\webform\Plugin\WebformExporterInterface

\Drupal\webform\Plugin\WebformExporterBase

\Drupal\webform\Plugin\WebformExporterManager

Plugin API

7 classes are annotated with WebformExporter

DelimitedWebformExporter in src/Plugin/WebformExporter/DelimitedWebformExporter.php

Defines a delimited text exporter.

JsonWebformExporter in src/Plugin/WebformExporter/JsonWebformExporter.php

Defines a JSON document exporter.

TableWebformExporter in src/Plugin/WebformExporter/TableWebformExporter.php

Defines a HTML table exporter.

TestWebformExporter in tests/modules/webform_test_exporter/src/Plugin/WebformExporter/TestWebformExporter.php

Defines a test exporter.

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

Defines a Webform Entity Print PDF exporter.

... See full list

File

src/Annotation/WebformExporter.php, line 23

Namespace

Drupal\webform\Annotation

class WebformExporter extends Plugin {

  /**
   * The plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * The human-readable name of the results exporter.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $label;

  /**
   * The category in the admin UI where the block will be listed.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $category = '';

  /**
   * A brief description of the results exporter.
   *
   * This will be shown when adding or configuring this results exporter.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $description = '';

  /**
   * Generates zipped archive.
   *
   * @var bool
   */
  public $archive = FALSE;

  /**
   * Download uploaded files (in a zipped archive).
   *
   * @var bool
   */
  public $files = TRUE;

  /**
   * Using export options.
   *
   * @var bool
   */
  public $options = TRUE;

}

Members

Name	Modifiers	Type	Description	Overrides
Plugin::$definition	protected	property	The plugin definition read from the class annotation.	1
Plugin::get	public	function	Gets the value of an annotation. Overrides AnnotationInterface::get	5
Plugin::getClass	public	function	Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId	public	function	Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider	public	function	Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse	protected	function	Parses an annotation into its definition.
Plugin::setClass	public	function	Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider	public	function	Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct	public	function	Constructs a Plugin object.	2
WebformExporter::$archive	public	property	Generates zipped archive.
WebformExporter::$category	public	property	The category in the admin UI where the block will be listed.
WebformExporter::$description	public	property	A brief description of the results exporter.
WebformExporter::$files	public	property	Download uploaded files (in a zipped archive).
WebformExporter::$id	public	property	The plugin ID.
WebformExporter::$label	public	property	The human-readable name of the results exporter.
WebformExporter::$options	public	property	Using export options.