abstract class FormController in Zircon Profile 8

Common base class for form interstitial controllers.

@todo Make this a trait in PHP 5.4.

Hierarchy

• class \Drupal\Core\Controller\FormController uses DependencySerializationTrait

1 file declares its use of FormController

HtmlEntityFormController.php in core/lib/Drupal/Core/Entity/HtmlEntityFormController.php

Contains \Drupal\Core\Entity\HtmlEntityFormController.

File

core/lib/Drupal/Core/Controller/FormController.php, line 21

Contains \Drupal\Core\Controller\FormController.

Namespace

Drupal\Core\Controller

abstract class FormController {
  use DependencySerializationTrait;

  /**
   * The controller resolver.
   *
   * @var \Drupal\Core\Controller\ControllerResolverInterface
   */
  protected $controllerResolver;

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

  /**
   * Constructs a new \Drupal\Core\Controller\FormController object.
   *
   * @param \Drupal\Core\Controller\ControllerResolverInterface $controller_resolver
   *   The controller resolver.
   * @param \Drupal\Core\Form\FormBuilderInterface $form_builder
   *   The form builder.
   */
  public function __construct(ControllerResolverInterface $controller_resolver, FormBuilderInterface $form_builder) {
    $this->controllerResolver = $controller_resolver;
    $this->formBuilder = $form_builder;
  }

  /**
   * Invokes the form and returns the result.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request object.
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   The route match.
   *
   * @return array
   *   The render array that results from invoking the controller.
   */
  public function getContentResult(Request $request, RouteMatchInterface $route_match) {
    $form_arg = $this
      ->getFormArgument($route_match);
    $form_object = $this
      ->getFormObject($route_match, $form_arg);

    // Add the form and form_state to trick the getArguments method of the
    // controller resolver.
    $form_state = new FormState();
    $request->attributes
      ->set('form', []);
    $request->attributes
      ->set('form_state', $form_state);
    $args = $this->controllerResolver
      ->getArguments($request, [
      $form_object,
      'buildForm',
    ]);
    $request->attributes
      ->remove('form');
    $request->attributes
      ->remove('form_state');

    // Remove $form and $form_state from the arguments, and re-index them.
    unset($args[0], $args[1]);
    $form_state
      ->addBuildInfo('args', array_values($args));
    return $this->formBuilder
      ->buildForm($form_object, $form_state);
  }

  /**
   * Extracts the form argument string from a request.
   *
   * Depending on the type of form the argument string may be stored in a
   * different request attribute.
   *
   * One example of a route definition is given below.
   * @code
   *   defaults:
   *     _form: Drupal\example\Form\ExampleForm
   * @endcode
   *
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   The route match object from which to extract a form definition string.
   *
   * @return string
   *   The form definition string.
   */
  protected abstract function getFormArgument(RouteMatchInterface $route_match);

  /**
   * Returns the object used to build the form.
   *
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   The route match.
   * @param string $form_arg
   *   Either a class name or a service ID.
   *
   * @return \Drupal\Core\Form\FormInterface
   *   The form object to use.
   */
  protected abstract function getFormObject(RouteMatchInterface $route_match, $form_arg);

}

Members

Name	Modifiers	Type	Description	Overrides
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
FormController::$controllerResolver	protected	property	The controller resolver.
FormController::$formBuilder	protected	property	The form builder.
FormController::getContentResult	public	function	Invokes the form and returns the result.
FormController::getFormArgument	abstract protected	function	Extracts the form argument string from a request.	2
FormController::getFormObject	abstract protected	function	Returns the object used to build the form.	2
FormController::__construct	public	function	Constructs a new \Drupal\Core\Controller\FormController object.	2