You are here

Home » API reference » Media Directories 2.x » MediaDeleteForm.php

class MediaDeleteForm in Media Directories 2.x

Same name and namespace in other branches
  1. 8 modules/media_directories_ui/src/Form/MediaDeleteForm.php \Drupal\media_directories_ui\Form\MediaDeleteForm
  2. 3.x modules/media_directories_ui/src/Form/MediaDeleteForm.php \Drupal\media_directories_ui\Form\MediaDeleteForm

A form to delete medias.

Hierarchy

Expanded class hierarchy of MediaDeleteForm

1 file declares its use of MediaDeleteForm
MediaDirectoriesController.php in modules/media_directories_ui/src/Controller/MediaDirectoriesController.php

File

modules/media_directories_ui/src/Form/MediaDeleteForm.php, line 14

Namespace

Drupal\media_directories_ui\Form
View source 
class MediaDeleteForm extends ConfirmFormBase {

  /**
   * The medias to delete.
   *
   * @var \Drupal\media\Entity\Media[]
   */
  protected $entities;

  /**
   * The form context.
   *
   * @var array
   */
  protected $formContext;

  /**
   * {@inheritDoc}
   */
  public function getQuestion() {
    if (count($this->entities) > 1) {
      return $this
        ->t('Do you want to delete @count items?', [
        '@count' => count($this->entities),
      ]);
    }
    $first_entity = reset($this->entities);
    return $this
      ->t('Do you want to delete @name?', [
      '@name' => $first_entity
        ->getName(),
    ]);
  }

  /**
   * {@inheritDoc}
   */
  public function getCancelUrl() {

    // TODO: Implement getCancelUrl() method.
  }

  /**
   * {@inheritDoc}
   */
  public function getFormId() {
    return 'media_delete_form';
  }

  /**
   * {@inheritDoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $build_info = $form_state
      ->getBuildInfo();
    if (isset($build_info['args'][0])) {
      $this->formContext = $build_info['args'][0];
      $this->entities = $this->formContext['media_items'];
      $form['media_items'] = [
        '#tree' => TRUE,
      ];
      foreach ($this->entities as $entity) {
        $form['media_items'][] = [
          '#type' => 'hidden',
          '#value' => $entity
            ->id(),
        ];
      }
    }
    $form['question']['#markup'] = '<h4>' . $this
      ->getQuestion() . '</h4>';
    $form = parent::buildForm($form, $form_state);
    $form['#attached']['library'][] = 'core/drupal.dialog.ajax';
    $form['actions']['submit']['#ajax'] = [
      'callback' => [
        $this,
        'submitModalAjax',
      ],
      'event' => 'click',
    ];
    $form['actions']['cancel'] = [
      '#type' => 'button',
      '#value' => $this
        ->t('Cancel'),
      '#button_type' => 'secondary',
      '#ajax' => [
        'callback' => [
          $this,
          'closeModalAjax',
        ],
        'event' => 'click',
      ],
    ];
    return $form;
  }

  /**
   * AJAX callback when the form is submitted.
   */
  public function submitModalAjax(array &$form, FormStateInterface $form_state) {
    $response = new AjaxResponse();
    foreach ($this->entities as $entity) {
      $entity
        ->delete();
    }
    $response
      ->addCommand(new CloseModalDialogCommand());
    $response
      ->addCommand(new LoadDirectoryContent());
    return $response;
  }

  /**
   * Close modal dialog.
   *
   * @return \Drupal\Core\Ajax\AjaxResponse
   *   An AJAX response.
   */
  public function closeModalAjax() {
    $response = new AjaxResponse();
    $response
      ->addCommand(new CloseModalDialogCommand());
    return $response;
  }

  /**
   * Form submission handler.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

    // TODO: Implement submitForm() method.
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfirmFormBase::getCancelText public function Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface::getCancelText 2
ConfirmFormBase::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormInterface::getConfirmText 22
ConfirmFormBase::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormInterface::getDescription 14
ConfirmFormBase::getFormName public function Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface::getFormName
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 3
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. 3
FormBase::container private function Returns the service container.
FormBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 105
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.
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 72
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.
MediaDeleteForm::$entities protected property The medias to delete.
MediaDeleteForm::$formContext protected property The form context.
MediaDeleteForm::buildForm public function Form constructor. Overrides ConfirmFormBase::buildForm
MediaDeleteForm::closeModalAjax public function Close modal dialog.
MediaDeleteForm::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
MediaDeleteForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
MediaDeleteForm::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
MediaDeleteForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
MediaDeleteForm::submitModalAjax public function AJAX callback when the form is submitted.
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
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. 4
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.