class SettingsForm
Implements the settings form.
Hierarchy
- class \Drupal\Core\Form\FormBase implements \Drupal\Core\Form\FormInterface, \Drupal\Core\DependencyInjection\ContainerInjectionInterface uses \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Logger\LoggerChannelTrait, \Drupal\Core\Messenger\MessengerTrait, \Drupal\Core\Routing\RedirectDestinationTrait, \Drupal\Core\StringTranslation\StringTranslationTrait
- class \Drupal\Core\Form\ConfigFormBase extends \Drupal\Core\Form\FormBase uses \Drupal\Core\Form\ConfigFormBaseTrait
- class \Drupal\rules_test_ui_embed\Form\SettingsForm extends \Drupal\Core\Form\ConfigFormBase
- class \Drupal\Core\Form\ConfigFormBase extends \Drupal\Core\Form\FormBase uses \Drupal\Core\Form\ConfigFormBaseTrait
Expanded class hierarchy of SettingsForm
1 string reference to 'SettingsForm'
- rules_test_ui_embed.routing.yml in tests/
modules/ rules_test_ui_embed/ rules_test_ui_embed.routing.yml - tests/modules/rules_test_ui_embed/rules_test_ui_embed.routing.yml
File
-
tests/
modules/ rules_test_ui_embed/ src/ Form/ SettingsForm.php, line 12
Namespace
Drupal\rules_test_ui_embed\FormView source
class SettingsForm extends ConfigFormBase {
/**
* The RulesUI handler of the currently active UI.
*
* @var \Drupal\rules\Ui\RulesUiConfigHandler
*/
protected $rulesUiHandler;
/**
* {@inheritdoc}
*/
protected function getEditableConfigNames() {
return [
'rules_test_ui_embed.settings',
];
}
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'rules_test_ui_embed_settings';
}
/**
* {@inheritdoc}
*/
protected function config($name) {
// Get the editable config from the Rules UI handlers, such that any
// interim changes to the contained Rules component are picked up.
$config = $this->rulesUiHandler ? $this->rulesUiHandler
->getConfig() : NULL;
if ($config->getName() == $name && in_array($name, $this->getEditableConfigNames())) {
return $config;
}
return parent::config($name);
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state, RulesUiConfigHandler $rules_ui_handler = NULL) {
$form = parent::buildForm($form, $form_state);
$this->rulesUiHandler = $rules_ui_handler;
$config = $this->config('rules_test_ui_embed.settings');
$form['css_file'] = [
'#type' => 'textfield',
'#title' => $this->t('CSS file'),
'#default_value' => $config->get('css.0.file'),
'#required' => TRUE,
];
$form['conditions'] = $this->rulesUiHandler
->getForm()
->buildForm([], $form_state);
$form['actions']['cancel'] = [
'#type' => 'submit',
'#limit_validation_errors' => [
[
'locked',
],
],
'#value' => $this->t('Cancel'),
'#submit' => [
'::cancel',
],
];
return $form;
}
/**
* {@inheritdoc}
*/
public function validateForm(array &$form, FormStateInterface $form_state) {
parent::validateForm($form, $form_state);
$this->rulesUiHandler
->getForm()
->validateForm($form['conditions'], $form_state);
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
$this->rulesUiHandler
->getForm()
->submitForm($form['conditions'], $form_state);
$this->config('rules_test_ui_embed.settings')
->set('css.0.file', $form_state->getValue('css_file'))
->save();
// Also remove the temporarily stored component, it has been persisted now.
$this->rulesUiHandler
->clearTemporaryStorage();
parent::submitForm($form, $form_state);
}
/**
* Form submission handler for the 'cancel' action.
*/
public function cancel(array $form, FormStateInterface $form_state) {
$this->rulesUiHandler
->clearTemporaryStorage();
$this->messenger()
->addMessage($this->t('Canceled.'));
$form_state->setRedirectUrl($this->rulesUiHandler
->getBaseRouteUrl());
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
ConfigFormBase::create | public static | function | Overrides FormBase::create | 18 | |
ConfigFormBase::__construct | public | function | Constructs a \Drupal\system\ConfigFormBase object. | 17 | |
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. | ||
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. | 17 | |
MessengerTrait::messenger | public | function | Gets the messenger. | 17 | |
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. | ||
SettingsForm::$rulesUiHandler | protected | property | The RulesUI handler of the currently active UI. | ||
SettingsForm::buildForm | public | function | Form constructor. | Overrides ConfigFormBase::buildForm | |
SettingsForm::cancel | public | function | Form submission handler for the 'cancel' action. | ||
SettingsForm::config | protected | function | Retrieves a configuration object. | Overrides ConfigFormBaseTrait::config | |
SettingsForm::getEditableConfigNames | protected | function | Gets the configuration names that will be editable. | Overrides ConfigFormBaseTrait::getEditableConfigNames | |
SettingsForm::getFormId | public | function | Returns a unique string identifying the form. | Overrides FormInterface::getFormId | |
SettingsForm::submitForm | public | function | Form submission handler. | Overrides ConfigFormBase::submitForm | |
SettingsForm::validateForm | public | function | Form validation handler. | Overrides FormBase::validateForm | |
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. |