class OverridesEntityForm

Same name in other branches
  1. 9 core/modules/layout_builder/src/Form/OverridesEntityForm.php \Drupal\layout_builder\Form\OverridesEntityForm
  2. 8.9.x core/modules/layout_builder/src/Form/OverridesEntityForm.php \Drupal\layout_builder\Form\OverridesEntityForm
  3. 10 core/modules/layout_builder/src/Form/OverridesEntityForm.php \Drupal\layout_builder\Form\OverridesEntityForm

Provides a form containing the Layout Builder UI for overrides.

@internal Form classes are internal.

Hierarchy

Expanded class hierarchy of OverridesEntityForm

1 file declares its use of OverridesEntityForm
layout_builder.module in core/modules/layout_builder/layout_builder.module
Provides hook implementations for Layout Builder.

File

core/modules/layout_builder/src/Form/OverridesEntityForm.php, line 25

Namespace

Drupal\layout_builder\Form
View source
class OverridesEntityForm extends ContentEntityForm implements WorkspaceDynamicSafeFormInterface {
    use PreviewToggleTrait;
    use LayoutBuilderEntityFormTrait;
    use WorkspaceSafeFormTrait;
    
    /**
     * Layout tempstore repository.
     *
     * @var \Drupal\layout_builder\LayoutTempstoreRepositoryInterface
     */
    protected $layoutTempstoreRepository;
    
    /**
     * The section storage.
     *
     * @var \Drupal\layout_builder\SectionStorageInterface
     */
    protected $sectionStorage;
    
    /**
     * Constructs a new OverridesEntityForm.
     *
     * @param \Drupal\Core\Entity\EntityRepositoryInterface $entity_repository
     *   The entity repository service.
     * @param \Drupal\Core\Entity\EntityTypeBundleInfoInterface $entity_type_bundle_info
     *   The entity type bundle service.
     * @param \Drupal\Component\Datetime\TimeInterface $time
     *   The time service.
     * @param \Drupal\layout_builder\LayoutTempstoreRepositoryInterface $layout_tempstore_repository
     *   The layout tempstore repository.
     */
    public function __construct(EntityRepositoryInterface $entity_repository, EntityTypeBundleInfoInterface $entity_type_bundle_info, TimeInterface $time, LayoutTempstoreRepositoryInterface $layout_tempstore_repository) {
        parent::__construct($entity_repository, $entity_type_bundle_info, $time);
        $this->layoutTempstoreRepository = $layout_tempstore_repository;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('entity.repository'), $container->get('entity_type.bundle.info'), $container->get('datetime.time'), $container->get('layout_builder.tempstore_repository'));
    }
    
    /**
     * {@inheritdoc}
     */
    protected function init(FormStateInterface $form_state) {
        parent::init($form_state);
        $form_display = EntityFormDisplay::collectRenderDisplay($this->entity, $this->getOperation(), FALSE);
        $form_display->setComponent(OverridesSectionStorage::FIELD_NAME, [
            'type' => 'layout_builder_widget',
            'weight' => -10,
            'settings' => [],
        ]);
        $this->setFormDisplay($form_display, $form_state);
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state, ?SectionStorageInterface $section_storage = NULL) {
        $this->sectionStorage = $section_storage;
        $form = parent::buildForm($form, $form_state);
        $form['#attributes']['class'][] = 'layout-builder-form';
        // @todo \Drupal\layout_builder\Field\LayoutSectionItemList::defaultAccess()
        //   restricts all access to the field, explicitly allow access here until
        //   https://www.drupal.org/node/2942975 is resolved.
        $form[OverridesSectionStorage::FIELD_NAME]['#access'] = TRUE;
        $form['layout_builder_message'] = $this->buildMessage($section_storage->getContextValue('entity'), $section_storage);
        return $form;
    }
    
    /**
     * Renders a message to display at the top of the layout builder.
     *
     * @param \Drupal\Core\Entity\EntityInterface $entity
     *   The entity whose layout is being edited.
     * @param \Drupal\layout_builder\OverridesSectionStorageInterface $section_storage
     *   The current section storage.
     *
     * @return array
     *   A renderable array containing the message.
     */
    protected function buildMessage(EntityInterface $entity, OverridesSectionStorageInterface $section_storage) {
        $entity_type = $entity->getEntityType();
        $bundle_info = $this->entityTypeBundleInfo
            ->getBundleInfo($entity->getEntityTypeId());
        $variables = [
            '@bundle' => $bundle_info[$entity->bundle()]['label'],
            '@singular_label' => $entity_type->getSingularLabel(),
            '@plural_label' => $entity_type->getPluralLabel(),
        ];
        $defaults_link = $section_storage->getDefaultSectionStorage()
            ->getLayoutBuilderUrl();
        if ($defaults_link->access($this->currentUser())) {
            $variables[':link'] = $defaults_link->toString();
            if ($entity_type->hasKey('bundle')) {
                $message = $this->t('You are editing the layout for this @bundle @singular_label. <a href=":link">Edit the template for all @bundle @plural_label instead.</a>', $variables);
            }
            else {
                $message = $this->t('You are editing the layout for this @singular_label. <a href=":link">Edit the template for all @plural_label instead.</a>', $variables);
            }
        }
        else {
            if ($entity_type->hasKey('bundle')) {
                $message = $this->t('You are editing the layout for this @bundle @singular_label.', $variables);
            }
            else {
                $message = $this->t('You are editing the layout for this @singular_label.', $variables);
            }
        }
        return $this->buildMessageContainer($message, 'overrides');
    }
    
    /**
     * {@inheritdoc}
     */
    public function save(array $form, FormStateInterface $form_state) {
        $return = parent::save($form, $form_state);
        $this->saveTasks($form_state, $this->t('The layout override has been saved.'));
        return $return;
    }
    
    /**
     * {@inheritdoc}
     */
    protected function actions(array $form, FormStateInterface $form_state) {
        $actions = parent::actions($form, $form_state);
        $actions = $this->buildActions($actions);
        $actions['delete']['#access'] = FALSE;
        $actions['discard_changes']['#limit_validation_errors'] = [];
        // @todo This button should be conditionally displayed, see
        //   https://www.drupal.org/node/2917777.
        $actions['revert'] = [
            '#type' => 'submit',
            '#value' => $this->t('Revert to defaults'),
            '#submit' => [
                '::redirectOnSubmit',
            ],
            '#redirect' => 'revert',
        ];
        return $actions;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ContentEntityForm::$entity protected property The entity being used by this form. Overrides EntityForm::$entity 9
ContentEntityForm::$entityRepository protected property The entity repository service.
ContentEntityForm::$entityTypeBundleInfo protected property The entity type bundle info service.
ContentEntityForm::$time protected property The time service.
ContentEntityForm::addRevisionableFormFields protected function Add revision form fields if the entity enabled the UI.
ContentEntityForm::buildEntity public function Overrides EntityForm::buildEntity 4
ContentEntityForm::copyFormValuesToEntity protected function Overrides EntityForm::copyFormValuesToEntity
ContentEntityForm::flagViolations protected function Flags violations for the current form. 4
ContentEntityForm::form public function Overrides EntityForm::form 13
ContentEntityForm::getBundleEntity protected function Returns the bundle entity of the entity, or NULL if there is none.
ContentEntityForm::getEditedFieldNames protected function Gets the names of all fields edited in the form. 4
ContentEntityForm::getFormDisplay public function Overrides ContentEntityFormInterface::getFormDisplay
ContentEntityForm::getFormLangcode public function Overrides ContentEntityFormInterface::getFormLangcode
ContentEntityForm::getNewRevisionDefault protected function Should new revisions created on default.
ContentEntityForm::initFormLangcodes protected function Initializes form language code values.
ContentEntityForm::isDefaultFormLangcode public function Overrides ContentEntityFormInterface::isDefaultFormLangcode
ContentEntityForm::prepareEntity protected function Overrides EntityForm::prepareEntity 1
ContentEntityForm::setFormDisplay public function Overrides ContentEntityFormInterface::setFormDisplay
ContentEntityForm::showRevisionUi protected function Checks whether the revision form fields should be added to the form.
ContentEntityForm::submitForm public function Overrides EntityForm::submitForm 3
ContentEntityForm::updateChangedTime public function Updates the changed time of the entity.
ContentEntityForm::updateFormLangcode public function Updates the form language to reflect any change to the entity language.
ContentEntityForm::validateForm public function Button-level validation handlers are highly discouraged for entity forms,
as they will prevent entity validation from running. If the entity is going
to be saved during the form submission, this method should be manually
invoked from the button-level…
Overrides FormBase::validateForm 3
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
EntityForm::$entityTypeManager protected property The entity type manager. 3
EntityForm::$moduleHandler protected property The module handler service. 2
EntityForm::$operation protected property The name of the current operation.
EntityForm::actionsElement protected function Returns the action form element for the current entity form.
EntityForm::afterBuild public function Form element #after_build callback: Updates the entity with submitted data. 1
EntityForm::getEntity public function Overrides EntityFormInterface::getEntity
EntityForm::getEntityFromRouteMatch public function Overrides EntityFormInterface::getEntityFromRouteMatch 3
EntityForm::getFormId public function Overrides FormInterface::getFormId 13
EntityForm::getOperation public function Overrides EntityFormInterface::getOperation
EntityForm::prepareInvokeAll protected function Invokes the specified prepare hook variant.
EntityForm::processForm public function Process callback: assigns weights and hides extra fields.
EntityForm::setEntity public function Overrides EntityFormInterface::setEntity
EntityForm::setEntityTypeManager public function Overrides EntityFormInterface::setEntityTypeManager
EntityForm::setModuleHandler public function Overrides EntityFormInterface::setModuleHandler
EntityForm::setOperation public function Overrides EntityFormInterface::setOperation
FormBase::$configFactory protected property The config factory. 2
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. 2
FormBase::container private function Returns the service container.
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.
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.
LayoutBuilderEntityFormTrait::buildActions protected function Builds the actions for the form.
LayoutBuilderEntityFormTrait::buildMessageContainer protected function Build the message container.
LayoutBuilderEntityFormTrait::getBaseFormId public function 1
LayoutBuilderEntityFormTrait::getSectionStorage public function Retrieves the section storage object.
LayoutBuilderEntityFormTrait::redirectOnSubmit public function Form submission handler.
LayoutBuilderEntityFormTrait::saveTasks protected function Performs tasks that are needed during the save process.
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. 16
MessengerTrait::messenger public function Gets the messenger. 16
MessengerTrait::setMessenger public function Sets the messenger.
OverridesEntityForm::$layoutTempstoreRepository protected property Layout tempstore repository.
OverridesEntityForm::$sectionStorage protected property The section storage.
OverridesEntityForm::actions protected function Overrides EntityForm::actions
OverridesEntityForm::buildForm public function Overrides EntityForm::buildForm
OverridesEntityForm::buildMessage protected function Renders a message to display at the top of the layout builder.
OverridesEntityForm::create public static function Overrides ContentEntityForm::create
OverridesEntityForm::init protected function Overrides ContentEntityForm::init
OverridesEntityForm::save public function Overrides EntityForm::save
OverridesEntityForm::__construct public function Constructs a new OverridesEntityForm. Overrides ContentEntityForm::__construct
PreviewToggleTrait::buildContentPreviewToggle protected function Builds the content preview toggle input.
PreviewToggleTrait::currentUser abstract protected function Gets the current user.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 2
RedirectDestinationTrait::getDestinationArray protected function Prepares a &#039;destination&#039; 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. 3
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.
WorkspaceSafeFormTrait::$workspaceInfo protected property The workspace information service.
WorkspaceSafeFormTrait::getSectionStorageFromFormState protected function Retrieves the section storage from a form state object, if it exists.
WorkspaceSafeFormTrait::getWorkspaceInfo protected function Retrieves the workspace information service.
WorkspaceSafeFormTrait::isWorkspaceSafeEntity protected function Determines whether an entity used in a form is workspace-safe.
WorkspaceSafeFormTrait::isWorkspaceSafeEntityType protected function Determines whether an entity type used in a form is workspace-safe.
WorkspaceSafeFormTrait::isWorkspaceSafeForm public function Determines whether the current form is safe to be submitted in a workspace.

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