class SocialUserExportSettingsForm in Open Social 8.8
Same name and namespace in other branches
- 8.9 modules/social_features/social_user_export/src/Form/SocialUserExportSettingsForm.php \Drupal\social_user_export\Form\SocialUserExportSettingsForm
- 10.3.x modules/social_features/social_user_export/src/Form/SocialUserExportSettingsForm.php \Drupal\social_user_export\Form\SocialUserExportSettingsForm
- 10.0.x modules/social_features/social_user_export/src/Form/SocialUserExportSettingsForm.php \Drupal\social_user_export\Form\SocialUserExportSettingsForm
- 10.1.x modules/social_features/social_user_export/src/Form/SocialUserExportSettingsForm.php \Drupal\social_user_export\Form\SocialUserExportSettingsForm
- 10.2.x modules/social_features/social_user_export/src/Form/SocialUserExportSettingsForm.php \Drupal\social_user_export\Form\SocialUserExportSettingsForm
Class SocialUserExportSettingsForm.
@package Drupal\social_user_export\Form
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
- class \Drupal\social_user_export\Form\SocialUserExportSettingsForm
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
Expanded class hierarchy of SocialUserExportSettingsForm
1 string reference to 'SocialUserExportSettingsForm'
- social_user_export.routing.yml in modules/
social_features/ social_user_export/ social_user_export.routing.yml - modules/social_features/social_user_export/social_user_export.routing.yml
File
- modules/
social_features/ social_user_export/ src/ Form/ SocialUserExportSettingsForm.php, line 16
Namespace
Drupal\social_user_export\FormView source
class SocialUserExportSettingsForm extends ConfigFormBase {
/**
* The plugin manager for export plugins.
*
* @var \Drupal\social_user_export\Plugin\UserExportPluginManager
*/
protected $exportPluginManager;
/**
* Constructs a new DataPolicyRevisionDeleteForm.
*
* @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
* The factory for configuration objects.
* @param \Drupal\social_user_export\Plugin\UserExportPluginManager $export_plugin_manager
* The plugin manager for export plugins.
*/
public function __construct(ConfigFactoryInterface $config_factory, UserExportPluginManager $export_plugin_manager) {
parent::__construct($config_factory);
$this->exportPluginManager = $export_plugin_manager;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container
->get('config.factory'), $container
->get('plugin.manager.user_export_plugin'));
}
/**
* {@inheritdoc}
*/
protected function getEditableConfigNames() {
return [
'social_user_export.settings',
];
}
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'social_user_export_settings_form';
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state) {
$config = $this
->config('social_user_export.settings');
$options = [];
$export_plugins = $this->exportPluginManager
->getDefinitions();
foreach ($export_plugins as $plugin) {
$options[$plugin['id']] = $plugin['label'];
}
// Show a list of plugins that can be enabled or disabled for user
// exporting.
$form['plugins'] = [
'#type' => 'checkboxes',
'#title' => $this
->t('Data available for users to export'),
'#description' => $this
->t('Check any data that users are allowed to export in for example the events and groups they manage.'),
'#options' => $options,
'#default_value' => $config
->get('plugins'),
];
return parent::buildForm($form, $form_state);
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
parent::submitForm($form, $form_state);
$this
->config('social_user_export.settings')
->set('plugins', $form_state
->getValue('plugins'))
->save();
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ConfigFormBaseTrait:: |
protected | function | Retrieves a configuration object. | |
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
FormBase:: |
protected | property | The config factory. | 1 |
FormBase:: |
protected | property | The request stack. | 1 |
FormBase:: |
protected | property | The route match. | |
FormBase:: |
protected | function | Gets the config factory for this form. | 1 |
FormBase:: |
private | function | Returns the service container. | |
FormBase:: |
protected | function | Gets the current user. | |
FormBase:: |
protected | function | Gets the request object. | |
FormBase:: |
protected | function | Gets the route match. | |
FormBase:: |
protected | function | Gets the logger for a specific channel. | |
FormBase:: |
protected | function |
Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait:: |
|
FormBase:: |
public | function | Resets the configuration factory. | |
FormBase:: |
public | function | Sets the config factory for this form. | |
FormBase:: |
public | function | Sets the request stack object to use. | |
FormBase:: |
public | function |
Form validation handler. Overrides FormInterface:: |
62 |
LinkGeneratorTrait:: |
protected | property | The link generator. | 1 |
LinkGeneratorTrait:: |
protected | function | Returns the link generator. | |
LinkGeneratorTrait:: |
protected | function | Renders a link to a route given a route name and its parameters. | |
LinkGeneratorTrait:: |
public | function | Sets the link generator service. | |
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
SocialUserExportSettingsForm:: |
protected | property | The plugin manager for export plugins. | |
SocialUserExportSettingsForm:: |
public | function |
Form constructor. Overrides ConfigFormBase:: |
|
SocialUserExportSettingsForm:: |
public static | function |
Instantiates a new instance of this class. Overrides ConfigFormBase:: |
|
SocialUserExportSettingsForm:: |
protected | function |
Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait:: |
|
SocialUserExportSettingsForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
SocialUserExportSettingsForm:: |
public | function |
Form submission handler. Overrides ConfigFormBase:: |
|
SocialUserExportSettingsForm:: |
public | function |
Constructs a new DataPolicyRevisionDeleteForm. Overrides ConfigFormBase:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
UrlGeneratorTrait:: |
protected | property | The url generator. | |
UrlGeneratorTrait:: |
protected | function | Returns the URL generator service. | |
UrlGeneratorTrait:: |
public | function | Sets the URL generator service. | |
UrlGeneratorTrait:: |
protected | function | Generates a URL or path for a specific route based on the given parameters. |