class HtmlEntityFormController

Same name in other branches
  1. 9 core/lib/Drupal/Core/Entity/HtmlEntityFormController.php \Drupal\Core\Entity\HtmlEntityFormController
  2. 8.9.x core/lib/Drupal/Core/Entity/HtmlEntityFormController.php \Drupal\Core\Entity\HtmlEntityFormController
  3. 10 core/lib/Drupal/Core/Entity/HtmlEntityFormController.php \Drupal\Core\Entity\HtmlEntityFormController

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

Hierarchy

Expanded class hierarchy of HtmlEntityFormController

File

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

Namespace

Drupal\Core\Entity
View source
class HtmlEntityFormController extends FormController {
    
    /**
     * 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);
        $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';
        [
            $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

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormController::$argumentResolver protected property The argument resolver.
FormController::$formBuilder protected property The form builder.
FormController::getContentResult public function Invokes the form and returns the result. 3
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

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.