WebformExporter.php in Webform 6.x
Same filename and directory in other branches
Namespace
Drupal\webform\AnnotationFile
src/Annotation/WebformExporter.phpView source
<?php
namespace Drupal\webform\Annotation;
use Drupal\Component\Annotation\Plugin;
/**
* Defines a results exporter annotation object.
*
* Plugin Namespace: Plugin\WebformExporter.
*
* For a working example, see
* \Drupal\webform\Plugin\WebformExporter\DelimitedText/WebformExporter
*
* @see hook_webform_exporter_info_alter()
* @see \Drupal\webform\Plugin\WebformExporterInterface
* @see \Drupal\webform\Plugin\WebformExporterBase
* @see \Drupal\webform\Plugin\WebformExporterManager
* @see plugin_api
*
* @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;
}
Classes
Name | Description |
---|---|
WebformExporter | Defines a results exporter annotation object. |