OEmbedWidget.php
Same filename and directory in other branches
Namespace
Drupal\media\Plugin\Field\FieldWidgetFile
-
core/
modules/ media/ src/ Plugin/ Field/ FieldWidget/ OEmbedWidget.php
View source
<?php
namespace Drupal\media\Plugin\Field\FieldWidget;
use Drupal\Core\Field\Attribute\FieldWidget;
use Drupal\Core\Field\FieldDefinitionInterface;
use Drupal\Core\Field\FieldItemListInterface;
use Drupal\Core\Field\Plugin\Field\FieldWidget\StringTextfieldWidget;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Render\Element\ElementInterface;
use Drupal\Core\Render\Element\Widget;
use Drupal\Core\StringTranslation\TranslatableMarkup;
use Drupal\media\Entity\MediaType;
use Drupal\media\Plugin\media\Source\OEmbedInterface;
/**
* Plugin implementation of the 'oembed_textfield' widget.
*
* @internal
* This is an internal part of the oEmbed system and should only be used by
* oEmbed-related code in Drupal core.
*/
class OEmbedWidget extends StringTextfieldWidget {
/**
* {@inheritdoc}
*/
public function singleElementObject(FieldItemListInterface $items, $delta, Widget $widget, ElementInterface $form, FormStateInterface $form_state) : ElementInterface {
$widget = parent::singleElementObject($items, $delta, $widget, $form, $form_state);
$value = $widget->getChild('value');
$value->description = $this->getValueDescription($items, $value->description);
return $widget;
}
/**
* Merges description and provider messages.
*
* @param \Drupal\Core\Field\FieldItemListInterface $items
* FieldItemList containing the values to be edited.
* @param scalar|\Stringable|\Drupal\Core\Render\RenderableInterface|array $description
* The description on the form element.
*
* @return string|array
* The description on the value child.
*/
protected function getValueDescription(FieldItemListInterface $items, mixed $description) : string|array {
/** @var \Drupal\media\Plugin\media\Source\OEmbedInterface $source */
$source = $items->getEntity()
->getSource();
$message = $this->t('You can link to media from the following services: @providers', [
'@providers' => implode(', ', $source->getProviders()),
]);
if ($description) {
return [
'#theme' => 'item_list',
'#items' => [
$description,
$message,
],
];
}
return $message;
}
/**
* {@inheritdoc}
*/
public static function isApplicable(FieldDefinitionInterface $field_definition) {
$target_bundle = $field_definition->getTargetBundle();
if (!parent::isApplicable($field_definition) || $field_definition->getTargetEntityTypeId() !== 'media' || !$target_bundle) {
return FALSE;
}
return MediaType::load($target_bundle)->getSource() instanceof OEmbedInterface;
}
}
Classes
Title | Deprecated | Summary |
---|---|---|
OEmbedWidget | Plugin implementation of the 'oembed_textfield' widget. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.