1. class
  2. Drupal
  3. \
  4. media
  5. \
  6. OEmbed
  7. \
  8. ResourceFetcher

ResourceFetcher

class ResourceFetcher implements ResourceFetcherInterface (View source)

Fetches and caches oEmbed resources.

Traits

UseCacheBackendTrait

Provides methods to use a cache backend while respecting a 'use caches' flag.

Properties

protected CacheBackendInterface $cacheBackend

Cache backend instance.

 from  UseCacheBackendTrait
protected bool $useCaches

Flag whether caches should be used or skipped.

 from  UseCacheBackendTrait
protected Client $httpClient

The HTTP client.
protected ProviderRepositoryInterface $providers

The oEmbed provider repository service.

Methods

object|false
cacheGet(string $cid)

Fetches from the cache backend, respecting the use caches flag.

from  UseCacheBackendTrait
cacheSet(string $cid, mixed $data, int $expire = Cache::PERMANENT, array $tags = [])

Stores data in the persistent cache, respecting the use caches flag.

from  UseCacheBackendTrait
__construct(ClientInterface $http_client, ProviderRepositoryInterface $providers, CacheBackendInterface $cache_backend = NULL)

Constructs a ResourceFetcher object.

Resource
fetchResource(string $url)

Fetches an oEmbed resource.

Resource
createResource(array $data, string $url)

Creates a Resource object from raw resource data.

array
parseResourceXml(string $data, string $url)

Parses XML resource data.

Details

in UseCacheBackendTrait at line 35
protected object|false cacheGet(string $cid)

Fetches from the cache backend, respecting the use caches flag.

Parameters

string $cid

The cache ID of the data to retrieve.

Return Value

object|false

The cache item or FALSE on failure.

See also

CacheBackendInterface::get

in UseCacheBackendTrait at line 69
protected cacheSet(string $cid, mixed $data, int $expire = Cache::PERMANENT, array $tags = [])

Stores data in the persistent cache, respecting the use caches flag.

Parameters

string $cid

The cache ID of the data to store.
mixed $data

The data to store in the cache. Some storage engines only allow objects up to a maximum of 1MB in size to be stored by default. When caching large arrays or similar, take care to ensure $data does not exceed this size.
int $expire

One of the following values:

  • CacheBackendInterface::CACHE_PERMANENT: Indicates that the item should not be removed unless it is deleted explicitly.
  • A Unix timestamp: Indicates that the item will be considered invalid after this time, i.e. it will not be returned by get() unless $allow_invalid has been set to TRUE. When the item has expired, it may be permanently deleted by the garbage collector at any time.
array $tags

An array of tags to be stored with the cache item. These should normally identify objects used to build the cache item, which should trigger cache invalidation when updated. For example if a cached item represents a node, both the node ID and the author's user ID might be passed in as tags. For example array('node' => array(123), 'user' => array(92)).

See also

CacheBackendInterface::set

at line 42
__construct(ClientInterface $http_client, ProviderRepositoryInterface $providers, CacheBackendInterface $cache_backend = NULL)

Constructs a ResourceFetcher object.

Parameters

ClientInterface $http_client

The HTTP client.
ProviderRepositoryInterface $providers

The oEmbed provider repository service.
CacheBackendInterface $cache_backend

(optional) The cache backend.

at line 52
Resource fetchResource(string $url)

Fetches an oEmbed resource.

Parameters

string $url

Endpoint-specific URL of the oEmbed resource.

Return Value

Resource

A resource object built from the oEmbed resource data.

Exceptions

ResourceException

at line 100
protected Resource createResource(array $data, string $url)

Creates a Resource object from raw resource data.

Parameters

array $data

The resource data returned by the provider.
string $url

The URL of the resource.

Return Value

Resource

A value object representing the resource.

Exceptions

ResourceException

at line 210
protected array parseResourceXml(string $data, string $url)

Parses XML resource data.

Parameters

string $data

The raw XML for the resource.
string $url

The resource URL.

Return Value

array

The parsed resource data.

Exceptions

ResourceException