class HtmlEntityFormController in Drupal 8

Wrapping controller for entity forms that serve as the main page body.

Hierarchy

• class \Drupal\Core\Controller\FormController uses DependencySerializationTrait
  • class \Drupal\Core\Entity\HtmlEntityFormController uses DeprecatedServicePropertyTrait

1 string reference to 'HtmlEntityFormController'

core.services.yml in core/core.services.yml

core/core.services.yml

1 service uses HtmlEntityFormController

controller.entity_form in core/core.services.yml

Drupal\Core\Entity\HtmlEntityFormController

File

core/lib/Drupal/Core/Entity/HtmlEntityFormController.php, line 14

Namespace

Drupal\Core\Entity

class HtmlEntityFormController extends FormController {
  use DeprecatedServicePropertyTrait;

  /**
   * {@inheritdoc}
   */
  protected $deprecatedProperties = [
    'entityManager' => 'entity.manager',
  ];

  /**
   * The entity type manager service.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Constructs a new \Drupal\Core\Routing\Enhancer\FormEnhancer object.
   *
   * @param \Symfony\Component\HttpKernel\Controller\ArgumentResolverInterface $argument_resolver
   *   The argument resolver.
   * @param \Drupal\Core\Form\FormBuilderInterface $form_builder
   *   The form builder.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager service.
   */
  public function __construct(ArgumentResolverInterface $argument_resolver, FormBuilderInterface $form_builder, EntityTypeManagerInterface $entity_type_manager) {
    parent::__construct($argument_resolver, $form_builder);
    if ($entity_type_manager instanceof EntityManagerInterface) {
      @trigger_error('Passing the entity.manager service to HtmlEntityFormController::__construct() is deprecated in Drupal 8.7.0 and will be removed before Drupal 9.0.0. Pass the new dependencies instead. See https://www.drupal.org/node/2549139.', E_USER_DEPRECATED);
      $this->entityTypeManager = \Drupal::entityTypeManager();
    }
    else {
      $this->entityTypeManager = $entity_type_manager;
    }
  }

  /**
   * {@inheritdoc}
   */
  protected function getFormArgument(RouteMatchInterface $route_match) {
    return $route_match
      ->getRouteObject()
      ->getDefault('_entity_form');
  }

  /**
   * {@inheritdoc}
   *
   * Instead of a class name or service ID, $form_arg will be a string
   * representing the entity and operation being performed.
   * Consider the following route:
   * @code
   *   path: '/foo/{node}/bar'
   *   defaults:
   *     _entity_form: 'node.edit'
   * @endcode
   * This means that the edit form for the node entity will used.
   * If the entity type has a default form, only the name of the
   * entity {param} needs to be passed:
   * @code
   *   path: '/foo/{node}/baz'
   *   defaults:
   *     _entity_form: 'node'
   * @endcode
   */
  protected function getFormObject(RouteMatchInterface $route_match, $form_arg) {

    // If no operation is provided, use 'default'.
    $form_arg .= '.default';
    list($entity_type_id, $operation) = explode('.', $form_arg);
    $form_object = $this->entityTypeManager
      ->getFormObject($entity_type_id, $operation);

    // Allow the entity form to determine the entity object from a given route
    // match.
    $entity = $form_object
      ->getEntityFromRouteMatch($route_match, $entity_type_id);
    $form_object
      ->setEntity($entity);
    return $form_object;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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
DeprecatedServicePropertyTrait::__get	public	function	Allows to access deprecated/removed properties.
FormController::$argumentResolver	protected	property	The argument resolver.
FormController::$controllerResolver Deprecated	protected	property	The controller resolver.
FormController::$formBuilder	protected	property	The form builder.
FormController::getContentResult	public	function	Invokes the form and returns the result.
HtmlEntityFormController::$deprecatedProperties	protected	property
HtmlEntityFormController::$entityTypeManager	protected	property	The entity type manager service.
HtmlEntityFormController::getFormArgument	protected	function	Extracts the form argument string from a request. Overrides FormController::getFormArgument
HtmlEntityFormController::getFormObject	protected	function	Instead of a class name or service ID, $form_arg will be a string representing the entity and operation being performed. Consider the following route: Overrides FormController::getFormObject
HtmlEntityFormController::__construct	public	function	Constructs a new \Drupal\Core\Routing\Enhancer\FormEnhancer object. Overrides FormController::__construct