class BlockContentForm

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

Form handler for the content block edit forms.

@internal

Hierarchy

Expanded class hierarchy of BlockContentForm

File

core/modules/block_content/src/BlockContentForm.php, line 14

Namespace

Drupal\block_content
View source
class BlockContentForm extends ContentEntityForm {
    
    /**
     * The block content entity.
     *
     * @var \Drupal\block_content\BlockContentInterface
     */
    protected $entity;
    
    /**
     * {@inheritdoc}
     */
    public function form(array $form, FormStateInterface $form_state) {
        $block = $this->entity;
        $form = parent::form($form, $form_state);
        if ($this->operation == 'edit') {
            $form['#title'] = $this->t('Edit content block %label', [
                '%label' => $block->label(),
            ]);
        }
        // Override the default CSS class name, since the user-defined content block
        // type name in 'TYPE-block-form' potentially clashes with third-party class
        // names.
        $form['#attributes']['class'][0] = 'block-' . Html::getClass($block->bundle()) . '-form';
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    protected function actions(array $form, FormStateInterface $form_state) : array {
        $element = parent::actions($form, $form_state);
        if ($this->getRequest()->query
            ->has('theme')) {
            $element['submit']['#value'] = $this->t('Save and configure');
        }
        if ($this->currentUser()
            ->hasPermission('administer blocks') && !$this->getRequest()->query
            ->has('theme') && $this->entity
            ->isNew()) {
            $element['configure_block'] = [
                '#type' => 'submit',
                '#value' => $this->t('Save and configure'),
                '#weight' => 20,
                '#submit' => array_merge($element['submit']['#submit'], [
                    '::configureBlock',
                ]),
            ];
        }
        return $element;
    }
    
    /**
     * Form submission handler for the 'configureBlock' action.
     *
     * @param array $form
     *   An associative array containing the structure of the form.
     * @param \Drupal\Core\Form\FormStateInterface $form_state
     *   The current state of the form.
     */
    public function configureBlock(array $form, FormStateInterface $form_state) : void {
        $block = $this->entity;
        if (!($theme = $block->getTheme())) {
            $theme = $this->config('system.theme')
                ->get('default');
        }
        $form_state->setRedirect('block.admin_add', [
            'plugin_id' => 'block_content:' . $block->uuid(),
            'theme' => $theme,
        ]);
        $form_state->setIgnoreDestination();
    }
    
    /**
     * {@inheritdoc}
     */
    public function save(array $form, FormStateInterface $form_state) {
        $block = $this->entity;
        $insert = $block->isNew();
        $block->save();
        $context = [
            '@type' => $block->bundle(),
            '%info' => $block->label(),
        ];
        $logger = $this->logger('block_content');
        $block_type = $this->getBundleEntity();
        $t_args = [
            '@type' => $block_type->label(),
            '%info' => $block->label(),
        ];
        if ($insert) {
            $logger->info('@type: added %info.', $context);
            $this->messenger()
                ->addStatus($this->t('@type %info has been created.', $t_args));
        }
        else {
            $logger->info('@type: updated %info.', $context);
            $this->messenger()
                ->addStatus($this->t('@type %info has been updated.', $t_args));
        }
        if ($block->id()) {
            $form_state->setValue('id', $block->id());
            $form_state->set('id', $block->id());
            $theme = $block->getTheme();
            if ($insert && $theme) {
                $form_state->setRedirect('block.admin_add', [
                    'plugin_id' => 'block_content:' . $block->uuid(),
                    'theme' => $theme,
                    'region' => $this->getRequest()->query
                        ->getString('region'),
                ]);
            }
            else {
                $form_state->setRedirectUrl($block->toUrl('collection'));
            }
        }
        else {
            // In the unlikely case something went wrong on save, the block will be
            // rebuilt and block form redisplayed.
            $this->messenger()
                ->addError($this->t('The block could not be saved.'));
            $form_state->setRebuild();
        }
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
BlockContentForm::$entity protected property The block content entity. Overrides ContentEntityForm::$entity
BlockContentForm::actions protected function Overrides EntityForm::actions
BlockContentForm::configureBlock public function Form submission handler for the 'configureBlock' action.
BlockContentForm::form public function Overrides ContentEntityForm::form
BlockContentForm::save public function Overrides EntityForm::save
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::create public static function Overrides FormBase::create 9
ContentEntityForm::flagViolations protected function Flags violations for the current form. 4
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::init protected function Initializes the form state and the entity before the first form build. Overrides EntityForm::init 1
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
ContentEntityForm::__construct public function Constructs a ContentEntityForm object. 8
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::buildForm public function Overrides FormInterface::buildForm 13
EntityForm::getBaseFormId public function Overrides BaseFormIdInterface::getBaseFormId 4
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::currentUser protected function Gets the current user. 2
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.
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.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 2
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' 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.

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