Clean up/refactor DevelFormHelperTrait and ModalFormHelperTrait

Problem/Motivation

After #3188474: Move the config_enforce form to an off-canvas dialog, we can refactor our form helper traits to simplify them.

Specifically, ModalFormHelperTrait and DevelFormHelperTrait.

This issue is only for Config Enforce Devel, the Config Enforce issue is: #3556977: Clean up/refactor FormHelperTrait.

Proposed resolution

Delete unused code in 2.x, deprecate in 1.x.

Classes that will be refactored in some way

• Drupal\config_enforce_devel\Form\DevelFormHelperTrait (suggesting we consider trimming this down for now, since it's used by two form classes that won't be deleted)
  • Drupal\config_enforce_devel\Form\AddModuleForm (used indirectly via ModalFormHelperTrait, first step will be to bring it in as a direct use)
  • Drupal\config_enforce_devel\Form\EnforcedConfigs (used by)
  • Drupal\config_enforce_devel\Form\GenerateFormBase (used indirectly via ModalFormHelperTrait, first step will be to bring it in as a direct use)
  • Drupal\config_enforce_devel\Form\ModalFormHelperTrait (used by, but not actually used in the trait, let's split it out, see below)
  • Drupal\config_enforce_devel\Form\SettingsForm (used by)

• Drupal\config_enforce_devel\Form\ModalFormHelperTrait (just remove dependency on DevelFormHelperTrait for now)
  • Drupal\config_enforce_devel\Form\AddModuleForm
  • Drupal\config_enforce_devel\Form\GenerateFormBase

Legend

• ❌ = delete in 2.x, deprecate in 1.x
• 🟢 = leave in place
• ⬇️ = only one remaining usage, move to specific class
  • ➡️ = move method to this class

Methods in DevelFormHelperTrait and what to do with them:

• ❌ submitForm()
• 🟢 setSharedFormProperties()
  • I won't list them out but this is used quite a bit and should be a separate refactor in my opinion
• 🟢 getEnforcedConfigCollection()
  • ⬇️ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::isRegistryConfig()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::saveEnforcedConfigs()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::getEnforcedConfigsToCreate()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::getEnforcedConfigsToUpdate()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::getEnforcedConfigsToDelete()
  • 🟢 Drupal\config_enforce_devel\Form\DevelFormHelperTrait::getTargetModuleField()
  • 🟢 Drupal\config_enforce_devel\Form\DevelFormHelperTrait::getAllUnenforcedConfigs()
  • 🟢 Drupal\config_enforce_devel\Form\EnforcedConfigs::updateEnforcedConfigs()
  • 🟢 Drupal\config_enforce_devel\Form\EnforcedConfigs::deleteEnforcedConfigs()
  • 🟢 Drupal\config_enforce_devel\Form\EnforcedConfigs::getEnforcedConfigsToUpdate()
  • 🟢 Drupal\config_enforce_devel\Form\EnforcedConfigs::getEnforcedConfigsToDelete()
  • 🟢 Drupal\config_enforce_devel\Form\EnforcedConfigs::getEditableConfigNames()
  • 🟢 Drupal\config_enforce_devel\Form\EnforcedConfigs::getEnforcedConfigs()
  • 🟢 Drupal\config_enforce_devel\Form\GenerateFormBase::generateEnforcedConfigSettings()
  • 🟢 Drupal\config_enforce_devel\Form\SettingsForm::submitForm()
  • 🟢 Drupal\config_enforce_devel\Form\SettingsForm::addAvailableModulesField()
• ❌ addEnforcedConfigItem()
• ❌ makeRegistryConfigsReadOnly()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::addEnforcedConfigItem()
• ⬇️ isRegistryConfig()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::submitForm()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::makeRegistryConfigsReadOnly()
  • ➡️ Drupal\config_enforce_devel\Form\EnforcedConfigs::getOptions()
• ❌ addEnforcedConfigEnabledField()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::addEnforcedConfigItem()
• ❌ overrideTargetModuleField()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::addEnforcedConfigItem()
• ❌ overrideConfigDirectoryField()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::addEnforcedConfigItem()
• ❌ overrideEnforcementLevelField()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::addEnforcedConfigItem()
• ❌ addEnforceDependenciesFields()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::addEnforcedConfigItem()
• ❌ disableEnforcedDependencies()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::addEnforceDependenciesFields()
• ❌ setEnforcedConfigPathStates()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::addEnforcedConfigItem()
• ❌ currentConfigIsEnforced()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::addEnforcedConfigEnabledField()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::overrideEnforcementLevelField()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::setEnforcedConfigPathStates()
• ❌ getEnabledAttribute()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::addEnforcedConfigEnabledField()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::getEnabledVisibilityState()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::getEnforceDependenciesVisibilityState()
• ❌ getEnabledVisibilityState()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::overrideTargetModuleField()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::overrideConfigDirectoryField()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::overrideEnforcementLevelField()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::addEnforceDependenciesFields()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::setEnforcedConfigPathStates()
• ❌ getEnforceDependenciesAttribute()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::addEnforceDependenciesFields()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::disableEnforcedDependencies()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::getEnforceDependenciesVisibilityState()
• ❌ getEnforceDependenciesVisibilityState()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::addEnforceDependenciesFields()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::disableEnforcedDependencies()
• ❌ saveEnforcedConfigs()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::submitForm()
• ❌ getEnforcedConfigsToCreate()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::saveEnforcedConfigs()
• ❌ getEnforcedConfigsToUpdate() (note EnforcedConfigs has a method with the same name)
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::saveEnforcedConfigs()
• ❌ getEnforcedConfigsToDelete() (note EnforcedConfigs has a method with the same name)
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::saveEnforcedConfigs()
• ❌ getConfigFormUri()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::getEnforcedConfigsToCreate()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::getEnforcedConfigsToUpdate()
• 🟢 getAvailableConfigDirectories()
  • ⬇️ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::getConfigDirectoryLabel()
  • 🟢 Drupal\config_enforce_devel\Form\DevelFormHelperTrait::getConfigDirectoryField()
  • 🟢 Drupal\config_enforce_devel\Form\GenerateFromModulesForm::addModuleConfigDirectories()
• ⬇️ getConfigDirectoryLabel()
  • ➡️ Drupal\config_enforce_devel\Form\GenerateFromModulesForm::addModuleConfigDirectory()
• ⬇️ getModuleConfigNames()
  • ➡️ Drupal\config_enforce_devel\Form\GenerateFromModulesForm::addModuleConfigs()
• ❌ getEnforcedConfigValuesFromForm()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::getEnforcedConfigValue()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::enforcedConfigValueExists()
• ❌ getEnforcedConfigValue()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::getEnforced()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::getTargetModule()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::getConfigDirectory()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::getEnforcementLevel()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::getEnforceDependencies()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::getDependencyEnforced()
• ❌ enforcedConfigValueExists()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::getEnforceDependencies()
• ❌ getEnforced()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::getEnforcedConfigsToCreate()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::getEnforcedConfigsToUpdate()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::getEnforcedConfigsToDelete()
• ❌ getTargetModule()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::getEnforcedConfigsToCreate()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::getEnforcedConfigsToUpdate()
• ❌ getConfigDirectory()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::getEnforcedConfigsToCreate()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::getEnforcedConfigsToUpdate()
• ❌ getEnforcementLevel()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::overrideEnforcementLevelField()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::getEnforcedConfigsToCreate()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::getEnforcedConfigsToUpdate()
• ❌ getEnforceDependencies()
• ❌ getDependencyEnforced()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::getEnforcedConfigsToCreate()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::getEnforcedConfigsToUpdate()
• 🟢 getTargetModuleField()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::overrideTargetModuleField()
  • 🟢 Drupal\config_enforce_devel\Form\EnforcedConfigs::addUpdateTargetModule()
  • 🟢 Drupal\config_enforce_devel\Form\GenerateFormBase::addTargetModuleField()
  • 🟢 Drupal\config_enforce_devel\Form\SettingsForm::addDefaultsFields()
• 🟢 getConfigDirectoryField()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::overrideConfigDirectoryField()
  • 🟢 Drupal\config_enforce_devel\Form\EnforcedConfigs::addUpdateConfigDirectory()
  • 🟢 Drupal\config_enforce_devel\Form\GenerateFormBase::addConfigDirectoryField()
  • 🟢 Drupal\config_enforce_devel\Form\SettingsForm::addDefaultsFields()
• 🟢 getEnforcementLevelField()
  • 🟢 Drupal\config_enforce_devel\Form\GenerateFormBase::addEnforcementLevelField()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::overrideEnforcementLevelField()
  • 🟢 Drupal\config_enforce_devel\Form\EnforcedConfigs::addUpdateEnforcementLevel()
  • 🟢 Drupal\config_enforce_devel\Form\SettingsForm::addDefaultsFields()
• ⬇️ getEnforceDependenciesField()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::addEnforceDependenciesFields()
  • ➡️ Drupal\config_enforce_devel\Form\SettingsForm::addDefaultsFields() (used by)
• 🟢 getUnenforcedConfigs()
  • 🟢 Drupal\config_enforce_devel\Form\GenerateFromActiveStorageForm::addActiveStorageConfigs() (used by)
• 🟢 getAllUnenforcedConfigs()
  • 🟢 Drupal\config_enforce_devel\Form\SettingsForm::addIgnoredConfigsField()
  • 🟢 Drupal\config_enforce_devel\Form\DevelFormHelperTrait::getUnenforcedConfigs()
• 🟢 getIgnoredConfigs()
  • 🟢 Drupal\config_enforce_devel\Form\SettingsForm::addIgnoredConfigsField()
  • 🟢 Drupal\config_enforce_devel\Form\DevelFormHelperTrait::getUnenforcedConfigs()
• ❌ getConfigDependencies()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::addEnforceDependenciesFields()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::disableEnforcedDependencies()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::getEnforcedConfigsToCreate()
  • ❌ Drupal\config_enforce_devel\Form\DevelFormHelperTrait::getEnforcedConfigsToUpdate()
• ❌ allConfigsAreEnforced()

Remaining tasks

• Delete code
• Test manually
• Deprecate deleted code in 1.0.x branch

User interface changes

Should be none.

API changes

There will be removed classes, methods, etc. which we could mark as deprecated on the 1.0.x branch.

Data model changes

Should be none.