interface ExporterInterface in Tome 8

Provides an interface for the exporter.

Hierarchy

• interface \Drupal\tome_sync\ExporterInterface

1 file declares its use of ExporterInterface

ExportCommand.php in modules/tome_sync/src/Commands/ExportCommand.php

File

modules/tome_sync/src/ExporterInterface.php, line 10

Namespace

Drupal\tome_sync

interface ExporterInterface {

  /**
   * Grabs a list of content to export.
   *
   * @return array
   *   An array mapping entity type IDs to arrays of entity IDs to export.
   */
  public function getContentToExport();

  /**
   * Deletes all content and files from the export directories.
   *
   * @return bool
   *   Whether or not the deletion was successful.
   */
  public function deleteExportDirectories();

  /**
   * Exports a content entity to the target storage.
   *
   * @param \Drupal\Core\Entity\ContentEntityInterface $entity
   *   An entity to export.
   */
  public function exportContent(ContentEntityInterface $entity);

  /**
   * Deletes an exported content entity.
   *
   * @param \Drupal\Core\Entity\ContentEntityInterface $entity
   *   An entity to delete.
   */
  public function deleteContentExport(ContentEntityInterface $entity);

}

Members

Name	Modifiers	Type	Description	Overrides
ExporterInterface::deleteContentExport	public	function	Deletes an exported content entity.	1
ExporterInterface::deleteExportDirectories	public	function	Deletes all content and files from the export directories.	1
ExporterInterface::exportContent	public	function	Exports a content entity to the target storage.	1
ExporterInterface::getContentToExport	public	function	Grabs a list of content to export.	1