class DeleteEventForm
Removes an event from a 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\Form\ConfirmFormBase extends \Drupal\Core\Form\FormBase implements \Drupal\Core\Form\ConfirmFormInterface
- class \Drupal\rules\Form\DeleteEventForm extends \Drupal\Core\Form\ConfirmFormBase
- class \Drupal\Core\Form\ConfirmFormBase extends \Drupal\Core\Form\FormBase implements \Drupal\Core\Form\ConfirmFormInterface
Expanded class hierarchy of DeleteEventForm
File
-
src/
Form/ DeleteEventForm.php, line 17
Namespace
Drupal\rules\FormView source
class DeleteEventForm extends ConfirmFormBase {
/**
* The Rules event manager.
*
* @var \Drupal\rules\Core\RulesEventManager
*/
protected $eventManager;
/**
* The RulesUI handler of the currently active UI.
*
* @var \Drupal\rules\Ui\RulesUiHandlerInterface
*/
protected $rulesUiHandler;
/**
* The Reaction Rule being modified.
*
* @var \Drupal\rules\Entity\ReactionRuleConfig
*/
protected $reactionRule;
/**
* The ID of the event in the rule.
*
* @var string
*/
protected $id;
/**
* Constructs a new event delete form.
*
* @param \Drupal\rules\Core\RulesEventManager $event_manager
* The Rules event plugin manager.
*/
public function __construct(RulesEventManager $event_manager) {
$this->eventManager = $event_manager;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container->get('plugin.manager.rules_event'));
}
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'rules_delete_event';
}
/**
* Form constructor.
*
* @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 \Drupal\rules\Ui\RulesUiHandlerInterface $rules_ui_handler
* The RulesUI handler of the currently active UI.
* @param \Drupal\rules\Entity\ReactionRuleConfig $rules_reaction_rule
* The rule config object this form is for.
* @param string $id
* The ID of the event in the rule.
*
* @return array
* The form structure.
*/
public function buildForm(array $form, FormStateInterface $form_state, RulesUiHandlerInterface $rules_ui_handler = NULL, ReactionRuleConfig $rules_reaction_rule = NULL, $id = NULL) {
$this->rulesUiHandler = $rules_ui_handler;
$this->reactionRule = $rules_reaction_rule;
$this->id = $id;
return parent::buildForm($form, $form_state);
}
/**
* {@inheritdoc}
*/
public function getConfirmText() {
return $this->t('Delete');
}
/**
* {@inheritdoc}
*/
public function getQuestion() {
// Do not allow to delete an event if there's only one.
if (count($this->reactionRule
->getEvents()) === 1) {
throw new AccessDeniedHttpException('An event cannot be deleted if the reaction rule has only one.');
}
// Check of the event requested to be deleted, exists.
if (!$this->reactionRule
->hasEvent($this->id)) {
throw new NotFoundHttpException();
}
$event_definition = $this->eventManager
->getDefinition($this->id);
return $this->t('Are you sure you want to delete the event %title from %rule?', [
'%title' => $event_definition['label'],
'%rule' => $this->rulesUiHandler
->getComponentLabel(),
]);
}
/**
* {@inheritdoc}
*/
public function getCancelUrl() {
return $this->rulesUiHandler
->getBaseRouteUrl();
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
$this->reactionRule
->removeEvent($this->id);
$this->reactionRule
->save();
$this->messenger()
->addMessage($this->t('Deleted event %label from %rule.', [
'%label' => $this->eventManager
->getDefinition($this->id)['label'],
'%rule' => $this->reactionRule
->label(),
]));
$form_state->setRedirectUrl($this->getCancelUrl());
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
ConfirmFormBase::getCancelText | public | function | Overrides ConfirmFormInterface::getCancelText | 2 | |
ConfirmFormBase::getDescription | public | function | Overrides ConfirmFormInterface::getDescription | 15 | |
ConfirmFormBase::getFormName | public | function | Overrides ConfirmFormInterface::getFormName | ||
DeleteEventForm::$eventManager | protected | property | The Rules event manager. | ||
DeleteEventForm::$id | protected | property | The ID of the event in the rule. | ||
DeleteEventForm::$reactionRule | protected | property | The Reaction Rule being modified. | ||
DeleteEventForm::$rulesUiHandler | protected | property | The RulesUI handler of the currently active UI. | ||
DeleteEventForm::buildForm | public | function | Form constructor. | Overrides ConfirmFormBase::buildForm | |
DeleteEventForm::create | public static | function | Instantiates a new instance of this class. | Overrides FormBase::create | |
DeleteEventForm::getCancelUrl | public | function | Returns the route to go to if the user cancels the action. | Overrides ConfirmFormInterface::getCancelUrl | |
DeleteEventForm::getConfirmText | public | function | Returns a caption for the button that confirms the action. | Overrides ConfirmFormBase::getConfirmText | |
DeleteEventForm::getFormId | public | function | Returns a unique string identifying the form. | Overrides FormInterface::getFormId | |
DeleteEventForm::getQuestion | public | function | Returns the question to ask the user. | Overrides ConfirmFormInterface::getQuestion | |
DeleteEventForm::submitForm | public | function | Form submission handler. | Overrides FormInterface::submitForm | |
DeleteEventForm::__construct | public | function | Constructs a new event delete form. | ||
DependencySerializationTrait::$_entityStorages | protected | property | |||
DependencySerializationTrait::$_serviceIds | protected | property | |||
DependencySerializationTrait::__sleep | public | function | 1 | ||
DependencySerializationTrait::__wakeup | public | function | 2 | ||
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. | ||
FormBase::validateForm | public | function | Overrides FormInterface::validateForm | 73 | |
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. | ||
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. |