interface GetInterface in Synonyms 2.0.x

Interface to extract (get) synonyms from an entity.

Hierarchy

• interface \Drupal\synonyms\ProviderInterface\GetInterface

1 file declares its use of GetInterface

AbstractProvider.php in src/Plugin/Synonyms/Provider/AbstractProvider.php

File

src/ProviderInterface/GetInterface.php, line 10

Namespace

Drupal\synonyms\ProviderInterface

interface GetInterface {

  /**
   * Fetch synonyms from an entity.
   *
   * @param \Drupal\Core\Entity\ContentEntityInterface $entity
   *   Entity whose synonyms should be fetched.
   *
   * @return string[]
   *   Array of extracted synonyms
   */
  public function getSynonyms(ContentEntityInterface $entity);

  /**
   * Fetch synonyms from multiple entities at once.
   *
   * @param array $entities
   *   Array of entities whose synonyms should be fetched. The array will be
   *   keyed by entity ID and all provided entities will be of the same entity
   *   type and bundle.
   *
   * @return array
   *   Array of extracted synonyms. It must be keyed by entity ID and each sub
   *   array should represent a list of synonyms that were extracted from the
   *   corresponding entity
   */
  public function getSynonymsMultiple(array $entities);

}

Members

Name	Modifiers	Type	Description	Overrides
GetInterface::getSynonyms	public	function	Fetch synonyms from an entity.	3
GetInterface::getSynonymsMultiple	public	function	Fetch synonyms from multiple entities at once.