class RulesComponentEditForm

Provides a form to edit a component.

Hierarchy

Expanded class hierarchy of RulesComponentEditForm

File

src/Form/RulesComponentEditForm.php, line 11

Namespace

Drupal\rules\Form
View source
class RulesComponentEditForm extends RulesComponentFormBase {
    
    /**
     * The RulesUI handler of the currently active UI.
     *
     * @var \Drupal\rules\Ui\RulesUiConfigHandler
     */
    protected $rulesUiHandler;
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state, RulesUiConfigHandler $rules_ui_handler = NULL) {
        // Overridden such we can receive further route parameters.
        $this->rulesUiHandler = $rules_ui_handler;
        return parent::buildForm($form, $form_state);
    }
    
    /**
     * {@inheritdoc}
     */
    protected function prepareEntity() {
        parent::prepareEntity();
        // Replace the config entity with the latest entity from temp store, so any
        // interim changes are picked up.
        $this->entity = $this->rulesUiHandler
            ->getConfig();
    }
    
    /**
     * {@inheritdoc}
     */
    public function form(array $form, FormStateInterface $form_state) {
        // CSS to make form easier to use. Load this at end so we can override
        // styles added by #theme table.
        $form['#attached']['library'][] = 'rules/rules_ui.styles';
        $form = $this->rulesUiHandler
            ->getForm()
            ->buildForm($form, $form_state);
        return parent::form($form, $form_state);
    }
    
    /**
     * {@inheritdoc}
     */
    public function validateForm(array &$form, FormStateInterface $form_state) {
        parent::validateForm($form, $form_state);
        $this->rulesUiHandler
            ->getForm()
            ->validateForm($form, $form_state);
    }
    
    /**
     * {@inheritdoc}
     */
    protected function actions(array $form, FormStateInterface $form_state) {
        $actions = parent::actions($form, $form_state);
        $actions['submit']['#value'] = $this->t('Save');
        $actions['cancel'] = [
            '#type' => 'submit',
            '#limit_validation_errors' => [
                [
                    'locked',
                ],
            ],
            '#value' => $this->t('Cancel'),
            '#submit' => [
                '::cancel',
            ],
        ];
        return $actions;
    }
    
    /**
     * {@inheritdoc}
     */
    public function save(array $form, FormStateInterface $form_state) {
        $this->rulesUiHandler
            ->getForm()
            ->submitForm($form, $form_state);
        $component = $this->rulesUiHandler
            ->getComponent();
        $this->entity
            ->updateFromComponent($component);
        // Persist changes by saving the entity.
        parent::save($form, $form_state);
        // Also remove the temporarily stored component, it has been persisted now.
        $this->rulesUiHandler
            ->clearTemporaryStorage();
        $this->messenger()
            ->addMessage($this->t('Rule component %label has been updated.', [
            '%label' => $this->entity
                ->label(),
        ]));
    }
    
    /**
     * Form submission handler for the 'cancel' action.
     */
    public function cancel(array $form, FormStateInterface $form_state) {
        $this->rulesUiHandler
            ->clearTemporaryStorage();
        $this->messenger()
            ->addMessage($this->t('Canceled.'));
        $form_state->setRedirect('entity.rules_component.collection');
    }
    
    /**
     * Title callback: also display the rule label.
     */
    public function getTitle($rules_component) {
        return $this->t('Edit rules component "@label"', [
            '@label' => $rules_component->label(),
        ]);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
EntityForm::$entity protected property The entity being used by this form. 11
EntityForm::$entityTypeManager protected property The entity type manager. 3
EntityForm::$moduleHandler protected property The module handler service.
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.
EntityForm::buildEntity public function Builds an updated entity object based upon the submitted form values. Overrides EntityFormInterface::buildEntity 3
EntityForm::copyFormValuesToEntity protected function Copies top-level form values to entity properties. 9
EntityForm::getBaseFormId public function Returns a string identifying the base form. Overrides BaseFormIdInterface::getBaseFormId 6
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 12
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::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
EntityForm::submitForm public function This is the default entity object builder function. It is called before any
other submit handler to build the new entity object to be used by the
following submit handlers. At this point of the form workflow the entity is
validated and the form state…
Overrides FormInterface::submitForm 20
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.
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. 17
MessengerTrait::messenger public function Gets the messenger. 17
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
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.
RulesComponentEditForm::$rulesUiHandler protected property The RulesUI handler of the currently active UI.
RulesComponentEditForm::actions protected function Returns an array of supported actions for the current entity form. Overrides EntityForm::actions
RulesComponentEditForm::buildForm public function Form constructor. Overrides EntityForm::buildForm
RulesComponentEditForm::cancel public function Form submission handler for the 'cancel' action.
RulesComponentEditForm::form public function Gets the actual form array to be built. Overrides RulesComponentFormBase::form
RulesComponentEditForm::getTitle public function Title callback: also display the rule label.
RulesComponentEditForm::prepareEntity protected function Prepares the entity object before the form is built first. Overrides EntityForm::prepareEntity
RulesComponentEditForm::save public function Form submission handler for the 'save' action. Overrides EntityForm::save
RulesComponentEditForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
RulesComponentFormBase::$expressionManager protected property The Rules expression manager to get expression plugins.
RulesComponentFormBase::create public static function Instantiates a new instance of this class. Overrides FormBase::create 2
RulesComponentFormBase::entityTagsBuilder public function Callback method for the #entity_builder form property.
RulesComponentFormBase::exists public function Machine name exists callback.
RulesComponentFormBase::__construct public function Creates a new object of this class. 2
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.