class WebformCardsConvertForm in Webform 8.5

Same name and namespace in other branches

6.x modules/webform_cards/src/Form/WebformCardsConvertForm.php \Drupal\webform_cards\Form\WebformCardsConvertForm

Form for converting wizard pages to cards.

Hierarchy

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

Expanded class hierarchy of WebformCardsConvertForm

1 string reference to 'WebformCardsConvertForm'

webform_cards.routing.yml in modules/webform_cards/webform_cards.routing.yml: modules/webform_cards/webform_cards.routing.yml

File

modules/webform_cards/src/Form/WebformCardsConvertForm.php, line 14

Namespace

Drupal\webform_cards\Form

View source

class WebformCardsConvertForm extends FormBase {

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, WebformInterface $webform = NULL) {
    $form['#title'] = $this
      ->t('Convert @title wizard pages to cards', [
      '@title' => $webform
        ->label(),
    ]);
    $form['webform_id'] = [
      '#type' => 'value',
      '#value' => $webform
        ->id(),
    ];
    $form['warning'] = [
      '#type' => 'webform_message',
      '#message_message' => $this
        ->t('Please make sure to test the converted webform on a staging server before using cards in production.'),
      '#message_type' => 'warning',
    ];
    $form['description'] = [
      '#markup' => '<p>' . $this
        ->t('Cards provide an almost identical user experience to wizard pages, but moving between cards is much faster. Cards use JavaScript for pagination and client-side validation. Cards also support auto-forwarding with conditional logic.') . '</p>' . '<p><em>' . $this
        ->t('Please note: More complex webform elements may still require server-side validation.') . '</em></p>',
    ];
    $form['hr'] = [
      '#markup' => '<p><hr/></p>',
    ];
    $form['confirm'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t("Please confirm that you want to convert this webform's wizard pages to cards"),
      '#required' => TRUE,
    ];
    $form['actions'] = [
      '#type' => 'actions',
    ];
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Convert'),
      '#button_type' => 'primary',
    ];
    return $form;
  }

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

    /** @var \Drupal\webform\WebformInterface $webform */
    $webform = Webform::load($form_state
      ->getValue('webform_id'));
    $elements = $webform
      ->getElementsRaw();
    $elements = str_replace("'#type': webform_wizard_page", "'#type': webform_card", $elements);
    $webform
      ->setElements(Yaml::decode($elements));
    $webform
      ->save();
    $this
      ->messenger()
      ->addStatus($this
      ->t('Wizard pages have been successfully converted to cards.'));
    $form_state
      ->setRedirectUrl($webform
      ->toUrl('edit-form'));
  }

}

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.
WebformCardsConvertForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
WebformCardsConvertForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
WebformCardsConvertForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm

You are here

class WebformCardsConvertForm in Webform 8.5

Hierarchy

File

Namespace

Members

API Navigation