class WebformCompleteSubmissionResource in Webform REST 4.x
Same name and namespace in other branches
- 8.2 src/Plugin/rest/resource/WebformCompleteSubmissionResource.php \Drupal\webform_rest\Plugin\rest\resource\WebformCompleteSubmissionResource
Creates a resource for retrieving webform submission data and fields.
Plugin annotation
@RestResource(
id = "webform_rest_complete_submission",
label = @Translation("Webform submission and fields"),
uri_paths = {
"canonical" = "/webform_rest/{webform_id}/complete_submission/{uuid}"
}
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\rest\Plugin\ResourceBase implements ContainerFactoryPluginInterface, ResourceInterface
- class \Drupal\webform_rest\Plugin\rest\resource\WebformCompleteSubmissionResource
- class \Drupal\rest\Plugin\ResourceBase implements ContainerFactoryPluginInterface, ResourceInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of WebformCompleteSubmissionResource
File
- src/
Plugin/ rest/ resource/ WebformCompleteSubmissionResource.php, line 21
Namespace
Drupal\webform_rest\Plugin\rest\resourceView source
class WebformCompleteSubmissionResource extends ResourceBase {
/**
* The entity type manager object.
*
* @var \Drupal\Core\Entity\EntityTypeManager
*/
protected $entityTypeManager;
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
$instance = parent::create($container, $configuration, $plugin_id, $plugin_definition);
$instance->entityTypeManager = $container
->get('entity_type.manager');
return $instance;
}
/**
* Retrieve webform fields and submission data.
*
* @param string $webform_id
* Webform ID.
* @param string $uuid
* Webform Submission UUID.
*
* @return \Drupal\rest\ModifiedResourceResponse
* HTTP response object containing webform submission.
*
* @throws \Symfony\Component\HttpKernel\Exception\HttpException
* Throws HttpException in case of error.
*/
public function get($webform_id, $uuid) {
if (empty($webform_id) || empty($uuid)) {
$errors = [
'error' => [
'message' => $this
->t('Both webform ID and submission UUID are required.'),
],
];
return new ModifiedResourceResponse($errors, 400);
}
// Get webform submission results from Webform Submission Resource.
$webform_submission = $this->entityTypeManager
->getStorage('webform_submission')
->loadByProperties([
'uuid' => $uuid,
]);
if (empty($webform_submission)) {
$errors = [
'error' => [
'message' => $this
->t('Invalid submission UUID.'),
],
];
return new ModifiedResourceResponse($errors, 400);
}
$webform_submission = reset($webform_submission);
$submissionData = $webform_submission
->getData();
// Get webform fields/structure from Webform Fields Resource.
$webformFieldsResource = new WebformFieldsResource($this->configuration, 'webform_rest_fields', $this->pluginDefinition, $this->serializerFormats, $this->logger);
$fields = $webformFieldsResource
->get($webform_id);
$fieldsData = $fields
->getResponseData();
// Get webform entity.
$webform = Webform::load($webform_id);
// Get webform title.
$title = $webform
->label();
$result = $this
->buildResponse($fieldsData, $submissionData);
return new ModifiedResourceResponse([
'title' => $title,
'processed_submission' => $result,
'webform_submission' => $submissionData,
]);
}
/**
* Create an array from the form field structure and submission.
*
* Fill the fields with the input values.
*
* @return array|null
* Response.
*/
private function buildResponse($fields, $submission) {
$result = $fields;
foreach ($fields as $k => $v) {
if (isset($v['#title']) && isset($v['#type'])) {
$result[$k] = $this
->buildResponse($v, $submission);
$result[$k]['value'] = isset($submission[$v['#webform_key']]) ? $submission[$v['#webform_key']] : NULL;
}
}
return $result;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
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:: |
2 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
ResourceBase:: |
protected | property | A logger instance. | |
ResourceBase:: |
protected | property | The available serialization formats. | |
ResourceBase:: |
public | function |
Returns the available HTTP request methods on this plugin. Overrides ResourceInterface:: |
1 |
ResourceBase:: |
protected | function | Gets the base route for a particular method. | 2 |
ResourceBase:: |
protected | function | Gets the base route requirements for a particular method. | 1 |
ResourceBase:: |
public | function |
Implements ResourceInterface::permissions(). Overrides ResourceInterface:: |
2 |
ResourceBase:: |
protected | function | Provides predefined HTTP request methods. | |
ResourceBase:: |
public | function |
Returns a collection of routes with URL path information for the resource. Overrides ResourceInterface:: |
|
ResourceBase:: |
public | function |
Constructs a Drupal\rest\Plugin\ResourceBase object. Overrides PluginBase:: |
3 |
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. | |
WebformCompleteSubmissionResource:: |
protected | property | The entity type manager object. | |
WebformCompleteSubmissionResource:: |
private | function | Create an array from the form field structure and submission. | |
WebformCompleteSubmissionResource:: |
public static | function |
Creates an instance of the plugin. Overrides ResourceBase:: |
|
WebformCompleteSubmissionResource:: |
public | function | Retrieve webform fields and submission data. |