[SOLVED] Wrong country "selected" if FormItCountryOptions snippet is used twice in same form

gadgetto · October 28, 2021, 11:52am

Im using the FormItCountryOptions snippet from FormIt package (latest version) in some registration and update profile pages.

...
<select class="form-control" name="country" id="country">
    <option value="" [[!+upd.country:is=``:then=`selected="selected"`]]>Land wählen</option>
    [[!FormItCountryOptions?
        &selected=`[[!+upd.country]]`
        &prioritized=`[[++country_priorisation]]`
        &limited=`[[++country_limitation]]`
        &country=`de`
   ]]
</select>
.....
...
..
<select class="form-control" name="country2" id="country2">
    <option value="" [[!+upd.country2:is=``:then=`selected="selected"`]]>Land wählen</option>
    [[!FormItCountryOptions?
        &selected=`[[!+upd.country2]]`
        &prioritized=`[[++country_priorisation]]`
        &limited=`[[++country_limitation]]`
        &country=`de`
   ]]
</select>
...

The problem: If the FormItCountryOptions snippet is used twice within the same page/form (e.g. payment address + delivery address), the second snippet call selects the wrong country when the option tags are listed. It always selects the country from the first snippet call.

I tested the correct placeholder content with a hidden field. The placeholder data is correct - only the FormItCountryOptions snippet selects the wrong country.

Any hints on how to prevent/fix this behavior?

BTW, I already filed a bug report on GitHub: Wrong country "selected" if FormItCountryOptions snippet is used twice in same form · Issue #255 · Sterc/FormIt · GitHub

halftrainedharry · October 28, 2021, 12:54pm

As a temporary fix you can add the line

$co->setOption('selected',$modx->getOption('selected',$scriptProperties,''));

before this line in the snippet “FormItCountryOptions”.

github.com

Sterc/FormIt/blob/de51f81a0b7e5c90aee3889d6a5a912e4c407a6d/core/components/formit/elements/snippets/snippet.formitcountryoptions.php#L45

    
      
              null,
              $modx->getOption('core_path', null, MODX_CORE_PATH) . 'components/formit/'
          ) . 'model/formit/';
          $fi = $modx->getService('formit', 'FormIt', $modelPath, $scriptProperties);
          
          
/** @var fiCountryOptions $co */
          $co = $fi->loadModule('fiCountryOptions', 'countryOptions', $scriptProperties);
          $co->initialize();
          $co->getData();
          $co->loadPrioritized();
          $co->iterate();
          return $co->output();

This should fix this issue.

The problem is that for the second call to $fi->loadModule(...) the code determines that the class is already loaded and all the new settings are never used.

github.com

Sterc/FormIt/blob/de51f81a0b7e5c90aee3889d6a5a912e4c407a6d/core/components/formit/src/FormIt.php#L238

    
      
          
          
/**
           * @param string $className
           * @param string $serviceName
           * @param array $config
           *
           * @return Module
           */
          public function loadModule($className, $serviceName, array $config = array())
          {
              if (empty($this->$serviceName)) {
                  $classPath = $this->modx->getOption(
                      'formit.modules_path',
                      null,
                      $this->config['model_path'].'formit/module/'
                  );
          
          
        if ($this->modx->loadClass($className, $classPath, true, true)) {
                      $this->$serviceName = new $className($this, $config);
                  } else {
                      $this->modx->log(

gadgetto · October 28, 2021, 4:46pm

You are great! Works like a charm!
May I post your solution to my FormIt GitHub issue?

Greetings,
Martin

halftrainedharry · October 28, 2021, 5:07pm

Sure, but it’s just a partial fix.

If you had different values for other properties (like &prioritized or &limited etc.) these would be ignored too. So someone with more knowledge of the code has to come up with a real solution.

gadgetto · October 28, 2021, 5:09pm

I’ll post a hint to this forum thread!
Thanks!

system · November 21, 2022, 4:02pm

This topic was automatically closed 2 days after discussion ended and a solution was marked. New replies are no longer allowed. You can open a new topic by clicking the link icon below the original post or solution and selecting “+ New Topic”.