class OpenerResolver

Same name and namespace in other branches
  1. 9 core/modules/media_library/src/OpenerResolver.php \Drupal\media_library\OpenerResolver
  2. 8.9.x core/modules/media_library/src/OpenerResolver.php \Drupal\media_library\OpenerResolver
  3. 11.x core/modules/media_library/src/OpenerResolver.php \Drupal\media_library\OpenerResolver

Defines a class to resolve media library openers.

This is intended to be a very thin interface-verifying wrapper around services which implement \Drupal\media_library\MediaLibraryOpenerInterface. It is not an API and should not be extended or used by code that does not interact with the Media Library module.

@internal This service is an internal part of the modal media library dialog and does not provide any extension points or public API.

Hierarchy

Expanded class hierarchy of OpenerResolver

1 string reference to 'OpenerResolver'
media_library.services.yml in core/modules/media_library/media_library.services.yml
core/modules/media_library/media_library.services.yml
1 service uses OpenerResolver
media_library.opener_resolver in core/modules/media_library/media_library.services.yml
Drupal\media_library\OpenerResolver

File

core/modules/media_library/src/OpenerResolver.php, line 17

Namespace

Drupal\media_library
View source
class OpenerResolver implements OpenerResolverInterface {
  
  /**
   * @var \Drupal\media_library\MediaLibraryOpenerInterface[]
   */
  protected array $openers = [];
  
  /**
   * Registers an opener.
   *
   * @param \Drupal\media_library\MediaLibraryOpenerInterface $opener
   *   The opener.
   * @param string $id
   *   The service ID.
   */
  public function addOpener(MediaLibraryOpenerInterface $opener, string $id) : void {
    $this->openers[$id] = $opener;
  }
  
  /**
   * {@inheritdoc}
   */
  public function get(MediaLibraryState $state) {
    $service_id = $state->getOpenerId();
    $service = $this->openers[$service_id] ?? NULL;
    if ($service instanceof MediaLibraryOpenerInterface) {
      return $service;
    }
    throw new \RuntimeException("{$service_id} must be an instance of " . MediaLibraryOpenerInterface::class);
  }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
OpenerResolver::$openers protected property
OpenerResolver::addOpener public function Registers an opener.
OpenerResolver::get public function Gets a media library opener service from the container. Overrides OpenerResolverInterface::get

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.