You are here

Home » API reference » URL Embed 8 » UrlEmbedDialog.php

class UrlEmbedDialog in URL Embed 8

Provides a form to embed URLs.

Hierarchy

Expanded class hierarchy of UrlEmbedDialog

1 string reference to 'UrlEmbedDialog'
url_embed.routing.yml in ./url_embed.routing.yml
url_embed.routing.yml

File

src/Form/UrlEmbedDialog.php, line 26
Contains \Drupal\url_embed\Form\UrlEmbedDialog.

Namespace

Drupal\url_embed\Form
View source 
class UrlEmbedDialog extends FormBase {
  use UrlEmbedHelperTrait;

  /**
   * The form builder.
   *
   * @var \Drupal\Core\Form\FormBuilderInterface
   */
  protected $formBuilder;

  /**
   * Constructs a UrlEmbedDialog object.
   *
   * @param \Drupal\url_embed\UrlEmbedInterface $url_embed
   *   The URL embed service.
   * @param \Drupal\Core\Form\FormBuilderInterface $form_builder
   *   The Form Builder.
   */
  public function __construct(UrlEmbedInterface $url_embed, FormBuilderInterface $form_builder) {
    $this
      ->setUrlEmbed($url_embed);
    $this->formBuilder = $form_builder;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('url_embed'), $container
      ->get('form_builder'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'url_embed_dialog';
  }

  /**
   * {@inheritdoc}
   *
   * @param \Drupal\editor\EditorInterface $editor
   *   The editor to which this dialog corresponds.
   * @param \Drupal\embed\EmbedButtonInterface $embed_button
   *   The URL button to which this dialog corresponds.
   */
  public function buildForm(array $form, FormStateInterface $form_state, EditorInterface $editor = NULL, EmbedButtonInterface $embed_button = NULL) {
    $values = $form_state
      ->getValues();
    $input = $form_state
      ->getUserInput();

    // Set URL button element in form state, so that it can be used later in
    // validateForm() function.
    $form_state
      ->set('embed_button', $embed_button);
    $form_state
      ->set('editor', $editor);

    // Initialize URL element with form attributes, if present.
    $url_element = empty($values['attributes']) ? array() : $values['attributes'];
    $url_element += empty($input['attributes']) ? array() : $input['attributes'];

    // The default values are set directly from \Drupal::request()->request,
    // provided by the editor plugin opening the dialog.
    if (!$form_state
      ->get('url_element')) {
      $form_state
        ->set('url_element', isset($input['editor_object']) ? $input['editor_object'] : array());
    }
    $url_element += $form_state
      ->get('url_element');
    $url_element += array(
      'data-embed-url' => '',
      'data-url-provider' => '',
    );
    $form_state
      ->set('url_element', $url_element);
    $form['#tree'] = TRUE;
    $form['#attached']['library'][] = 'editor/drupal.editor.dialog';
    $form['#prefix'] = '<div id="url-embed-dialog-form">';
    $form['#suffix'] = '</div>';
    $form['attributes']['data-embed-url'] = array(
      '#type' => 'textfield',
      '#title' => 'URL',
      '#default_value' => $url_element['data-embed-url'],
      '#required' => TRUE,
    );
    try {
      if (!empty($url_element['data-embed-url']) && ($info = $this
        ->urlEmbed()
        ->getEmbed($url_element['data-embed-url']))) {
        $url_element['data-url-provider'] = $info
          ->getProviderName();
      }
    } catch (\Exception $e) {
      watchdog_exception('url_embed', $e);
    }
    $form['attributes']['data-url-provider'] = array(
      '#type' => 'value',
      '#value' => $url_element['data-url-provider'],
    );
    $form['attributes']['data-embed-button'] = array(
      '#type' => 'value',
      '#value' => $embed_button
        ->id(),
    );
    $form['attributes']['data-entity-label'] = array(
      '#type' => 'value',
      '#value' => $embed_button
        ->label(),
    );
    $form['actions'] = array(
      '#type' => 'actions',
    );
    $form['actions']['save_modal'] = array(
      '#type' => 'submit',
      '#value' => $this
        ->t('Embed'),
      '#button_type' => 'primary',
      // No regular submit-handler. This form only works via JavaScript.
      '#submit' => array(),
      '#ajax' => array(
        'callback' => '::submitForm',
        'event' => 'click',
      ),
    );
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $response = new AjaxResponse();
    $values = $form_state
      ->getValues();

    // Display errors in form, if any.
    if ($form_state
      ->hasAnyErrors()) {
      unset($form['#prefix'], $form['#suffix']);
      $form['status_messages'] = array(
        '#type' => 'status_messages',
        '#weight' => -10,
      );
      $response
        ->addCommand(new HtmlCommand('#url-embed-dialog-form', $form));
    }
    else {
      $response
        ->addCommand(new EditorDialogSave($values));
      $response
        ->addCommand(new CloseModalDialogCommand());
    }
    return $response;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
UrlEmbedDialog::$formBuilder protected property The form builder.
UrlEmbedDialog::buildForm public function Overrides FormInterface::buildForm
UrlEmbedDialog::create public static function Instantiates a new instance of this class. Overrides FormBase::create
UrlEmbedDialog::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
UrlEmbedDialog::submitForm public function Form submission handler. Overrides FormInterface::submitForm
UrlEmbedDialog::__construct public function Constructs a UrlEmbedDialog object.
UrlEmbedHelperTrait::$moduleHandler protected property The module handler service.
UrlEmbedHelperTrait::$url_embed protected property The URL embed service.
UrlEmbedHelperTrait::moduleHandler protected function Returns the module handler.
UrlEmbedHelperTrait::setModuleHandler public function Sets the module handler service.
UrlEmbedHelperTrait::setUrlEmbed public function Sets the URL embed service.
UrlEmbedHelperTrait::urlEmbed protected function Returns the URL embed service.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.