class YamlFormResultsExportController in YAML Form 8

Controller routines for form submission export.

Hierarchy

class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\yamlform\Controller\YamlFormResultsExportController implements ContainerInjectionInterface

Expanded class hierarchy of YamlFormResultsExportController

1 file declares its use of YamlFormResultsExportController

yamlform.drush.inc in drush/yamlform.drush.inc: YAML Form module drush commands.

File

src/Controller/YamlFormResultsExportController.php, line 23

Namespace

Drupal\yamlform\Controller

View source

class YamlFormResultsExportController extends ControllerBase implements ContainerInjectionInterface {

  /**
   * The MIME type guesser.
   *
   * @var \Symfony\Component\HttpFoundation\File\MimeType\MimeTypeGuesserInterface
   */
  protected $mimeTypeGuesser;

  /**
   * The form submission exporter.
   *
   * @var \Drupal\yamlform\YamlFormSubmissionExporterInterface
   */
  protected $submissionExporter;

  /**
   * Form request handler.
   *
   * @var \Drupal\yamlform\YamlFormRequestInterface
   */
  protected $requestHandler;

  /**
   * Constructs a new YamlFormResultsExportController object.
   *
   * @param \Symfony\Component\HttpFoundation\File\MimeType\MimeTypeGuesserInterface $mime_type_guesser
   *   The MIME type guesser instance to use.
   * @param \Drupal\yamlform\YamlFormSubmissionExporterInterface $yamlform_submission_exporter
   *   The form submission exported.
   * @param \Drupal\yamlform\YamlFormRequestInterface $request_handler
   *   The form request handler.
   */
  public function __construct(MimeTypeGuesserInterface $mime_type_guesser, YamlFormSubmissionExporterInterface $yamlform_submission_exporter, YamlFormRequestInterface $request_handler) {
    $this->mimeTypeGuesser = $mime_type_guesser;
    $this->submissionExporter = $yamlform_submission_exporter;
    $this->requestHandler = $request_handler;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('file.mime_type.guesser'), $container
      ->get('yamlform_submission.exporter'), $container
      ->get('yamlform.request'));
  }

  /**
   * Returns form submission as a CSV.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The current request.
   *
   * @return array|null|\Symfony\Component\HttpFoundation\RedirectResponse|\Symfony\Component\HttpFoundation\Response
   *   A response that renders or redirects to the CSV file.
   */
  public function index(Request $request) {
    list($yamlform, $source_entity) = $this->requestHandler
      ->getYamlFormEntities();
    $this->submissionExporter
      ->setYamlForm($yamlform);
    $this->submissionExporter
      ->setSourceEntity($source_entity);
    $query = $request->query
      ->all();
    unset($query['destination']);
    if (isset($query['filename'])) {
      $build = $this
        ->formBuilder()
        ->getForm('Drupal\\yamlform\\Form\\YamlFormResultsExportForm');

      // Redirect to file export.
      $file_path = $this->submissionExporter
        ->getFileTempDirectory() . '/' . $query['filename'];
      if (file_exists($file_path)) {
        $route_name = $this->requestHandler
          ->getRouteName($yamlform, $source_entity, 'yamlform.results_export_file');
        $route_parameters = $this->requestHandler
          ->getRouteParameters($yamlform, $source_entity) + [
          'filename' => $query['filename'],
        ];
        $file_url = Url::fromRoute($route_name, $route_parameters, [
          'absolute' => TRUE,
        ])
          ->toString();
        drupal_set_message($this
          ->t('Export creation complete. Your download should begin now. If it does not start, <a href=":href">download the file here</a>. This file may only be downloaded once.', [
          ':href' => $file_url,
        ]));
        $build['#attached']['html_head'][] = [
          [
            '#tag' => 'meta',
            '#attributes' => [
              'http-equiv' => 'refresh',
              'content' => '0; url=' . $file_url,
            ],
          ],
          'yamlform_results_export_download_file_refresh',
        ];
      }
      return $build;
    }
    elseif ($query && empty($query['ajax_form'])) {
      if (!empty($query['excluded_columns']) && is_string($query['excluded_columns'])) {
        $excluded_columns = explode(',', $query['excluded_columns']);
        $query['excluded_columns'] = array_combine($excluded_columns, $excluded_columns);
      }
      $export_options = $query + $this->submissionExporter
        ->getDefaultExportOptions();
      $this->submissionExporter
        ->setExporter($export_options);
      if ($this->submissionExporter
        ->isBatch()) {
        self::batchSet($yamlform, $source_entity, $export_options);
        $route_name = $this->requestHandler
          ->getRouteName($yamlform, $source_entity, 'yamlform.results_export');
        $route_parameters = $this->requestHandler
          ->getRouteParameters($yamlform, $source_entity);
        return batch_process(Url::fromRoute($route_name, $route_parameters));
      }
      else {
        $this->submissionExporter
          ->generate();
        $file_path = $this->submissionExporter
          ->getExportFilePath();
        return $this
          ->downloadFile($file_path, $export_options['download']);
      }
    }
    else {
      return $this
        ->formBuilder()
        ->getForm('Drupal\\yamlform\\Form\\YamlFormResultsExportForm', $yamlform);
    }
  }

  /**
   * Returns form submission results as CSV file.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The current request.
   * @param string $filename
   *   CSV file name.
   *
   * @return array|\Symfony\Component\HttpFoundation\Response
   *   A response that renders or redirects to the CSV file.
   */
  public function file(Request $request, $filename) {
    list($yamlform, $source_entity) = $this->requestHandler
      ->getYamlFormEntities();
    $this->submissionExporter
      ->setYamlForm($yamlform);
    $this->submissionExporter
      ->setSourceEntity($source_entity);
    $file_path = $this->submissionExporter
      ->getFileTempDirectory() . '/' . $filename;
    if (!file_exists($file_path)) {
      $route_name = $this->requestHandler
        ->getRouteName($yamlform, $source_entity, 'yamlform.results_export');
      $route_parameters = $this->requestHandler
        ->getRouteParameters($yamlform, $source_entity);
      $t_args = [
        ':href' => Url::fromRoute($route_name, $route_parameters)
          ->toString(),
      ];
      $build = [
        '#markup' => $this
          ->t('No export file ready for download. The file may have already been downloaded by your browser. Visit the <a href=":href">download export form</a> to create a new export.', $t_args),
      ];
      return $build;
    }
    else {
      return $this
        ->downloadFile($file_path);
    }
  }

  /**
   * Download generated CSV file.
   *
   * @param string $file_path
   *   The paths the generate CSV file.
   * @param bool $download
   *   Download the generated CSV file. Default to TRUE.
   *
   * @return \Symfony\Component\HttpFoundation\Response
   *   A response object containing the CSV file.
   */
  public function downloadFile($file_path, $download = TRUE) {

    // Return the export file.
    $contents = file_get_contents($file_path);
    unlink($file_path);
    $content_type = $this->mimeTypeGuesser
      ->guess($file_path);
    if ($download) {
      $headers = [
        'Content-Length' => strlen($contents),
        'Content-Type' => $content_type,
        'Content-Disposition' => 'attachment; filename="' . basename($file_path) . '"',
      ];
    }
    else {
      if ($content_type != 'text/html') {
        $content_type = 'text/plain';
      }
      $headers = [
        'Content-Length' => strlen($contents),
        'Content-Type' => $content_type . '; charset=utf-8',
      ];
    }
    return new Response($contents, 200, $headers);
  }

  /****************************************************************************/

  // Batch functions.
  // Using static method to prevent the service container from being serialized.
  // "Prevents exception 'AssertionError' with message 'The container was serialized.'."

  /****************************************************************************/

  /**
   * Batch API; Initialize batch operations.
   *
   * @param \Drupal\yamlform\YamlFormInterface|null $yamlform
   *   A form.
   * @param \Drupal\Core\Entity\EntityInterface|null $source_entity
   *   A form source entity.
   * @param array $export_options
   *   An array of export options.
   *
   * @see http://www.jeffgeerling.com/blogs/jeff-geerling/using-batch-api-build-huge-csv
   */
  public static function batchSet(YamlFormInterface $yamlform, EntityInterface $source_entity = NULL, array $export_options) {
    if (!empty($export_options['excluded_columns']) && is_string($export_options['excluded_columns'])) {
      $excluded_columns = explode(',', $export_options['excluded_columns']);
      $export_options['excluded_columns'] = array_combine($excluded_columns, $excluded_columns);
    }

    /** @var \Drupal\yamlform\YamlFormSubmissionExporterInterface $submission_exporter */
    $submission_exporter = \Drupal::service('yamlform_submission.exporter');
    $submission_exporter
      ->setYamlForm($yamlform);
    $submission_exporter
      ->setSourceEntity($source_entity);
    $submission_exporter
      ->setExporter($export_options);
    $parameters = [
      $yamlform,
      $source_entity,
      $export_options,
    ];
    $batch = [
      'title' => t('Exporting submissions'),
      'init_message' => t('Creating export file'),
      'error_message' => t('The export file could not be created because an error occurred.'),
      'operations' => [
        [
          [
            '\\Drupal\\yamlform\\Controller\\YamlFormResultsExportController',
            'batchProcess',
          ],
          $parameters,
        ],
      ],
      'finished' => [
        '\\Drupal\\yamlform\\Controller\\YamlFormResultsExportController',
        'batchFinish',
      ],
    ];
    batch_set($batch);
  }

  /**
   * Batch API callback; Write the header and rows of the export to the export file.
   *
   * @param \Drupal\yamlform\YamlFormInterface $yamlform
   *   The form.
   * @param \Drupal\Core\Entity\EntityInterface|null $source_entity
   *   A form source entity.
   * @param array $export_options
   *   An associative array of export options.
   * @param mixed|array $context
   *   The batch current context.
   */
  public static function batchProcess(YamlFormInterface $yamlform, EntityInterface $source_entity = NULL, array $export_options, &$context) {

    /** @var \Drupal\yamlform\YamlFormSubmissionExporterInterface $submission_exporter */
    $submission_exporter = \Drupal::service('yamlform_submission.exporter');
    $submission_exporter
      ->setYamlForm($yamlform);
    $submission_exporter
      ->setSourceEntity($source_entity);
    $submission_exporter
      ->setExporter($export_options);
    if (empty($context['sandbox'])) {
      $context['sandbox']['progress'] = 0;
      $context['sandbox']['current_sid'] = 0;
      $context['sandbox']['max'] = $submission_exporter
        ->getQuery()
        ->count()
        ->execute();

      // Store entity ids and not the actual yamlform or source entity in the
      // $context to prevent "The container was serialized" errors.
      // @see https://www.drupal.org/node/2822023
      $context['results']['yamlform_id'] = $yamlform
        ->id();
      $context['results']['source_entity_type'] = $source_entity ? $source_entity
        ->getEntityTypeId() : NULL;
      $context['results']['source_entity_id'] = $source_entity ? $source_entity
        ->id() : NULL;
      $context['results']['export_options'] = $export_options;
      $submission_exporter
        ->writeHeader();
    }

    // Write CSV records.
    $query = $submission_exporter
      ->getQuery();
    $query
      ->condition('sid', $context['sandbox']['current_sid'], '>');
    $query
      ->range(0, $submission_exporter
      ->getBatchLimit());
    $entity_ids = $query
      ->execute();
    $yamlform_submissions = YamlFormSubmission::loadMultiple($entity_ids);
    $submission_exporter
      ->writeRecords($yamlform_submissions);

    // Track progress.
    $context['sandbox']['progress'] += count($yamlform_submissions);
    $context['sandbox']['current_sid'] = $yamlform_submissions ? end($yamlform_submissions)
      ->id() : 0;
    $context['message'] = t('Exported @count of @total submissions...', [
      '@count' => $context['sandbox']['progress'],
      '@total' => $context['sandbox']['max'],
    ]);

    // Track finished.
    if ($context['sandbox']['progress'] != $context['sandbox']['max']) {
      $context['finished'] = $context['sandbox']['progress'] / $context['sandbox']['max'];
    }
  }

  /**
   * Batch API callback; Completed export.
   *
   * @param bool $success
   *   TRUE if batch successfully completed.
   * @param array $results
   *   Batch results.
   * @param array $operations
   *   An array of function calls (not used in this function).
   *
   * @return \Symfony\Component\HttpFoundation\RedirectResponse
   *   Redirect to download the exported results.
   */
  public static function batchFinish($success, array $results, array $operations) {
    $yamlform_id = $results['yamlform_id'];
    $entity_type = $results['source_entity_type'];
    $entity_id = $results['source_entity_id'];

    /** @var \Drupal\yamlform\YamlFormInterface $yamlform */
    $yamlform = YamlForm::load($yamlform_id);

    /** @var \Drupal\Core\Entity\EntityInterface|null $source_entity */
    $source_entity = $entity_type && $entity_id ? \Drupal::entityTypeManager()
      ->getStorage($entity_type)
      ->load($entity_id) : NULL;

    /** @var array $export_options */
    $export_options = $results['export_options'];

    /** @var \Drupal\yamlform\YamlFormSubmissionExporterInterface $submission_exporter */
    $submission_exporter = \Drupal::service('yamlform_submission.exporter');
    $submission_exporter
      ->setYamlForm($yamlform);
    $submission_exporter
      ->setSourceEntity($source_entity);
    $submission_exporter
      ->setExporter($export_options);
    if (!$success) {
      $file_path = $submission_exporter
        ->getExportFilePath();
      @unlink($file_path);
      $archive_path = $submission_exporter
        ->getArchiveFilePath();
      @unlink($archive_path);
      drupal_set_message(t('Finished with an error.'));
    }
    else {
      $submission_exporter
        ->writeFooter();
      $filename = $submission_exporter
        ->getExportFileName();
      if ($submission_exporter
        ->isArchive()) {
        $submission_exporter
          ->writeExportToArchive();
        $filename = $submission_exporter
          ->getArchiveFileName();
      }

      /** @var \Drupal\yamlform\YamlFormRequestInterface $request_handler */
      $request_handler = \Drupal::service('yamlform.request');
      $route_name = $request_handler
        ->getRouteName($yamlform, $source_entity, 'yamlform.results_export');
      $route_parameters = $request_handler
        ->getRouteParameters($yamlform, $source_entity);
      $redirect_url = Url::fromRoute($route_name, $route_parameters, [
        'query' => [
          'filename' => $filename,
        ],
        'absolute' => TRUE,
      ]);
      return new RedirectResponse($redirect_url
        ->toString());
    }
  }

}

Members

Name	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::$entityTypeManager	protected	property	The entity type 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.
YamlFormResultsExportController::$mimeTypeGuesser	protected	property	The MIME type guesser.
YamlFormResultsExportController::$requestHandler	protected	property	Form request handler.
YamlFormResultsExportController::$submissionExporter	protected	property	The form submission exporter.
YamlFormResultsExportController::batchFinish	public static	function	Batch API callback; Completed export.
YamlFormResultsExportController::batchProcess	public static	function	Batch API callback; Write the header and rows of the export to the export file.
YamlFormResultsExportController::batchSet	public static	function	Batch API; Initialize batch operations.
YamlFormResultsExportController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
YamlFormResultsExportController::downloadFile	public	function	Download generated CSV file.
YamlFormResultsExportController::file	public	function	Returns form submission results as CSV file.
YamlFormResultsExportController::index	public	function	Returns form submission as a CSV.
YamlFormResultsExportController::__construct	public	function	Constructs a new YamlFormResultsExportController object.

You are here

class YamlFormResultsExportController in YAML Form 8

Hierarchy

File

Namespace

Members

API Navigation