class DisableForm

Provides the filter format disable form.

Hierarchy

Expanded class hierarchy of DisableForm

1 string reference to 'DisableForm'
filter.routing.yml in drupal/core/modules/filter/filter.routing.yml
drupal/core/modules/filter/filter.routing.yml

File

drupal/core/modules/filter/lib/Drupal/filter/Form/DisableForm.php, line 16
Contains \Drupal\filter\Form\DisableForm.

Namespace

Drupal\filter\Form
View source
class DisableForm extends ConfirmFormBase {

  /**
   * The format being disabled.
   *
   * @var \Drupal\filter\Plugin\Core\Entity\FilterFormat
   */
  protected $format;

  /**
   * Implements \Drupal\Core\Form\FormInterface::getFormID().
   */
  public function getFormID() {
    return 'filter_admin_disable';
  }

  /**
   * Implements \Drupal\Core\Form\ConfirmFormBase::getQuestion().
   */
  protected function getQuestion() {
    return t('Are you sure you want to disable the text format %format?', array(
      '%format' => $this->format->name,
    ));
  }

  /**
   * Implements \Drupal\Core\Form\ConfirmFormBase::getCancelPath().
   */
  protected function getCancelPath() {
    return 'admin/config/content/formats';
  }

  /**
   * Overrides \Drupal\Core\Form\ConfirmFormBase::getConfirmText().
   */
  public function getConfirmText() {
    return t('Disable');
  }

  /**
   * Overrides \Drupal\Core\Form\ConfirmFormBase::getDescription().
   */
  public function getDescription() {
    return t('Disabled text formats are completely removed from the administrative interface, and any content stored with that format will not be displayed. This action cannot be undone.');
  }

  /**
   * Overrides \Drupal\Core\Form\FormInterface::buildForm().
   */
  public function buildForm(array $form, array &$form_state, FilterFormat $filter_format = NULL) {
    $this->format = $filter_format;
    return parent::buildForm($form, $form_state);
  }

  /**
   * Implements \Drupal\Core\Form\FormInterface::submitForm().
   */
  public function submitForm(array &$form, array &$form_state) {
    $this->format
      ->disable()
      ->save();
    drupal_set_message(t('Disabled text format %format.', array(
      '%format' => $this->format->name,
    )));
    $form_state['redirect'] = 'admin/config/content/formats';
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfirmFormBase::getCancelText protected function Returns a caption for the link which cancels the action. 2
ConfirmFormBase::getFormName protected function Returns the internal name used to refer to the confirmation item.
ConfirmFormBase::validateForm public function Implements \Drupal\Core\Form\FormInterface::validateForm(). Overrides FormInterface::validateForm 1
DisableForm::$format protected property The format being disabled.
DisableForm::buildForm public function Overrides \Drupal\Core\Form\FormInterface::buildForm(). Overrides ConfirmFormBase::buildForm
DisableForm::getCancelPath protected function Implements \Drupal\Core\Form\ConfirmFormBase::getCancelPath(). Overrides ConfirmFormBase::getCancelPath
DisableForm::getConfirmText public function Overrides \Drupal\Core\Form\ConfirmFormBase::getConfirmText(). Overrides ConfirmFormBase::getConfirmText
DisableForm::getDescription public function Overrides \Drupal\Core\Form\ConfirmFormBase::getDescription(). Overrides ConfirmFormBase::getDescription
DisableForm::getFormID public function Implements \Drupal\Core\Form\FormInterface::getFormID(). Overrides FormInterface::getFormID
DisableForm::getQuestion protected function Implements \Drupal\Core\Form\ConfirmFormBase::getQuestion(). Overrides ConfirmFormBase::getQuestion
DisableForm::submitForm public function Implements \Drupal\Core\Form\FormInterface::submitForm(). Overrides FormInterface::submitForm