ElementExporterInterface
- Type
- Interface
- Namespace
- craft\base
- Extends
- craft\base\ComponentInterface
- Implemented by
- craft\base\ElementExporter, craft\elements\exporters\Expanded, craft\elements\exporters\Raw
- Since
- 3.4.0
ElementExporterInterface defines the common interface to be implemented by element exporter classes.
View source (opens new window)
# Public Methods
| Method | Description |
|---|---|
| displayName() | Returns the display name of this class. |
| export() | Creates the export data for elements fetched with the given element query. |
| getFilename() | Returns the filename (sans extension) that the export file should have. |
| isSelectable() | Returns whether the component should be selectable in component Type selects. |
| setElementType() | Sets the element type on the exporter. |
# export()
Creates the export data for elements fetched with the given element query.
View source (opens new window)
Arguments
$query(craft\elements\db\ElementQueryInterface) – The element query
Returns
# getFilename()
Returns the filename (sans extension) that the export file should have.
View source (opens new window)
Returns
# setElementType()
Sets the element type on the exporter.
View source (opens new window)
Arguments
$elementType(string (opens new window))