class NestedConfigTargetForm

Same name in other branches
  1. 11.x core/modules/system/tests/modules/form_test/src/Form/NestedConfigTargetForm.php \Drupal\form_test\Form\NestedConfigTargetForm

Test form for testing config targets that are not 1:1.

Note this is extending TreeConfigTargetForm to ensure that the presence of both 1:1 config targets and ones that aren't work together in the same form.

Hierarchy

Expanded class hierarchy of NestedConfigTargetForm

1 string reference to 'NestedConfigTargetForm'
form_test.routing.yml in core/modules/system/tests/modules/form_test/form_test.routing.yml
core/modules/system/tests/modules/form_test/form_test.routing.yml

File

core/modules/system/tests/modules/form_test/src/Form/NestedConfigTargetForm.php, line 15

Namespace

Drupal\form_test\Form
View source
class NestedConfigTargetForm extends TreeConfigTargetForm {
    
    /**
     * {@inheritdoc}
     */
    protected function getEditableConfigNames() {
        return [
            'form_test.object',
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'form_test_nested_config_target_form';
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state) {
        $form['favorites'] = [
            '#type' => 'details',
            '#open' => TRUE,
            '#tree' => TRUE,
            '#title' => 'Favorite fruits',
        ];
        $form['favorites']['first'] = [
            '#type' => 'textfield',
            '#title' => 'First choice',
            '#config_target' => new ConfigTarget('form_test.object', 'favorite_fruits', fromConfig: fn(?array $favorite_fruits): string => $favorite_fruits[0] ?? 'Mango', toConfig: fn(string $first, FormStateInterface $form_state): array => [
                0 => $first,
                1 => $form_state->getValue([
                    'favorites',
                    'second',
                ]),
            ]),
        ];
        $form['favorites']['second'] = [
            '#type' => 'textfield',
            '#title' => 'Second choice',
            '#config_target' => new ConfigTarget('form_test.object', 'favorite_fruits.1', fn(?string $second_favorite_fruit): string => $second_favorite_fruit ?? 'Orange', fn() => ToConfig::NoOp),
        ];
        $form['could_not_live_without'] = [
            '#weight' => 10,
            '#type' => 'textfield',
            '#title' => 'I could not live without',
            '#placeholder' => 'vegetables',
            '#wrapper_attributes' => [
                'class' => [
                    'container-inline',
                ],
            ],
            '#config_target' => new ConfigTarget('form_test.object', 'could_not_live_without', toConfig: function (string $could_not_live_without, FormStateInterface $form_state) : ToConfig|string {
                if (empty($form_state->getValue([
                    'favorites',
                    'first',
                ]))) {
                    return ToConfig::DeleteKey;
                }
                if (empty($form_state->getValue([
                    'favorites',
                    'second',
                ]))) {
                    return ToConfig::DeleteKey;
                }
                if (empty($form_state->getValue([
                    'vegetables',
                    'favorite',
                ]))) {
                    return ToConfig::DeleteKey;
                }
                if (empty($form_state->getValue([
                    'vegetables',
                    'nemesis',
                ]))) {
                    return ToConfig::DeleteKey;
                }
                return $could_not_live_without;
            }),
            // Only if everything else is answered will this be asked.
'#states' => [
                'visible' => [
                    // 2 favorite fruits.
':input[name="favorites[first]"]' => [
                        'empty' => FALSE,
                    ],
                    ':input[name="favorites[second]"]' => [
                        'empty' => FALSE,
                    ],
                    // Favorite & nemesis vegetable.
':input[name="vegetables[favorite]"]' => [
                        'empty' => FALSE,
                    ],
                    ':input[name="vegetables[nemesis]"]' => [
                        'empty' => FALSE,
                    ],
                ],
            ],
        ];
        return parent::buildForm($form, $form_state);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ConfigFormBase::CONFIG_KEY_TO_FORM_ELEMENT_MAP protected constant The $form_state key which stores a map of config keys to form elements.
ConfigFormBase::copyFormValuesToConfig private static function Copies form values to Config keys.
ConfigFormBase::create public static function Instantiates a new instance of this class. Overrides FormBase::create 18
ConfigFormBase::doStoreConfigMap protected function Helper method for #after_build callback ::storeConfigKeyToFormElementMap().
ConfigFormBase::formatMultipleViolationsMessage protected function Formats multiple violation messages associated with a single form element. 1
ConfigFormBase::loadDefaultValuesFromConfig public function Process callback to recursively load default values from #config_target.
ConfigFormBase::storeConfigKeyToFormElementMap public function #after_build callback which stores a map of element names to config keys.
ConfigFormBase::submitForm public function Form submission handler. Overrides FormInterface::submitForm 24
ConfigFormBase::typedConfigManager protected function Returns the typed config manager service.
ConfigFormBase::validateForm public function Form validation handler. Overrides FormBase::validateForm 13
ConfigFormBase::__construct public function Constructs a \Drupal\system\ConfigFormBase object. 17
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 3
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::configFactory protected function Gets the config factory for this form. 3
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user. 2
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.
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.
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. 16
MessengerTrait::messenger public function Gets the messenger. 16
MessengerTrait::setMessenger public function Sets the messenger.
NestedConfigTargetForm::buildForm public function Form constructor. Overrides TreeConfigTargetForm::buildForm
NestedConfigTargetForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides TreeConfigTargetForm::getEditableConfigNames
NestedConfigTargetForm::getFormId public function Returns a unique string identifying the form. Overrides TreeConfigTargetForm::getFormId
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 2
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. 3
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.
TreeConfigTargetForm::updateOptions public function Updates the options of a select list.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.