interface UrlEmbedInterface in URL Embed 8

A service class for handling URL embeds.

@todo Add more documentation.

Hierarchy

• interface \Drupal\url_embed\UrlEmbedInterface

2 files declare their use of UrlEmbedInterface

UrlEmbedDialog.php in src/Form/UrlEmbedDialog.php

Contains \Drupal\url_embed\Form\UrlEmbedDialog.

UrlEmbedFilter.php in src/Plugin/Filter/UrlEmbedFilter.php

Contains \Drupal\url_embed\Plugin\Filter\UrlEmbedFilter.

File

src/UrlEmbedInterface.php, line 15

Contains Drupal\url_embed\UrlEmbedInterface.

Namespace

Drupal\url_embed

interface UrlEmbedInterface {
  public function __construct(array $config = []);
  public function getConfig();
  public function setConfig(array $config);

  /**
   * @param string|\Embed\Request $request
   *   The url or a request with the url
   * @param array $config
   *   (optional) Options passed to the adapter. If not provided the default
   *   options on the service will be used.
   *
   * @throws \Embed\Exceptions\InvalidUrlException
   *   If the urls is not valid
   * @throws \InvalidArgumentException
   *   If any config argument is not valid
   *
   * @return \Embed\Adapters\AdapterInterface
   */
  public function getEmbed($request, array $config = []);

}

Members

Name	Modifiers	Type	Description	Overrides
UrlEmbedInterface::getConfig	public	function		1
UrlEmbedInterface::getEmbed	public	function		1
UrlEmbedInterface::setConfig	public	function		1
UrlEmbedInterface::__construct	public	function		1