class BookRemoveForm in Drupal 8

Same name and namespace in other branches

9 core/modules/book/src/Form/BookRemoveForm.php \Drupal\book\Form\BookRemoveForm

Remove form for book module.

@internal

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfirmFormBase implements ConfirmFormInterface
  - class \Drupal\book\Form\BookRemoveForm

Expanded class hierarchy of BookRemoveForm

1 string reference to 'BookRemoveForm'

book.routing.yml in core/modules/book/book.routing.yml: core/modules/book/book.routing.yml

File

core/modules/book/src/Form/BookRemoveForm.php, line 16

Namespace

Drupal\book\Form

View source

class BookRemoveForm extends ConfirmFormBase {

  /**
   * The book manager.
   *
   * @var \Drupal\book\BookManagerInterface
   */
  protected $bookManager;

  /**
   * The node representing the book.
   *
   * @var \Drupal\node\NodeInterface
   */
  protected $node;

  /**
   * Constructs a BookRemoveForm object.
   *
   * @param \Drupal\book\BookManagerInterface $book_manager
   *   The book manager.
   */
  public function __construct(BookManagerInterface $book_manager) {
    $this->bookManager = $book_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('book.manager'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, NodeInterface $node = NULL) {
    $this->node = $node;
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    $title = [
      '%title' => $this->node
        ->label(),
    ];
    if ($this->node->book['has_children']) {
      return $this
        ->t('%title has associated child pages, which will be relocated automatically to maintain their connection to the book. To recreate the hierarchy (as it was before removing this page), %title may be added again using the Outline tab, and each of its former child pages will need to be relocated manually.', $title);
    }
    else {
      return $this
        ->t('%title may be added to hierarchy again using the Outline tab.', $title);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getConfirmText() {
    return $this
      ->t('Remove');
  }

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {
    return $this
      ->t('Are you sure you want to remove %title from the book hierarchy?', [
      '%title' => $this->node
        ->label(),
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function getCancelUrl() {
    return $this->node
      ->toUrl();
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    if ($this->bookManager
      ->checkNodeIsRemovable($this->node)) {
      $this->bookManager
        ->deleteFromBook($this->node
        ->id());
      $this
        ->messenger()
        ->addStatus($this
        ->t('The post has been removed from the book.'));
    }
    $form_state
      ->setRedirectUrl($this
      ->getCancelUrl());
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BookRemoveForm::$bookManager	protected	property	The book manager.
BookRemoveForm::$node	protected	property	The node representing the book.
BookRemoveForm::buildForm	public	function	Form constructor. Overrides ConfirmFormBase::buildForm
BookRemoveForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
BookRemoveForm::getCancelUrl	public	function	Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
BookRemoveForm::getConfirmText	public	function	Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
BookRemoveForm::getDescription	public	function	Returns additional text to display as a description. Overrides ConfirmFormBase::getDescription
BookRemoveForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
BookRemoveForm::getQuestion	public	function	Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
BookRemoveForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
BookRemoveForm::__construct	public	function	Constructs a BookRemoveForm object.
ConfirmFormBase::getCancelText	public	function	Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface::getCancelText	1
ConfirmFormBase::getFormName	public	function	Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface::getFormName
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.
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.

You are here

class BookRemoveForm in Drupal 8

Hierarchy

File

Namespace

Members

API Navigation