You are here

interface EntityTraversalInterface in General Data Protection Regulation 8.2

Same name and namespace in other branches
  1. 8 modules/gdpr_fields/src/EntityTraversalInterface.php \Drupal\gdpr_fields\EntityTraversalInterface
  2. 3.0.x modules/gdpr_fields/src/EntityTraversalInterface.php \Drupal\gdpr_fields\EntityTraversalInterface

Defines a common interface for entity traversal.

Hierarchy

Expanded class hierarchy of EntityTraversalInterface

All classes that implement EntityTraversalInterface

File

modules/gdpr_fields/src/EntityTraversalInterface.php, line 8

Namespace

Drupal\gdpr_fields
View source
interface EntityTraversalInterface extends EntityTraversalContainerInjectionInterface {

  /**
   * Traverses the entity relationship tree if not done before.
   *
   * @return bool
   *   Whether or not the traversal was successful.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  public function traverse();

  /**
   * Get the traversal results.
   *
   * @return array|null
   *   Results collected by the traversal.
   *   By default this will be a nested array. The first dimension is
   *   keyed by entity type and contains an array keyed by entity ID.
   *   The values will be the entity instances.
   */
  public function getResults();

}

Members

Namesort descending Modifiers Type Description Overrides
EntityTraversalContainerInjectionInterface::create public static function Creates an instance of the traversal for this specific entity. 1
EntityTraversalInterface::getResults public function Get the traversal results. 1
EntityTraversalInterface::traverse public function Traverses the entity relationship tree if not done before. 1