class TestYamlFormHandler in YAML Form 8
Form submission test handler.
Plugin annotation
@YamlFormHandler(
id = "test",
label = @Translation("Test"),
category = @Translation("Testing"),
description = @Translation("Tests form submission handler behaviors."),
cardinality = \Drupal\yamlform\YamlFormHandlerInterface::CARDINALITY_SINGLE,
results = \Drupal\yamlform\YamlFormHandlerInterface::RESULTS_IGNORED,
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\yamlform\YamlFormHandlerBase implements YamlFormHandlerInterface
- class \Drupal\yamlform_test\Plugin\YamlFormHandler\TestYamlFormHandler
- class \Drupal\yamlform\YamlFormHandlerBase implements YamlFormHandlerInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of TestYamlFormHandler
File
- tests/
modules/ yamlform_test/ src/ Plugin/ YamlFormHandler/ TestYamlFormHandler.php, line 22
Namespace
Drupal\yamlform_test\Plugin\YamlFormHandlerView source
class TestYamlFormHandler extends YamlFormHandlerBase {
/**
* {@inheritdoc}
*/
public function defaultConfiguration() {
return [
'message' => 'One two one two this is just a test',
];
}
/**
* {@inheritdoc}
*/
public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
$form['message'] = [
'#type' => 'textfield',
'#title' => $this
->t('Message'),
'#default_value' => $this->configuration['message'],
'#required' => TRUE,
];
return $form;
}
/**
* {@inheritdoc}
*/
public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
parent::submitConfigurationForm($form, $form_state);
$this->configuration['message'] = $form_state
->getValue('message');
}
/**
* {@inheritdoc}
*/
public function alterElements(array &$elements, YamlFormInterface $yamlform) {
$this
->displayMessage(__FUNCTION__);
}
/**
* {@inheritdoc}
*/
public function alterForm(array &$form, FormStateInterface $form_state, YamlFormSubmissionInterface $yamlform_submission) {
$this
->displayMessage(__FUNCTION__);
}
/**
* {@inheritdoc}
*/
public function validateForm(array &$form, FormStateInterface $form_state, YamlFormSubmissionInterface $yamlform_submission) {
$this
->displayMessage(__FUNCTION__);
if ($value = $form_state
->getValue('element')) {
$form_state
->setErrorByName('element', $this
->t('The element must be empty. You entered %value.', [
'%value' => $value,
]));
}
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state, YamlFormSubmissionInterface $yamlform_submission) {
$this
->displayMessage(__FUNCTION__);
}
/**
* {@inheritdoc}
*/
public function confirmForm(array &$form, FormStateInterface $form_state, YamlFormSubmissionInterface $yamlform_submission) {
drupal_set_message($this->configuration['message'], 'status', TRUE);
\Drupal::logger('yamlform.test')
->notice($this->configuration['message']);
$this
->displayMessage(__FUNCTION__);
}
/**
* {@inheritdoc}
*/
public function preCreate(array $values) {
$this
->displayMessage(__FUNCTION__);
}
/**
* {@inheritdoc}
*/
public function postCreate(YamlFormSubmissionInterface $yamlform_submission) {
$this
->displayMessage(__FUNCTION__);
}
/**
* {@inheritdoc}
*/
public function postLoad(YamlFormSubmissionInterface $yamlform_submission) {
$this
->displayMessage(__FUNCTION__);
}
/**
* {@inheritdoc}
*/
public function preDelete(YamlFormSubmissionInterface $yamlform_submission) {
$this
->displayMessage(__FUNCTION__);
}
/**
* {@inheritdoc}
*/
public function postDelete(YamlFormSubmissionInterface $yamlform_submission) {
$this
->displayMessage(__FUNCTION__);
}
/**
* {@inheritdoc}
*/
public function preSave(YamlFormSubmissionInterface $yamlform_submission) {
$this
->displayMessage(__FUNCTION__);
}
/**
* {@inheritdoc}
*/
public function postSave(YamlFormSubmissionInterface $yamlform_submission, $update = TRUE) {
$this
->displayMessage(__FUNCTION__, $update ? 'update' : 'insert');
}
/**
* Display the invoked plugin method to end user.
*
* @param string $method_name
* The invoked method name.
* @param string $context1
* Additional parameter passed to the invoked method name.
*/
protected function displayMessage($method_name, $context1 = NULL) {
if (PHP_SAPI != 'cli') {
$t_args = [
'@class_name' => get_class($this),
'@method_name' => $method_name,
'@context1' => $context1,
];
drupal_set_message($this
->t('Invoked: @class_name:@method_name @context1', $t_args), 'status', TRUE);
\Drupal::logger('yamlform.test')
->notice('Invoked: @class_name:@method_name @context1', $t_args);
}
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
TestYamlFormHandler:: |
public | function |
Alter form submission form elements. Overrides YamlFormHandlerBase:: |
|
TestYamlFormHandler:: |
public | function |
Alter form submission form . Overrides YamlFormHandlerBase:: |
|
TestYamlFormHandler:: |
public | function |
Form constructor. Overrides YamlFormHandlerBase:: |
|
TestYamlFormHandler:: |
public | function |
Confirm form submission form. Overrides YamlFormHandlerBase:: |
|
TestYamlFormHandler:: |
public | function |
Gets default configuration for this plugin. Overrides YamlFormHandlerBase:: |
|
TestYamlFormHandler:: |
protected | function | Display the invoked plugin method to end user. | |
TestYamlFormHandler:: |
public | function |
Acts on a form submission after it is created. Overrides YamlFormHandlerBase:: |
|
TestYamlFormHandler:: |
public | function |
Acts on deleted a form submission before the delete hook is invoked. Overrides YamlFormHandlerBase:: |
|
TestYamlFormHandler:: |
public | function |
Acts on loaded form submission. Overrides YamlFormHandlerBase:: |
|
TestYamlFormHandler:: |
public | function |
Acts on a saved form submission before the insert or update hook is invoked. Overrides YamlFormHandlerBase:: |
|
TestYamlFormHandler:: |
public | function |
Changes the values of an entity before it is created. Overrides YamlFormHandlerBase:: |
|
TestYamlFormHandler:: |
public | function |
Acts on a form submission before they are deleted and before hooks are invoked. Overrides YamlFormHandlerBase:: |
|
TestYamlFormHandler:: |
public | function |
Acts on a form submission before the presave hook is invoked. Overrides YamlFormHandlerBase:: |
|
TestYamlFormHandler:: |
public | function |
Form submission handler. Overrides YamlFormHandlerBase:: |
|
TestYamlFormHandler:: |
public | function |
Submit form submission form. Overrides YamlFormHandlerBase:: |
|
TestYamlFormHandler:: |
public | function |
Validate form submission form . Overrides YamlFormHandlerBase:: |
|
YamlFormHandlerBase:: |
protected | property | The form handler ID. | |
YamlFormHandlerBase:: |
protected | property | The form handler label. | |
YamlFormHandlerBase:: |
protected | property | A logger instance. | |
YamlFormHandlerBase:: |
protected | property | The form handler status. | |
YamlFormHandlerBase:: |
protected | property | The weight of the form handler. | |
YamlFormHandlerBase:: |
protected | property | The form . | |
YamlFormHandlerBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides DependentPluginInterface:: |
|
YamlFormHandlerBase:: |
public | function |
Returns the form handler cardinality settings. Overrides YamlFormHandlerInterface:: |
|
YamlFormHandlerBase:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
2 |
YamlFormHandlerBase:: |
public | function |
Returns the form handler description. Overrides YamlFormHandlerInterface:: |
|
YamlFormHandlerBase:: |
public | function |
Gets this plugin's configuration. Overrides ConfigurablePluginInterface:: |
|
YamlFormHandlerBase:: |
public | function |
Returns the unique ID representing the form handler. Overrides YamlFormHandlerInterface:: |
|
YamlFormHandlerBase:: |
public | function |
Returns the label of the form handler. Overrides YamlFormHandlerInterface:: |
|
YamlFormHandlerBase:: |
public | function |
Returns the status of the form handler. Overrides YamlFormHandlerInterface:: |
|
YamlFormHandlerBase:: |
public | function |
Returns a render array summarizing the configuration of the form handler. Overrides YamlFormHandlerInterface:: |
2 |
YamlFormHandlerBase:: |
public | function |
Returns the weight of the form handler. Overrides YamlFormHandlerInterface:: |
|
YamlFormHandlerBase:: |
public | function | Get the form that this handler is attached to. | |
YamlFormHandlerBase:: |
public | function | Initialize form handler. | |
YamlFormHandlerBase:: |
public | function |
Returns the form handler disabled indicator. Overrides YamlFormHandlerInterface:: |
|
YamlFormHandlerBase:: |
public | function |
Returns the form handler enabled indicator. Overrides YamlFormHandlerInterface:: |
1 |
YamlFormHandlerBase:: |
public | function |
Returns the form handler label. Overrides YamlFormHandlerInterface:: |
|
YamlFormHandlerBase:: |
public | function |
Sets the configuration for this plugin instance. Overrides ConfigurablePluginInterface:: |
|
YamlFormHandlerBase:: |
public | function |
Sets the id for this form handler. Overrides YamlFormHandlerInterface:: |
|
YamlFormHandlerBase:: |
public | function |
Sets the label for this form handler. Overrides YamlFormHandlerInterface:: |
|
YamlFormHandlerBase:: |
public | function |
Sets the status for this form handler. Overrides YamlFormHandlerInterface:: |
|
YamlFormHandlerBase:: |
public | function |
Sets the weight for this form handler. Overrides YamlFormHandlerInterface:: |
|
YamlFormHandlerBase:: |
public | function |
Form validation handler. Overrides PluginFormInterface:: |
|
YamlFormHandlerBase:: |
public | function |
Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase:: |
2 |
YamlFormHandlerInterface:: |
constant | Value indicating a single plugin instances are permitted. | ||
YamlFormHandlerInterface:: |
constant | Value indicating unlimited plugin instances are permitted. | ||
YamlFormHandlerInterface:: |
constant | Value indicating form submissions are not processed (ie email or saved) by the handler. | ||
YamlFormHandlerInterface:: |
constant | Value indicating form submissions are processed (ie email or saved) by the handler. |