class oEmbed in oEmbed 8
Class oEmbed @package Drupal\oembed\Render\Element
Plugin annotation
@RenderElement("oembed");
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
- class \Drupal\oembed\Element\oEmbed implements ContainerFactoryPluginInterface
- class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of oEmbed
12 string references to 'oEmbed'
- oembed.info.yml in ./
oembed.info.yml - oembed.info.yml
- oembed.links.menu.yml in ./
oembed.links.menu.yml - oembed.links.menu.yml
- oembed.routing.yml in ./
oembed.routing.yml - oembed.routing.yml
- oembedembedly.info.yml in modules/
oembedembedly/ oembedembedly.info.yml - modules/oembedembedly/oembedembedly.info.yml
- OembedEndpointTestCase::getInfo in modules/
oembedprovider/ oembedprovider.test
File
- src/
Element/ oEmbed.php, line 16
Namespace
Drupal\oembed\ElementView source
class oEmbed extends RenderElement implements ContainerFactoryPluginInterface {
protected $consumer;
public function __construct(array $configuration, $plugin_id, $plugin_definition, Consumer $consumer) {
$this->consumer = $consumer;
parent::__construct($configuration, $plugin_id, $plugin_definition);
}
/**
* Returns the element properties for this element.
*
* @return array
* An array of element properties. See
* \Drupal\Core\Render\ElementInfoManagerInterface::getInfo() for
* documentation of the standard properties of all elements, and the
* return value format.
*/
public function getInfo() {
$class = get_class($this);
return array(
'#theme' => 'oembed',
'#embed' => NULL,
'#parameters' => array(),
'#attributes' => array(),
'#pre_render' => array(
array(
$class,
'preRenderFetch',
),
array(
$class,
'preRenderRetheme',
),
),
);
}
public static function preRenderFetch($element) {
$embed = oembed_get_data($element['#url'], $element['#parameters']);
// Prevent rendering if the response is bad.
if (!$embed) {
$element['#printed'] = TRUE;
return $element;
}
$element['#embed'] = $embed;
return $element;
}
public static function preRenderRetheme($element) {
// Only act when the oEmbed response is true.
if (!empty($element['#printed'])) {
return $element;
}
/** @var \Bangpound\oEmbed\Response\Response $embed */
$embed = $element['#embed'];
$element['#theme'] = 'oembed__' . $embed
->getType() . '__' . implode('__', explode(':', $embed
->getProviderName(), 2));
return $element;
}
/**
* Creates an instance of the plugin.
*
* @param \Symfony\Component\DependencyInjection\ContainerInterface $container
* The container to pull out services used in the plugin.
* @param array $configuration
* A configuration array containing information about the plugin instance.
* @param string $plugin_id
* The plugin ID for the plugin instance.
* @param mixed $plugin_definition
* The plugin implementation definition.
*
* @return static
* Returns an instance of this plugin.
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
/** @var \Bangpound\oEmbed\Consumer $consumer */
$consumer = $container
->get('oembed.consumer');
return new static($configuration, $plugin_id, $plugin_definition, $consumer);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
oEmbed:: |
protected | property | ||
oEmbed:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
|
oEmbed:: |
public | function |
Returns the element properties for this element. Overrides ElementInterface:: |
1 |
oEmbed:: |
public static | function | ||
oEmbed:: |
public static | function | ||
oEmbed:: |
public | function |
Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase:: |
|
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
RenderElement:: |
public static | function | Adds Ajax information about an element to communicate with JavaScript. | |
RenderElement:: |
public static | function | Adds members of this group as actual elements for rendering. | |
RenderElement:: |
public static | function | Form element processing handler for the #ajax form property. | 1 |
RenderElement:: |
public static | function | Arranges elements into groups. | |
RenderElement:: |
public static | function |
Sets a form element's class attribute. Overrides ElementInterface:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |