ProviderRepositoryInterface.php in Drupal 8

Namespace

Drupal\media\OEmbed

File

core/modules/media/src/OEmbed/ProviderRepositoryInterface.php

<?php

namespace Drupal\media\OEmbed;


/**
 * Defines an interface for a collection of oEmbed provider information.
 *
 * The provider repository is responsible for fetching information about all
 * available oEmbed providers, most likely pulled from the online database at
 * https://oembed.com/providers.json, and creating \Drupal\media\OEmbed\Provider
 * value objects for each provider.
 */
interface ProviderRepositoryInterface {

  /**
   * Returns information on all available oEmbed providers.
   *
   * @return \Drupal\media\OEmbed\Provider[]
   *   Returns an array of provider value objects, keyed by provider name.
   *
   * @throws \Drupal\media\OEmbed\ProviderException
   *   If the oEmbed provider information cannot be retrieved.
   */
  public function getAll();

  /**
   * Returns information for a specific oEmbed provider.
   *
   * @param string $provider_name
   *   The name of the provider.
   *
   * @return \Drupal\media\OEmbed\Provider
   *   A value object containing information about the provider.
   *
   * @throws \InvalidArgumentException
   *   If there is no known oEmbed provider with the specified name.
   */
  public function get($provider_name);

}

Interfaces

Name	Description
ProviderRepositoryInterface	Defines an interface for a collection of oEmbed provider information.