class ActionFormBase

Same name in other branches
  1. 9 core/modules/action/src/Form/ActionFormBase.php \Drupal\action\Form\ActionFormBase
  2. 8.9.x core/modules/action/src/Form/ActionFormBase.php \Drupal\action\Form\ActionFormBase
  3. 8.9.x core/modules/action/src/ActionFormBase.php \Drupal\action\ActionFormBase
  4. 11.x core/modules/action/src/Form/ActionFormBase.php \Drupal\action\Form\ActionFormBase

Provides a base form for action forms.

Hierarchy

Expanded class hierarchy of ActionFormBase

File

core/modules/action/src/Form/ActionFormBase.php, line 14

Namespace

Drupal\action\Form
View source
abstract class ActionFormBase extends EntityForm {
    
    /**
     * The action storage.
     *
     * @var \Drupal\Core\Entity\EntityStorageInterface
     */
    protected $storage;
    
    /**
     * The action entity.
     *
     * @var \Drupal\system\ActionConfigEntityInterface
     */
    protected $entity;
    
    /**
     * Constructs a new action form.
     *
     * @param \Drupal\Core\Entity\EntityStorageInterface $storage
     *   The action storage.
     */
    public function __construct(EntityStorageInterface $storage) {
        $this->storage = $storage;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('entity_type.manager')
            ->getStorage('action'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function form(array $form, FormStateInterface $form_state) {
        $form['label'] = [
            '#type' => 'textfield',
            '#title' => $this->t('Label'),
            '#default_value' => $this->entity
                ->label(),
            '#maxlength' => '255',
            '#description' => $this->t('A unique label for this advanced action. This label will be displayed in the interface of modules that integrate with actions.'),
        ];
        $form['id'] = [
            '#type' => 'machine_name',
            '#default_value' => $this->entity
                ->id(),
            '#disabled' => !$this->entity
                ->isNew(),
            '#maxlength' => 64,
            '#description' => $this->t('A unique name for this action. It must only contain lowercase letters, numbers and underscores.'),
            '#machine_name' => [
                'exists' => [
                    $this,
                    'exists',
                ],
            ],
        ];
        $form['plugin'] = [
            '#type' => 'value',
            '#value' => $this->entity
                ->get('plugin'),
        ];
        $form['type'] = [
            '#type' => 'value',
            '#value' => $this->entity
                ->getType(),
        ];
        if ($plugin = $this->getPlugin()) {
            $form += $plugin->buildConfigurationForm($form, $form_state);
        }
        return parent::form($form, $form_state);
    }
    
    /**
     * Determines if the action already exists.
     *
     * @param string $id
     *   The action ID.
     *
     * @return bool
     *   TRUE if the action exists, FALSE otherwise.
     */
    public function exists($id) {
        $action = $this->storage
            ->load($id);
        return !empty($action);
    }
    
    /**
     * {@inheritdoc}
     */
    protected function actions(array $form, FormStateInterface $form_state) {
        $actions = parent::actions($form, $form_state);
        unset($actions['delete']);
        return $actions;
    }
    
    /**
     * {@inheritdoc}
     */
    public function validateForm(array &$form, FormStateInterface $form_state) {
        parent::validateForm($form, $form_state);
        if ($plugin = $this->getPlugin()) {
            $plugin->validateConfigurationForm($form, $form_state);
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        parent::submitForm($form, $form_state);
        if ($plugin = $this->getPlugin()) {
            $plugin->submitConfigurationForm($form, $form_state);
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function save(array $form, FormStateInterface $form_state) {
        $this->entity
            ->save();
        $this->messenger()
            ->addStatus($this->t('The action has been successfully saved.'));
        $form_state->setRedirect('entity.action.collection');
    }
    
    /**
     * Gets the action plugin while ensuring it implements configuration form.
     *
     * @return \Drupal\Core\Action\ActionInterface|\Drupal\Core\Plugin\PluginFormInterface|null
     *   The action plugin, or NULL if it does not implement configuration forms.
     */
    protected function getPlugin() {
        if ($this->entity
            ->getPlugin() instanceof PluginFormInterface) {
            return $this->entity
                ->getPlugin();
        }
        return NULL;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ActionFormBase::$entity protected property The action entity. Overrides EntityForm::$entity
ActionFormBase::$storage protected property The action storage.
ActionFormBase::actions protected function Overrides EntityForm::actions
ActionFormBase::create public static function Overrides FormBase::create
ActionFormBase::exists public function Determines if the action already exists.
ActionFormBase::form public function Overrides EntityForm::form
ActionFormBase::getPlugin protected function Gets the action plugin while ensuring it implements configuration form.
ActionFormBase::save public function Overrides EntityForm::save
ActionFormBase::submitForm public function Overrides EntityForm::submitForm
ActionFormBase::validateForm public function Overrides FormBase::validateForm
ActionFormBase::__construct public function Constructs a new action form.
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::buildEntity public function Overrides EntityFormInterface::buildEntity 5
EntityForm::buildForm public function Overrides FormInterface::buildForm 13
EntityForm::copyFormValuesToEntity protected function Copies top-level form values to entity properties. 11
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::init protected function Initialize the form state and the entity before the first form build. 3
EntityForm::prepareEntity protected function Prepares the entity object before the form is built first. 3
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. 3
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. 3
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.