class ReactionRuleEditForm
Provides a form to edit a reaction rule.
Hierarchy
- class \Drupal\Core\Form\FormBase implements \Drupal\Core\Form\FormInterface, \Drupal\Core\DependencyInjection\ContainerInjectionInterface uses \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Logger\LoggerChannelTrait, \Drupal\Core\Messenger\MessengerTrait, \Drupal\Core\Routing\RedirectDestinationTrait, \Drupal\Core\StringTranslation\StringTranslationTrait
- class \Drupal\Core\Entity\EntityForm extends \Drupal\Core\Form\FormBase implements \Drupal\Core\Entity\EntityFormInterface
- class \Drupal\rules\Form\RulesComponentFormBase extends \Drupal\Core\Entity\EntityForm
- class \Drupal\rules\Form\ReactionRuleEditForm extends \Drupal\rules\Form\RulesComponentFormBase
- class \Drupal\rules\Form\RulesComponentFormBase extends \Drupal\Core\Entity\EntityForm
- class \Drupal\Core\Entity\EntityForm extends \Drupal\Core\Form\FormBase implements \Drupal\Core\Entity\EntityFormInterface
Expanded class hierarchy of ReactionRuleEditForm
File
-
src/
Form/ ReactionRuleEditForm.php, line 14
Namespace
Drupal\rules\FormView source
class ReactionRuleEditForm extends RulesComponentFormBase {
/**
* The Rules event plugin manager.
*
* @var \Drupal\rules\Core\RulesEventManager
*/
protected $eventManager;
/**
* The RulesUI handler of the currently active UI.
*
* @var \Drupal\rules\Ui\RulesUiConfigHandler
*/
protected $rulesUiHandler;
/**
* Constructs a new object of this class.
*
* @param \Drupal\rules\Engine\ExpressionManagerInterface $expression_manager
* The expression manager.
* @param \Drupal\rules\Core\RulesEventManager $event_manager
* The event plugin manager.
*/
public function __construct(ExpressionManagerInterface $expression_manager, RulesEventManager $event_manager) {
parent::__construct($expression_manager);
$this->eventManager = $event_manager;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container->get('plugin.manager.rules_expression'), $container->get('plugin.manager.rules_event'));
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state, RulesUiConfigHandler $rules_ui_handler = NULL) {
// Overridden so that 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) {
$form['events'] = [
'#type' => 'container',
'#attributes' => [
'class' => [
'edit-events',
],
],
];
$form['events']['table'] = [
'#theme' => 'table',
'#header' => [
$this->t('Events'),
$this->t('Operations'),
],
'#empty' => $this->t('None'),
];
foreach ($this->entity
->getEventNames() as $key => $event_name) {
$event_definition = $this->eventManager
->getDefinition($event_name);
$form['events']['table']['#rows'][$key]['element'] = [
'data' => [
'#type' => 'item',
'#plain_text' => $event_definition['label'],
'#suffix' => '<div class="description">' . $this->t('Machine name: @name', [
'@name' => $event_name,
]) . '</div>',
],
];
// Provide a delete button ONLY IF there is more than one event.
if (count($this->entity
->getEventNames()) > 1) {
$form['events']['table']['#rows'][$key]['operations'] = [
'data' => [
'#type' => 'operations',
'#links' => [
'delete' => [
'title' => $this->t('Delete'),
'url' => $this->rulesUiHandler
->getUrlFromRoute('event.delete', [
'id' => $event_name,
]),
],
],
],
];
}
else {
$form['events']['table']['#rows'][$key]['element']['colspan'] = 2;
}
}
// Put action buttons in the table footer.
$links['add-event'] = [
'#theme' => 'menu_local_action',
'#link' => [
'title' => $this->t('Add event'),
'url' => $this->rulesUiHandler
->getUrlFromRoute('event.add', []),
],
];
$form['events']['table']['#footer'][] = [
[
'data' => [
'#prefix' => '<ul class="action-links">',
'local-action-links' => $links,
'#suffix' => '</ul>',
],
'colspan' => 2,
],
];
// 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);
// Remove the temporarily stored component; it has been persisted now.
$this->rulesUiHandler
->clearTemporaryStorage();
$this->messenger()
->addMessage($this->t('Reaction rule %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_reaction_rule.collection');
}
/**
* Title callback: also display the rule label.
*/
public function getTitle($rules_reaction_rule) {
return $this->t('Edit reaction rule "@label"', [
'@label' => $rules_reaction_rule->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. | ||
ReactionRuleEditForm::$eventManager | protected | property | The Rules event plugin manager. | ||
ReactionRuleEditForm::$rulesUiHandler | protected | property | The RulesUI handler of the currently active UI. | ||
ReactionRuleEditForm::actions | protected | function | Returns an array of supported actions for the current entity form. | Overrides EntityForm::actions | |
ReactionRuleEditForm::buildForm | public | function | Form constructor. | Overrides EntityForm::buildForm | |
ReactionRuleEditForm::cancel | public | function | Form submission handler for the 'cancel' action. | ||
ReactionRuleEditForm::create | public static | function | Instantiates a new instance of this class. | Overrides RulesComponentFormBase::create | |
ReactionRuleEditForm::form | public | function | Gets the actual form array to be built. | Overrides RulesComponentFormBase::form | |
ReactionRuleEditForm::getTitle | public | function | Title callback: also display the rule label. | ||
ReactionRuleEditForm::prepareEntity | protected | function | Prepares the entity object before the form is built first. | Overrides EntityForm::prepareEntity | |
ReactionRuleEditForm::save | public | function | Form submission handler for the 'save' action. | Overrides EntityForm::save | |
ReactionRuleEditForm::validateForm | public | function | Form validation handler. | Overrides FormBase::validateForm | |
ReactionRuleEditForm::__construct | public | function | Constructs a new object of this class. | Overrides RulesComponentFormBase::__construct | |
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. | ||
RulesComponentFormBase::$expressionManager | protected | property | The Rules expression manager to get expression plugins. | ||
RulesComponentFormBase::entityTagsBuilder | public | function | Callback method for the #entity_builder form property. | ||
RulesComponentFormBase::exists | public | function | Machine name exists callback. | ||
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. |