class WebformInvitationGenerateForm in Webform Invitation 8

Same name and namespace in other branches

2.0.x src/Form/WebformInvitationGenerateForm.php \Drupal\webform_invitation\Form\WebformInvitationGenerateForm

Provides a form to generate invitation codes.

Hierarchy

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

Expanded class hierarchy of WebformInvitationGenerateForm

1 string reference to 'WebformInvitationGenerateForm'

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

File

src/Form/WebformInvitationGenerateForm.php, line 17

Namespace

Drupal\webform_invitation\Form

View source

class WebformInvitationGenerateForm extends FormBase {
  use MessengerTrait;

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

  /**
   * The time service.
   *
   * @var \Drupal\Component\Datetime\TimeInterface
   */
  protected $time;

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

  /**
   * Constructs a new WebformInvitationGenerateForm instance.
   *
   * @param \Drupal\Core\Database\Connection $database
   *   The database connection.
   * @param \Drupal\Component\Datetime\TimeInterface $time
   *   The time service.
   */
  public function __construct(Connection $database, TimeInterface $time) {
    $this->database = $database;
    $this->time = $time;
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, WebformInterface $webform = NULL) {
    $form['webform_invitation'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Webform Invitation'),
      '#open' => TRUE,
    ];
    $form['webform_invitation']['number'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Number of codes to generate'),
      '#min' => 1,
      '#default_value' => 25,
      '#required' => TRUE,
    ];
    $form['webform_invitation']['type'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Type of tokens'),
      '#options' => [
        'md5' => $this
          ->t('MD5 hash (32 characters)'),
        'custom' => $this
          ->t('Custom'),
      ],
      '#default_value' => 'md5',
      '#required' => TRUE,
    ];
    $form['webform_invitation']['length'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Length of tokens (number of characters)'),
      '#min' => 5,
      '#max' => 64,
      '#default_value' => 32,
      '#required' => TRUE,
      '#states' => [
        'invisible' => [
          ':input[name="type"]' => [
            'value' => 'md5',
          ],
        ],
      ],
    ];
    $form['webform_invitation']['chars'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Characters to be used for tokens'),
      '#options' => [
        1 => $this
          ->t('Lower case letters (a-z)'),
        2 => $this
          ->t('Upper case letters (A-Z)'),
        3 => $this
          ->t('Digits (0-9)'),
        4 => $this
          ->t('Punctuation (.,:;-_!?)'),
        5 => $this
          ->t('Special characters (#+*=$%&|)'),
      ],
      '#default_value' => [
        1,
        2,
        3,
      ],
      '#required' => TRUE,
      '#states' => [
        'invisible' => [
          ':input[name="type"]' => [
            'value' => 'md5',
          ],
        ],
      ],
    ];
    $form['webform'] = [
      '#type' => 'value',
      '#value' => $webform,
    ];
    $form['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Generate'),
      '#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();
    $number = $form_state
      ->getValue('number');
    $type = $form_state
      ->getValue('type');
    $length = $form_state
      ->getValue('length');
    $chars = $form_state
      ->getValue('chars');

    // Prepare character set for custom code.
    $set = '';
    if (!empty($chars[1])) {
      $set .= 'abcdefghijklmnopqrstuvwxyz';
    }
    if (!empty($chars[2])) {
      $set .= 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';
    }
    if (!empty($chars[3])) {
      $set .= '0123456789';
    }
    if (!empty($chars[4])) {
      $set .= '.,:;-_!?';
    }
    if (!empty($chars[5])) {
      $set .= '#+*=$%&|';
    }
    $i = $l = 1;

    // Process all requested tokens.
    while ($i <= $number && $l < $number * 10) {
      $code = '';

      // Code generation.
      switch ($type) {
        case 'md5':
          $code = md5(microtime(1) * rand());
          break;
        case 'custom':
          for ($j = 1; $j <= $length; $j++) {
            $code .= $set[rand(0, strlen($set) - 1)];
          }
          break;
      }
      try {

        // Insert code to DB.
        $this->database
          ->insert('webform_invitation_codes')
          ->fields([
          'webform' => $webform_id,
          'code' => $code,
          'created' => $this->time
            ->getRequestTime(),
        ])
          ->execute();
        $i++;
      } catch (\Exception $e) {

        // The generated code is already in DB, make another one.
      }
      $l++;
    }

    // Output number of generated codes.
    $codes_count = $i - 1;
    if ($l >= $number * 10) {
      $this
        ->messenger()
        ->addMessage($this
        ->t('Due to unique constraint, only @ccount codes have been generated.', [
        '@ccount' => $codes_count,
      ]), 'error');
    }
    elseif ($codes_count == 1) {
      $this
        ->messenger()
        ->addMessage($this
        ->t('A single code has been generated.'));
    }
    else {
      $this
        ->messenger()
        ->addMessage($this
        ->t('A total of @ccount codes has been generated.', [
        '@ccount' => $codes_count,
      ]));
    }

    // Redirect user to list of codes.
    $form_state
      ->setRedirect('entity.webform.invitation_codes', [
      'webform' => $webform_id,
    ]);
  }

}

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

You are here

class WebformInvitationGenerateForm in Webform Invitation 8

Hierarchy

File

Namespace

Members

API Navigation