interface EntityProcessorInterface in Content Synchronizer 3.x

The Entity processor interface.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface
  • interface \Drupal\content_synchronizer\Processors\Entity\EntityProcessorInterface

1 file declares its use of EntityProcessorInterface

FileProcessor.php in src/Plugin/content_synchronizer/entity_processor/FileProcessor.php

File

src/Processors/Entity/EntityProcessorInterface.php, line 11

Namespace

Drupal\content_synchronizer\Processors\Entity

interface EntityProcessorInterface extends PluginInspectionInterface {

  /**
   * Return the data to export.
   *
   * Get the array of data to export in array format :
   * [
   *    "property_1"=>[ "value1", "value2"]
   *    "property_2"=>[ "value1"]
   * ].
   *
   * @param \Drupal\Core\Entity\EntityInterface $entityToExport
   *   The entity to export.
   *
   * @return array|bool
   *   The entity data to export.
   */
  public function getDataToExport(EntityInterface $entityToExport);

  /**
   * Get the array of the property of the entity not to export :.
   *
   * @return array
   *   The properties not to export.
   */
  public function getPropertiesIdsNotToExportList();

  /**
   * Return the entity to import.
   *
   * @return \Drupal\Core\Entity\EntityInterface
   *   The entity to import.
   */
  public function getEntityToImport(array $data, EntityInterface $existingEntity);

}

Members

Name	Modifiers	Type	Description	Overrides
EntityProcessorInterface::getDataToExport	public	function	Return the data to export.	1
EntityProcessorInterface::getEntityToImport	public	function	Return the entity to import.	1
EntityProcessorInterface::getPropertiesIdsNotToExportList	public	function	Get the array of the property of the entity not to export :.	1
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