You are here

Home » API reference » Entity Browser 8.2 » EntityBrowserController.php

class EntityBrowserController in Entity Browser 8.2

Same name and namespace in other branches
  1. 8 src/Controllers/EntityBrowserController.php \Drupal\entity_browser\Controllers\EntityBrowserController

Returns responses for entity browser routes.

Hierarchy

Expanded class hierarchy of EntityBrowserController

File

src/Controllers/EntityBrowserController.php, line 19

Namespace

Drupal\entity_browser\Controllers
View source 
class EntityBrowserController extends ControllerBase {

  /**
   * Return an Ajax dialog command for editing a referenced entity.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   An entity being edited.
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The currently processing request.
   *
   * @return \Drupal\Core\Ajax\AjaxResponse
   *   An Ajax response with a command for opening or closing the dialog
   *   containing the edit form.
   */
  public function entityBrowserEdit(EntityInterface $entity, Request $request) {
    $trigger_name = $request->request
      ->get('_triggering_element_name');
    $edit_button = strpos($trigger_name, 'edit_button') !== FALSE;
    if ($edit_button) {

      // Remove posted values from original form to prevent
      // data leakage into this form when the form is of the same bundle.
      $original_request = $request->request;
      $request->request = new ParameterBag();
    }

    // Use edit form class if it exists, otherwise use default form class.
    $entity_type = $entity
      ->getEntityType();
    if ($entity_type
      ->getFormClass('edit')) {
      $operation = 'edit';
    }
    elseif ($entity_type
      ->getFormClass('default')) {
      $operation = 'default';
    }
    if (!empty($operation)) {

      // Build the entity edit form.
      $form_object = $this
        ->entityTypeManager()
        ->getFormObject($entity
        ->getEntityTypeId(), $operation);
      $form_object
        ->setEntity($entity);
      $form_state = (new FormState())
        ->setFormObject($form_object)
        ->disableRedirect();

      // Building the form also submits.
      $form = $this
        ->formBuilder()
        ->buildForm($form_object, $form_state);
    }

    // Restore original request now that the edit form is built.
    // This fixes a bug where closing modal and re-opening it would
    // cause two modals to open.
    if ($edit_button) {
      $request->request = $original_request;
    }

    // Return a response, depending on whether it's successfully submitted.
    if ($operation && $form_state && !$form_state
      ->isExecuted()) {

      // Return the form as a modal dialog.
      $form['#attached']['library'][] = 'core/drupal.dialog.ajax';
      $title = $this
        ->t('Edit entity @entity', [
        '@entity' => $entity
          ->label(),
      ]);
      $response = AjaxResponse::create()
        ->addCommand(new OpenDialogCommand('#' . $entity
        ->getEntityTypeId() . '-' . $entity
        ->id() . '-edit-dialog', $title, $form, [
        'modal' => TRUE,
        'width' => 800,
      ]));
      return $response;
    }
    else {

      // Return command for closing the modal.
      $response = AjaxResponse::create()
        ->addCommand(new CloseDialogCommand('#' . $entity
        ->getEntityTypeId() . '-' . $entity
        ->id() . '-edit-dialog'));

      // Also refresh the widget if "details_id" is provided.
      $details_id = $request->query
        ->get('details_id');
      if (!empty($details_id)) {
        $response
          ->addCommand(new ValueUpdatedCommand($details_id));
        if (empty($operation)) {
          $response
            ->addCommand(new AlertCommand($this
            ->t("An edit form couldn't be found.")));
        }
      }
      return $response;
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityManager protected property The entity manager.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 40
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityManager Deprecated protected function Retrieves the entity manager service.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state protected function Returns the state storage service.
EntityBrowserController::entityBrowserEdit public function Return an Ajax dialog command for editing a referenced entity.
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.
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.