class WebformInvitationDownloadForm in Webform Invitation 8

Allows to download the list of generated codes.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\webform_invitation\Form\WebformInvitationDownloadForm

1 string reference to 'WebformInvitationDownloadForm'

webform_invitation.routing.yml in ./webform_invitation.routing.yml

webform_invitation.routing.yml

File

src/Form/WebformInvitationDownloadForm.php, line 15

Namespace

Drupal\webform_invitation\Form

class WebformInvitationDownloadForm extends FormBase {

  /**
   * The database connection.
   *
   * @var \Drupal\Core\Database\Connection
   */
  protected $database;

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

  /**
   * Constructs a new WebformInvitationDownloadForm instance.
   *
   * @param \Drupal\Core\Database\Connection $database
   *   The database connection.
   */
  public function __construct(Connection $database) {
    $this->database = $database;
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, WebformInterface $webform = NULL) {
    $form['webform'] = [
      '#type' => 'value',
      '#value' => $webform,
    ];
    $form['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Download'),
      '#button_type' => 'primary',
    ];
    return $form;
  }

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

    /** @var \Drupal\webform\Entity\Webform $webform */
    $webform = $form_state
      ->getValue('webform');
    $webform_id = $webform
      ->id();

    // Get all not used codes from DB table.
    $query = $this->database
      ->select('webform_invitation_codes', 'c')
      ->fields('c');
    $query
      ->condition('webform', $webform_id);
    $query
      ->condition('used', 0);
    $codes = $query
      ->execute();

    // This is the XLS header.
    $xlshead = pack("s*", 0x809, 0x8, 0x0, 0x10, 0x0, 0x0);

    // This is the XLS footer.
    $xlsfoot = pack("s*", 0xa, 0x0);
    $data = '';
    $row = 0;

    // Process all codes as rows into file.
    while ($code = $codes
      ->fetchAssoc()) {
      $url = Url::fromRoute('entity.webform.canonical', [
        'webform' => $webform_id,
      ], [
        'query' => [
          'code' => $code['code'],
        ],
        'absolute' => TRUE,
      ])
        ->toString();
      $data .= $this
        ->xlsCell($row, 0, $url);
      $row++;
    }

    // Provide file directly for download.
    $filename = 'webform-invitation-codes-' . $webform_id . '.xls';
    header('Content-Type: application/force-download');
    header('Content-Type: application/octet-stream');
    header('Content-Type: application/download');
    header('Content-Disposition: attachment;filename=' . $filename);
    header('Content-Transfer-Encoding: binary');
    echo $xlshead . $data . $xlsfoot;

    // This is important.
    exit;
  }

  /**
   * Format single cell.
   */
  private function xlsCell($row, $col, $val) {
    $len = strlen($val);
    return pack("s*", 0x204, 8 + $len, $row, $col, 0x0, $len) . $val;
  }

}

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.
WebformInvitationDownloadForm::$database	protected	property	The database connection.
WebformInvitationDownloadForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
WebformInvitationDownloadForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
WebformInvitationDownloadForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
WebformInvitationDownloadForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
WebformInvitationDownloadForm::xlsCell	private	function	Format single cell.
WebformInvitationDownloadForm::__construct	public	function	Constructs a new WebformInvitationDownloadForm instance.