summaryrefslogtreecommitdiffstatshomepage
path: root/core/modules/media/src/OEmbed/ResourceFetcherInterface.php
blob: b74fb6e2d9c47fc75dde7bc91c7befda16a20611 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
<?php

namespace Drupal\media\OEmbed;

/**
 * Defines an interface for an oEmbed resource fetcher service.
 *
 * The resource fetcher's only responsibility is to retrieve oEmbed resource
 * data from an endpoint URL (i.e., as returned by
 * \Drupal\media\OEmbed\UrlResolverInterface::getResourceUrl()) and return a
 * \Drupal\media\OEmbed\Resource value object.
 */
interface ResourceFetcherInterface {

  /**
   * Fetches an oEmbed resource.
   *
   * @param string $url
   *   Endpoint-specific URL of the oEmbed resource.
   *
   * @return \Drupal\media\OEmbed\Resource
   *   A resource object built from the oEmbed resource data.
   *
   * @see https://oembed.com/#section2
   *
   * @throws \Drupal\media\OEmbed\ResourceException
   *   If the oEmbed endpoint is not reachable or the response returns an
   *   unexpected Content-Type header.
   */
  public function fetchResource($url);

}