class WebformDevelSubmissionApiForm in Webform 6.x
Same name and namespace in other branches
- 8.5 modules/webform_devel/src/Form/WebformDevelSubmissionApiForm.php \Drupal\webform_devel\Form\WebformDevelSubmissionApiForm
Form used to test programmatic submissions of webforms.
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\webform_devel\Form\WebformDevelSubmissionApiForm uses WebformEntityStorageTrait
Expanded class hierarchy of WebformDevelSubmissionApiForm
1 string reference to 'WebformDevelSubmissionApiForm'
- webform_devel.routing.yml in modules/
webform_devel/ webform_devel.routing.yml - modules/webform_devel/webform_devel.routing.yml
File
- modules/
webform_devel/ src/ Form/ WebformDevelSubmissionApiForm.php, line 17
Namespace
Drupal\webform_devel\FormView source
class WebformDevelSubmissionApiForm extends FormBase {
use WebformEntityStorageTrait;
/**
* The webform request handler.
*
* @var \Drupal\webform\WebformRequestInterface
*/
protected $requestHandler;
/**
* The webform submission generation service.
*
* @var \Drupal\webform\WebformSubmissionGenerateInterface
*/
protected $generate;
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
$instance = parent::create($container);
$instance->entityTypeManager = $container
->get('entity_type.manager');
$instance->requestHandler = $container
->get('webform.request');
$instance->generate = $container
->get('webform_submission.generate');
return $instance;
}
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'webform_devel_submission_api_form';
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state) {
/** @var \Drupal\webform\WebformInterface $webform */
/** @var \Drupal\Core\Entity\EntityInterface $source_entity */
list($webform, $source_entity) = $this->requestHandler
->getWebformEntities();
$values = [];
// Set webform id.
$values['webform_id'] = $webform
->id();
// Set source entity type and id.
if ($source_entity) {
$values['entity_type'] = $source_entity
->getEntityTypeId();
$values['entity_id'] = $source_entity
->id();
}
WebformSubmission::preCreate($this
->getSubmissionStorage(), $values);
// Generate data as last value.
unset($values['data']);
$values['data'] = $this->generate
->getData($webform);
$form['submission'] = [
'#type' => 'details',
'#title' => $this
->t('Submission values'),
'#open' => TRUE,
];
$form['submission']['message'] = [
'#type' => 'webform_message',
'#message_message' => $this
->t("Submitting the below values will trigger the %title webform's ::validateFormValues() and ::submitFormValues() callbacks.", [
'%title' => $webform
->label(),
]),
'#message_type' => 'warning',
];
$form['submission']['values'] = [
'#type' => 'webform_codemirror',
'#mode' => 'yaml',
'#title' => $this
->t('Values'),
'#title_display' => 'hidden',
'#default_value' => $values,
];
$form['php'] = [
'#type' => 'details',
'#title' => $this
->t('PHP usage'),
'#description' => $this
->t('Below is an example of how to programatically validate and submit a webform submission using PHP.'),
];
$form['php']['code'] = [
'#type' => 'webform_codemirror',
'#mode' => 'php',
'#title' => $this
->t('PHP'),
'#title_display' => 'hidden',
'#attributes' => [
'readonly' => 'readonly',
'disabled' => 'disabled',
],
'#default_value' => '
// Get submission values and data.
$values = ' . Variable::export($values) . ';
// Check that the webform is open.
$webform = \\Drupal\\webform\\entity\\Webform::load(\'' . $webform
->id() . '\');
$is_open = \\Drupal\\webform\\WebformSubmissionForm::isOpen($webform);
if ($is_open === TRUE) {
// Validate webform submission values.
$errors = \\Drupal\\webform\\WebformSubmissionForm::validateFormValues($values);
// Submit webform submission values.
if (empty($errors)) {
$webform_submission = \\Drupal\\webform\\WebformSubmissionForm::submitFormValues($values);
}
}',
];
$form['actions'] = [];
$form['actions']['submit'] = [
'#type' => 'submit',
'#value' => $this
->t('Submit'),
];
return $form;
}
/**
* {@inheritdoc}
*/
public function validateForm(array &$form, FormStateInterface $form_state) {
$values = $form_state
->getValue('values');
// Check if the webform is open to new submissions.
$webform = Webform::load($values['webform_id']);
if (!$webform) {
$form_state
->setErrorByName('values', $this
->t('Webform %webform_id not found.', [
'%webform_id' => $values['webform_id'],
]));
return;
}
$is_open = WebformSubmissionForm::isOpen($webform);
if ($is_open !== TRUE) {
$form_state
->setErrorByName('values', $is_open);
}
// Validate values.
if ($errors = WebformSubmissionForm::validateFormValues($values)) {
foreach ($errors as $error) {
$form_state
->setErrorByName('values', $error);
}
}
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
$values = $form_state
->getValue('values');
$webform_submission = WebformSubmissionForm::submitFormValues($values);
$this
->messenger()
->addStatus($this
->t('New submission %title added.', [
'%title' => $webform_submission
->label(),
]));
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
FormBase:: |
protected | property | The config factory. | 3 |
FormBase:: |
protected | property | The request stack. | 1 |
FormBase:: |
protected | property | The route match. | |
FormBase:: |
protected | function | Retrieves a configuration object. | |
FormBase:: |
protected | function | Gets the config factory for this form. | 3 |
FormBase:: |
private | function | Returns the service container. | |
FormBase:: |
protected | function | Gets the current user. | |
FormBase:: |
protected | function | Gets the request object. | |
FormBase:: |
protected | function | Gets the route match. | |
FormBase:: |
protected | function | Gets the logger for a specific channel. | |
FormBase:: |
protected | function | Returns a redirect response object for the specified route. | |
FormBase:: |
public | function | Resets the configuration factory. | |
FormBase:: |
public | function | Sets the config factory for this form. | |
FormBase:: |
public | function | Sets the request stack object to use. | |
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
MessengerTrait:: |
public | function | Sets the messenger. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
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. | |
WebformDevelSubmissionApiForm:: |
protected | property | The webform submission generation service. | |
WebformDevelSubmissionApiForm:: |
protected | property | The webform request handler. | |
WebformDevelSubmissionApiForm:: |
public | function |
Form constructor. Overrides FormInterface:: |
|
WebformDevelSubmissionApiForm:: |
public static | function |
Instantiates a new instance of this class. Overrides FormBase:: |
|
WebformDevelSubmissionApiForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
WebformDevelSubmissionApiForm:: |
public | function |
Form submission handler. Overrides FormInterface:: |
|
WebformDevelSubmissionApiForm:: |
public | function |
Form validation handler. Overrides FormBase:: |
|
WebformEntityStorageTrait:: |
protected | property | An associate array of entity type storage aliases. | |
WebformEntityStorageTrait:: |
protected | property | The entity type manager. | 5 |
WebformEntityStorageTrait:: |
protected | function | Retrieves the entity storage. | |
WebformEntityStorageTrait:: |
protected | function | Retrieves the webform submission storage. | |
WebformEntityStorageTrait:: |
protected | function | Retrieves the webform storage. | |
WebformEntityStorageTrait:: |
public | function | Implements the magic __get() method. |