public function OEmbed::buildConfigurationForm in Drupal 9

Same name and namespace in other branches

8 core/modules/media/src/Plugin/media/Source/OEmbed.php \Drupal\media\Plugin\media\Source\OEmbed::buildConfigurationForm()

Form constructor.

Plugin forms are embedded in other forms. In order to know where the plugin form is located in the parent form, #parents and #array_parents must be known, but these are not available during the initial build phase. In order to have these properties available when building the plugin form's elements, let this method return a form element that has a #process callback and build the rest of the form in the callback. By the time the callback is executed, the element's #parents and #array_parents properties will have been set by the form API. For more documentation on #parents and #array_parents, see \Drupal\Core\Render\Element\FormElement.

Parameters

array $form: An associative array containing the initial structure of the plugin form.

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form. Calling code should pass on a subform state created through \Drupal\Core\Form\SubformState::createForSubform().

Return value

array The form structure.

Overrides MediaSourceBase::buildConfigurationForm

File

core/modules/media/src/Plugin/media/Source/OEmbed.php, line 299

Class

OEmbed: Provides a media source plugin for oEmbed resources.

Namespace

Drupal\media\Plugin\media\Source

Code

public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
  $form = parent::buildConfigurationForm($form, $form_state);
  $domain = $this->configFactory
    ->get('media.settings')
    ->get('iframe_domain');
  if (!$this->iFrameUrlHelper
    ->isSecure($domain)) {
    array_unshift($form, [
      '#markup' => '<p>' . $this
        ->t('It is potentially insecure to display oEmbed content in a frame that is served from the same domain as your main Drupal site, as this may allow execution of third-party code. <a href=":url">You can specify a different domain for serving oEmbed content in the Media settings</a>.', [
        ':url' => Url::fromRoute('media.settings')
          ->setAbsolute()
          ->toString(),
      ]) . '</p>',
    ]);
  }
  $form['thumbnails_directory'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Thumbnails location'),
    '#default_value' => $this->configuration['thumbnails_directory'],
    '#description' => $this
      ->t('Thumbnails will be fetched from the provider for local usage. This is the URI of the directory where they will be placed.'),
    '#required' => TRUE,
  ];
  $configuration = $this
    ->getConfiguration();
  $plugin_definition = $this
    ->getPluginDefinition();
  $form['providers'] = [
    '#type' => 'checkboxes',
    '#title' => $this
      ->t('Allowed providers'),
    '#default_value' => $configuration['providers'],
    '#options' => array_combine($plugin_definition['providers'], $plugin_definition['providers']),
    '#description' => $this
      ->t('Optionally select the allowed oEmbed providers for this media type. If left blank, all providers will be allowed.'),
  ];
  return $form;
}

You are here