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

ProviderRepository

class ProviderRepository implements ProviderRepositoryInterface (View source)

Retrieves and caches information about oEmbed providers.

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 int $maxAge

How long the provider data should be cached, in seconds.
protected Client $httpClient

The HTTP client.
protected string $providersUrl

URL of a JSON document which contains a database of oEmbed providers.
protected TimeInterface $time

The time 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, ConfigFactoryInterface $config_factory, TimeInterface $time, CacheBackendInterface $cache_backend = NULL, int $max_age = 604800)

Constructs a ProviderRepository instance.

Provider[]
getAll()

Returns information on all available oEmbed providers.

Provider
get(string $provider_name)

Returns information for a specific oEmbed provider.

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 62
__construct(ClientInterface $http_client, ConfigFactoryInterface $config_factory, TimeInterface $time, CacheBackendInterface $cache_backend = NULL, int $max_age = 604800)

Constructs a ProviderRepository instance.

Parameters

ClientInterface $http_client

The HTTP client.
ConfigFactoryInterface $config_factory

The config factory service.
TimeInterface $time

The time service.
CacheBackendInterface $cache_backend

(optional) The cache backend.
int $max_age

(optional) How long the cache data should be kept. Defaults to a week.

at line 73
Provider[] getAll()

Returns information on all available oEmbed providers.

Return Value

Provider[]

Returns an array of provider value objects, keyed by provider name.

Exceptions

ProviderException

at line 113
Provider get(string $provider_name)

Returns information for a specific oEmbed provider.

Parameters

string $provider_name

The name of the provider.

Return Value

Provider

A value object containing information about the provider.

Exceptions

InvalidArgumentException