class ChainDefinitionDiscovery in Libraries API 8.3

Provides a definition discovery that checks a list of other discoveries.

The discoveries are checked sequentially. If the definition was not present in some discoveries but is found in a later discovery the definition will be written to the earlier discoveries if they implement WritableDefinitionDiscoveryInterface.

Hierarchy

• class \Drupal\libraries\ExternalLibrary\Definition\ChainDefinitionDiscovery implements DefinitionDiscoveryInterface

See also

\Drupal\libraries\ExternalLibrary\Definition\WritableDefinitionDiscoveryInterface

File

src/ExternalLibrary/Definition/ChainDefinitionDiscovery.php, line 17

Namespace

Drupal\libraries\ExternalLibrary\Definition

class ChainDefinitionDiscovery implements DefinitionDiscoveryInterface {

  /**
   * The list of definition discoveries that will be checked.
   *
   * @var \Drupal\libraries\ExternalLibrary\Definition\DefinitionDiscoveryInterface[]
   */
  protected $discoveries = [];

  /**
   * {@inheritdoc}
   */
  public function hasDefinition($id) {
    foreach ($this->discoveries as $discovery) {
      if ($discovery
        ->hasDefinition($id)) {
        return TRUE;
      }
    }
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function getDefinition($id) {

    /** @var \Drupal\libraries\ExternalLibrary\Definition\WritableDefinitionDiscoveryInterface[] $discoveries_to_write */
    $discoveries_to_write = [];
    foreach ($this->discoveries as $discovery) {
      if ($discovery
        ->hasDefinition($id)) {
        $definition = $discovery
          ->getDefinition($id);
        break;
      }
      elseif ($discovery instanceof WritableDefinitionDiscoveryInterface) {
        $discoveries_to_write[] = $discovery;
      }
    }
    if (!isset($definition)) {
      throw new LibraryDefinitionNotFoundException($id);
    }
    foreach ($discoveries_to_write as $discovery_to_write) {
      $discovery_to_write
        ->writeDefinition($id, $definition);
    }
    return $definition;
  }

  /**
   * Adds a definition discovery to the list to check.
   *
   * @param \Drupal\libraries\ExternalLibrary\Definition\DefinitionDiscoveryInterface $discovery
   *   The definition discovery to add.
   *
   * @return $this
   */
  public function addDiscovery(DefinitionDiscoveryInterface $discovery) {
    $this->discoveries[] = $discovery;
    return $this;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ChainDefinitionDiscovery::$discoveries	protected	property	The list of definition discoveries that will be checked.
ChainDefinitionDiscovery::addDiscovery	public	function	Adds a definition discovery to the list to check.
ChainDefinitionDiscovery::getDefinition	public	function	Gets a library definition by its ID. Overrides DefinitionDiscoveryInterface::getDefinition
ChainDefinitionDiscovery::hasDefinition	public	function	Checks whether a library definition exists. Overrides DefinitionDiscoveryInterface::hasDefinition