class ActionAddForm

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

Provides a form for action add forms.

@internal

Hierarchy

  • class \Drupal\action\Form\ActionAddForm extends \Drupal\action\Form\ActionFormBase

Expanded class hierarchy of ActionAddForm

1 file declares its use of ActionAddForm
action.module in core/modules/action/action.module
This is the Actions UI module for executing stored actions.

File

core/modules/action/src/Form/ActionAddForm.php, line 12

Namespace

Drupal\action\Form
View source 
class ActionAddForm extends ActionFormBase {
    
    /**
     * {@inheritdoc}
     *
     * @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.
     * @param string $action_id
     *   The action ID.
     */
    public function buildForm(array $form, FormStateInterface $form_state, $action_id = NULL) {
        $this->entity
            ->setPlugin($action_id);
        // Derive the label and type from the action definition.
        $definition = $this->entity
            ->getPluginDefinition();
        $this->entity
            ->set('label', $definition['label']);
        $this->entity
            ->set('type', $definition['type']);
        return parent::buildForm($form, $form_state);
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
ActionAddForm::buildForm public function Overrides EntityForm::buildForm
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 Builds an updated entity object based upon the submitted form values. Overrides EntityFormInterface::buildEntity 5
EntityForm::copyFormValuesToEntity protected function Copies top-level form values to entity properties. 11
EntityForm::getBaseFormId public function Returns a string identifying the base form. Overrides BaseFormIdInterface::getBaseFormId 4
EntityForm::getEntity public function Gets the form entity. Overrides EntityFormInterface::getEntity
EntityForm::getEntityFromRouteMatch public function Determines which entity will be used by this form from a RouteMatch object. Overrides EntityFormInterface::getEntityFromRouteMatch 3
EntityForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId 13
EntityForm::getOperation public function Gets the operation identifying the form. 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 Sets the form entity. Overrides EntityFormInterface::setEntity
EntityForm::setEntityTypeManager public function Sets the entity type manager for this form. Overrides EntityFormInterface::setEntityTypeManager
EntityForm::setModuleHandler public function Sets the module handler for this form. Overrides EntityFormInterface::setModuleHandler
EntityForm::setOperation public function Sets the operation for this form. 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.