class WebformInvitationForm in Webform Invitation 8

Same name and namespace in other branches

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

Enable or disable invitations for the current webform.

Hierarchy

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

Expanded class hierarchy of WebformInvitationForm

1 string reference to 'WebformInvitationForm'

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

File

src/Form/WebformInvitationForm.php, line 14

Namespace

Drupal\webform_invitation\Form

View source

class WebformInvitationForm extends FormBase {
  use MessengerTrait;

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, WebformInterface $webform = NULL) {
    $elements = $webform
      ->getElementsDecodedAndFlattened();

    // Check if current webform has enabled invitations.
    $enabled = isset($elements['webform_invitation_code']);
    $form['webform_invitation'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Webform Invitation'),
      '#open' => TRUE,
    ];
    $form['webform_invitation']['enable'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable invitations for this webform'),
      '#default_value' => $enabled,
      '#description' => $this
        ->t('If checked, invitations will be enabled for this webform.'),
    ];
    $form['webform'] = [
      '#type' => 'value',
      '#value' => $webform,
    ];
    $form['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Save'),
      '#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');

    // Check if user wants to enable invitations.
    $enable = boolval($form_state
      ->getValue('enable'));
    $elements = $webform
      ->getElementsDecodedAndFlattened();

    // Check if current webform has enabled invitations.
    $enabled = isset($elements['webform_invitation_code']);

    // User wants invitations to be enabled.
    if ($enable) {

      // Only if invitations are not enabled.
      if (!$enabled) {

        // Create new code element.
        $element = [
          'webform_invitation_code' => [
            '#type' => 'textfield',
            '#title' => $this
              ->t('Invitation Code')
              ->render(),
            '#default_value' => '[current-page:query:code:clear]',
            '#description' => $this
              ->t('Enter your personal invitation code (only applies if the field is not populated yet).')
              ->render(),
            '#maxlength' => 64,
            '#required' => TRUE,
          ],
        ];

        // Prepend code element before others.
        $elements = $element + $elements;

        // Save changed elements into webform.
        $webform
          ->setElements($elements);
        $webform
          ->save();
      }
      $this
        ->messenger()
        ->addMessage($this
        ->t('Invitation mode has been activated. You should now <a href="@link">create some invitation codes</a>.', [
        '@link' => Url::fromRoute('entity.webform.invitation_generate', [
          'webform' => $webform
            ->id(),
        ])
          ->toString(),
      ]));
    }
    else {

      // Only if invitations are enabled.
      if ($enabled) {

        // Delete code element from webform.
        $webform
          ->deleteElement('webform_invitation_code');
        $webform
          ->save();
      }
      $this
        ->messenger()
        ->addMessage($this
        ->t('Invitation mode has been disabled.'));
    }
  }

}

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::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create	87
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.
WebformInvitationForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
WebformInvitationForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
WebformInvitationForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm

You are here

class WebformInvitationForm in Webform Invitation 8

Hierarchy

File

Namespace

Members

API Navigation