class DisplayErrorMessageOnForm in Business Rules 2.x
Same name and namespace in other branches
- 8 src/Plugin/BusinessRulesAction/DisplayErrorMessageOnForm.php \Drupal\business_rules\Plugin\BusinessRulesAction\DisplayErrorMessageOnForm
Class ValidateFormField.
@package Drupal\business_rules\Plugin\BusinessRulesAction
Plugin annotation
@BusinessRulesAction(
id = "display_error_message_on_form",
label = @Translation("Display error message in a form"),
group = @Translation("Entity"),
description = @Translation("Generates a validation error in an entity form."),
reactsOnIds = {"form_validation"},
isContextDependent = TRUE,
hasTargetEntity = TRUE,
hasTargetBundle = TRUE,
hasTargetField = TRUE,
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\business_rules\Plugin\BusinessRulesItemPluginBase implements BusinessRulesItemPluginInterface
- class \Drupal\business_rules\Plugin\BusinessRulesActionPlugin implements BusinessRulesActionPluginInterface
- class \Drupal\business_rules\Plugin\BusinessRulesAction\DisplayErrorMessageOnForm
- class \Drupal\business_rules\Plugin\BusinessRulesActionPlugin implements BusinessRulesActionPluginInterface
- class \Drupal\business_rules\Plugin\BusinessRulesItemPluginBase implements BusinessRulesItemPluginInterface
Expanded class hierarchy of DisplayErrorMessageOnForm
File
- src/
Plugin/ BusinessRulesAction/ DisplayErrorMessageOnForm.php, line 29
Namespace
Drupal\business_rules\Plugin\BusinessRulesActionView source
class DisplayErrorMessageOnForm extends BusinessRulesActionPlugin {
/**
* {@inheritdoc}
*/
public function getSettingsForm(array &$form, FormStateInterface $form_state, ItemInterface $item) {
$settings['message'] = [
'#type' => 'textarea',
'#title' => t('Message'),
'#description' => t('To use variables on the message, just type the variable machine name as {{variable_id}}.'),
'#required' => TRUE,
'#default_value' => $item
->getSettings('message'),
];
return $settings;
}
/**
* {@inheritdoc}
*/
public function execute(ActionInterface $action, BusinessRulesEvent $event) {
if (!empty($event['form_state'])) {
$field = $action
->getSettings('field');
$message = nl2br($action
->getSettings('message'));
$variables = $event
->getArgument('variables');
$message = $this
->processVariables($message, $variables);
$message = new FormattableMarkup($message, []);
/** @var \Drupal\Core\Form\FormStateInterface $form_state */
$form_state = $event
->getArgument('form_state');
$form_state
->setErrorByName($field, $message);
$result = [
'#type' => 'markup',
'#markup' => t('Error set on form. Field: %field, message: %message', [
'%field' => $field,
'%message' => $message,
]),
];
return $result;
}
}
}