class YamlFormResultsExportForm in YAML Form 8

Form for form results export form.

View source

class YamlFormResultsExportForm extends FormBase {

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'yamlform_results_export';
  }

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

  /**
   * Constructs a new YamlFormResultsExportForm object.
   *
   * @param \Drupal\yamlform\YamlFormSubmissionExporterInterface $yamlform_submission_exporter
   *   The form submission exported.
   */
  public function __construct(YamlFormSubmissionExporterInterface $yamlform_submission_exporter) {
    $this->submissionExporter = $yamlform_submission_exporter;
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {

    // Set the merged default (global setting), saved, and user export options
    // into the form's state.
    $settings_options = $this
      ->config('yamlform.settings')
      ->get('export');
    $saved_options = $this->submissionExporter
      ->getYamlFormOptions();
    $user_options = $this->submissionExporter
      ->getValuesFromInput($form_state
      ->getUserInput());
    $export_options = NestedArray::mergeDeep($settings_options, $saved_options, $user_options);

    // Build the form.
    $this->submissionExporter
      ->buildExportOptionsForm($form, $form_state, $export_options);

    // Build actions.
    $form['actions']['#type'] = 'actions';
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Download'),
      '#button_type' => 'primary',
    ];
    $form['actions']['save'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Save settings'),
      '#submit' => [
        '::save',
      ],
    ];
    $form['actions']['delete'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Reset settings'),
      '#attributes' => [
        'class' => [
          'button',
          'button--danger',
        ],
      ],
      '#access' => $saved_options ? TRUE : FALSE,
      '#submit' => [
        '::delete',
      ],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $export_options = $this->submissionExporter
      ->getValuesFromInput($form_state
      ->getValues());

    // Implode exclude columns.
    $export_options['excluded_columns'] = implode(',', $export_options['excluded_columns']);
    if ($source_entity = $this->submissionExporter
      ->getSourceEntity()) {
      $entity_type = $source_entity
        ->getEntityTypeId();
      $entity_id = $source_entity
        ->id();
      $route_parameters = [
        $entity_type => $entity_id,
      ];
      $route_options = [
        'query' => $export_options,
      ];
      $form_state
        ->setRedirect('entity.' . $entity_type . '.yamlform.results_export', $route_parameters, $route_options);
    }
    elseif ($yamlform = $this->submissionExporter
      ->getYamlForm()) {
      $route_parameters = [
        'yamlform' => $yamlform
          ->id(),
      ];
      $route_options = [
        'query' => $export_options,
      ];
      $form_state
        ->setRedirect('entity.yamlform.results_export', $route_parameters, $route_options);
    }
  }

  /**
   * Form save configuration handler.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  public function save(array &$form, FormStateInterface $form_state) {

    // Save the export options to the form's state.
    $export_options = $this->submissionExporter
      ->getValuesFromInput($form_state
      ->getValues());
    $this->submissionExporter
      ->setYamlFormOptions($export_options);
    drupal_set_message($this
      ->t('The download settings have been saved.'));
  }

  /**
   * Form delete configuration handler.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  public function delete(array &$form, FormStateInterface $form_state) {
    $this->submissionExporter
      ->deleteYamlFormOptions();
    drupal_set_message($this
      ->t('The download settings have been reset.'));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
FormBase::$configFactory	protected	property	The config factory.	1
FormBase::$requestStack	protected	property	The request stack.	1
FormBase::$routeMatch	protected	property	The route match.
FormBase::config	protected	function	Retrieves a configuration object.
FormBase::configFactory	protected	function	Gets the config factory for this form.	1
FormBase::container	private	function	Returns the service container.
FormBase::currentUser	protected	function	Gets the current user.
FormBase::getRequest	protected	function	Gets the request object.
FormBase::getRouteMatch	protected	function	Gets the route match.
FormBase::logger	protected	function	Gets the logger for a specific channel.
FormBase::redirect	protected	function	Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory	public	function	Resets the configuration factory.
FormBase::setConfigFactory	public	function	Sets the config factory for this form.
FormBase::setRequestStack	public	function	Sets the request stack object to use.
FormBase::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	62
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.
YamlFormResultsExportForm::$submissionExporter	protected	property	The form submission exporter.
YamlFormResultsExportForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
YamlFormResultsExportForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
YamlFormResultsExportForm::delete	public	function	Form delete configuration handler.
YamlFormResultsExportForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
YamlFormResultsExportForm::save	public	function	Form save configuration handler.
YamlFormResultsExportForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
YamlFormResultsExportForm::__construct	public	function	Constructs a new YamlFormResultsExportForm object.

You are here

class YamlFormResultsExportForm in YAML Form 8

Hierarchy

File

Namespace

Members

API Navigation