You are here

Home » API reference » Webform 8.5 » WebformSubmissionExportImportController.php

class WebformSubmissionExportImportController in Webform 8.5

Same name and namespace in other branches
  1. 6.x modules/webform_submission_export_import/src/Controller/WebformSubmissionExportImportController.php \Drupal\webform_submission_export_import\Controller\WebformSubmissionExportImportController

Provides route responses for webform submission export/import.

Hierarchy

Expanded class hierarchy of WebformSubmissionExportImportController

File

modules/webform_submission_export_import/src/Controller/WebformSubmissionExportImportController.php, line 18

Namespace

Drupal\webform_submission_export_import\Controller
View source 
class WebformSubmissionExportImportController extends ControllerBase implements ContainerInjectionInterface {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The webform submission storage.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $webformSubmissionStorage;

  /**
   * The webform request handler.
   *
   * @var \Drupal\webform\WebformRequestInterface
   */
  protected $requestHandler;

  /**
   * The webform submission generation service.
   *
   * @var \Drupal\webform\WebformSubmissionGenerateInterface
   */
  protected $generate;

  /**
   * The webform submission exporter.
   *
   * @var \Drupal\webform_submission_export_import\WebformSubmissionExportImportImporterInterface
   */
  protected $importer;

  /**
   * Constructs a WebformSubmissionExportImportController object.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\webform\WebformRequestInterface $request_handler
   *   The webform request handler.
   * @param \Drupal\webform\WebformSubmissionGenerateInterface $submission_generate
   *   The webform submission generation service.
   * @param \Drupal\webform_submission_export_import\WebformSubmissionExportImportImporterInterface $importer
   *   The webform submission importer.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager, WebformRequestInterface $request_handler, WebformSubmissionGenerateInterface $submission_generate, WebformSubmissionExportImportImporterInterface $importer) {
    $this->entityTypeManager = $entity_type_manager;
    $this->webformSubmissionStorage = $entity_type_manager
      ->getStorage('webform_submission');
    $this->requestHandler = $request_handler;
    $this->generate = $submission_generate;
    $this->importer = $importer;

    // Initialize the importer.
    $webform = $this->requestHandler
      ->getCurrentWebform();
    $source_entity = $this->requestHandler
      ->getCurrentSourceEntity();
    $this->importer
      ->setWebform($webform);
    $this->importer
      ->setSourceEntity($source_entity);
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('entity_type.manager'), $container
      ->get('webform.request'), $container
      ->get('webform_submission.generate'), $container
      ->get('webform_submission_export_import.importer'));
  }

  /**
   * Returns the Webform submission export example CSV view.
   */
  public function view() {
    return $this
      ->createResponse(FALSE);
  }

  /**
   * Returns the Webform submission export example CSV download.
   */
  public function download() {
    return $this
      ->createResponse(TRUE);
  }

  /**
   * Create a response containing submission CSV example.
   *
   * @param bool $download
   *   TRUE is response should be downloaded.
   *
   * @return \Symfony\Component\HttpFoundation\Response
   *   A response containing submission CSV example.
   */
  protected function createResponse($download = FALSE) {
    $webform = $this->importer
      ->getWebform();

    // From: http://obtao.com/blog/2013/12/export-data-to-a-csv-file-with-symfony/
    $response = new StreamedResponse(function () {
      $handle = fopen('php://output', 'r+');
      $header = $this->importer
        ->exportHeader();
      fputcsv($handle, $header);
      for ($i = 1; $i <= 3; $i++) {
        $webform_submission = $this
          ->generateSubmission($i);
        $record = $this->importer
          ->exportSubmission($webform_submission);
        fputcsv($handle, $record);
      }
      fclose($handle);
    });
    $response->headers
      ->set('Content-Type', $download ? 'text/csv' : 'text/plain');
    $response->headers
      ->set('Content-Disposition', ($download ? 'attachment' : 'inline') . '; filename=' . $webform
      ->id() . '.csv');
    return $response;
  }

  /**
   * Generate an unsaved webform submission.
   *
   * @param int $index
   *   The submission's index used for the sid and serial number.
   *
   * @return \Drupal\webform\WebformSubmissionInterface
   *   An unsaved webform submission.
   */
  protected function generateSubmission($index) {
    $webform = $this->requestHandler
      ->getCurrentWebform();
    $source_entity = $this->requestHandler
      ->getCurrentSourceEntity();
    $users = $this->entityTypeManager
      ->getStorage('user')
      ->getQuery()
      ->execute();
    $uid = array_rand($users);
    $url = $webform
      ->toUrl();
    if ($source_entity && $source_entity
      ->hasLinkTemplate('canonical')) {
      $url = $source_entity
        ->toUrl();
    }
    return $this->webformSubmissionStorage
      ->create([
      'sid' => $index,
      'serial' => $index,
      'webform_id' => $webform
        ->id(),
      'entity_type' => $source_entity ? $source_entity
        ->getEntityTypeId() : '',
      'entity_id' => $source_entity ? $source_entity
        ->id() : '',
      'uid' => $uid,
      'remote_addr' => mt_rand(0, 255) . '.' . mt_rand(0, 255) . '.' . mt_rand(0, 255) . '.' . mt_rand(0, 255),
      'uri' => preg_replace('#^' . base_path() . '#', '/', $url
        ->toString()),
      'data' => Yaml::encode($this->generate
        ->getData($webform)),
      'created' => strtotime('-1 year'),
      'completed' => rand(strtotime('-1 year'), time()),
      'changed' => time(),
    ]);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityManager protected property The entity manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityManager Deprecated protected function Retrieves the entity manager service.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state protected function Returns the state storage service.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
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. 29
MessengerTrait::messenger public function Gets the messenger. 29
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. 1
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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.
WebformSubmissionExportImportController::$entityTypeManager protected property The entity type manager. Overrides ControllerBase::$entityTypeManager
WebformSubmissionExportImportController::$generate protected property The webform submission generation service.
WebformSubmissionExportImportController::$importer protected property The webform submission exporter.
WebformSubmissionExportImportController::$requestHandler protected property The webform request handler.
WebformSubmissionExportImportController::$webformSubmissionStorage protected property The webform submission storage.
WebformSubmissionExportImportController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
WebformSubmissionExportImportController::createResponse protected function Create a response containing submission CSV example.
WebformSubmissionExportImportController::download public function Returns the Webform submission export example CSV download.
WebformSubmissionExportImportController::generateSubmission protected function Generate an unsaved webform submission.
WebformSubmissionExportImportController::view public function Returns the Webform submission export example CSV view.
WebformSubmissionExportImportController::__construct public function Constructs a WebformSubmissionExportImportController object.