class EntityFormBuilder

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

Builds entity forms.

Hierarchy

Expanded class hierarchy of EntityFormBuilder

1 file declares its use of EntityFormBuilder
EntityFormBuilderTest.php in core/tests/Drupal/Tests/Core/Entity/EntityFormBuilderTest.php
1 string reference to 'EntityFormBuilder'
core.services.yml in core/core.services.yml
core/core.services.yml
1 service uses EntityFormBuilder
entity.form_builder in core/core.services.yml
Drupal\Core\Entity\EntityFormBuilder

File

core/lib/Drupal/Core/Entity/EntityFormBuilder.php, line 12

Namespace

Drupal\Core\Entity
View source
class EntityFormBuilder implements EntityFormBuilderInterface {
    use DeprecatedServicePropertyTrait;
    
    /**
     * {@inheritdoc}
     */
    protected $deprecatedProperties = [
        'entityManager' => 'entity.manager',
    ];
    
    /**
     * The entity type manager service.
     *
     * @var \Drupal\Core\Entity\EntityTypeManagerInterface
     */
    protected $entityTypeManager;
    
    /**
     * The form builder.
     *
     * @var \Drupal\Core\Form\FormBuilderInterface
     */
    protected $formBuilder;
    
    /**
     * Constructs a new EntityFormBuilder.
     *
     * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
     *   The entity type manager service.
     * @param \Drupal\Core\Form\FormBuilderInterface $form_builder
     *   The form builder.
     */
    public function __construct(EntityTypeManagerInterface $entity_type_manager, FormBuilderInterface $form_builder) {
        if ($entity_type_manager instanceof EntityManagerInterface) {
            @trigger_error('Passing the entity.manager service to EntityFormBuilder::__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;
        }
        $this->formBuilder = $form_builder;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getForm(EntityInterface $entity, $operation = 'default', array $form_state_additions = []) {
        $form_object = $this->entityTypeManager
            ->getFormObject($entity->getEntityTypeId(), $operation);
        $form_object->setEntity($entity);
        $form_state = (new FormState())->setFormState($form_state_additions);
        return $this->formBuilder
            ->buildForm($form_object, $form_state);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
DeprecatedServicePropertyTrait::__get public function Allows to access deprecated/removed properties.
EntityFormBuilder::$deprecatedProperties protected property
EntityFormBuilder::$entityTypeManager protected property The entity type manager service.
EntityFormBuilder::$formBuilder protected property The form builder.
EntityFormBuilder::getForm public function Gets the built and processed entity form for the given entity. Overrides EntityFormBuilderInterface::getForm
EntityFormBuilder::__construct public function Constructs a new EntityFormBuilder.

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