class ProviderRepository in Drupal 8

Overrides the oEmbed provider repository service for testing purposes.

This service does not use caching at all, and will always try to retrieve provider data from state before calling the parent methods.

Hierarchy

• class \Drupal\media\OEmbed\ProviderRepository implements ProviderRepositoryInterface uses UseCacheBackendTrait
  • class \Drupal\media_test_oembed\ProviderRepository

File

core/modules/media/tests/modules/media_test_oembed/src/ProviderRepository.php, line 14

Namespace

Drupal\media_test_oembed

class ProviderRepository extends BaseProviderRepository {

  /**
   * {@inheritdoc}
   */
  protected function cacheGet($cid) {
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function getAll() {
    return \Drupal::state()
      ->get(static::class) ?: parent::getAll();
  }

  /**
   * {@inheritdoc}
   */
  public function get($provider_name) {
    $providers = \Drupal::state()
      ->get(static::class, []);
    if (isset($providers[$provider_name])) {
      return $providers[$provider_name];
    }
    return parent::get($provider_name);
  }

  /**
   * Stores an oEmbed provider value object in state.
   *
   * @param \Drupal\media\OEmbed\Provider $provider
   *   The provider to store.
   */
  public function setProvider(Provider $provider) {
    $providers = \Drupal::state()
      ->get(static::class, []);
    $name = $provider
      ->getName();
    $providers[$name] = $provider;
    \Drupal::state()
      ->set(static::class, $providers);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ProviderRepository::$httpClient	protected	property	The HTTP client.
ProviderRepository::$maxAge	protected	property	How long the provider data should be cached, in seconds.
ProviderRepository::$providersUrl	protected	property	URL of a JSON document which contains a database of oEmbed providers.
ProviderRepository::$time	protected	property	The time service.
ProviderRepository::cacheGet	protected	function	Fetches from the cache backend, respecting the use caches flag. Overrides UseCacheBackendTrait::cacheGet
ProviderRepository::get	public	function	Returns information for a specific oEmbed provider. Overrides ProviderRepository::get
ProviderRepository::getAll	public	function	Returns information on all available oEmbed providers. Overrides ProviderRepository::getAll
ProviderRepository::setProvider	public	function	Stores an oEmbed provider value object in state.
ProviderRepository::__construct	public	function	Constructs a ProviderRepository instance.
UseCacheBackendTrait::$cacheBackend	protected	property	Cache backend instance.
UseCacheBackendTrait::$useCaches	protected	property	Flag whether caches should be used or skipped.
UseCacheBackendTrait::cacheSet	protected	function	Stores data in the persistent cache, respecting the use caches flag.