class DevelGenerateForm
Same name in other branches
- 8.x-1.x devel_generate/src/Form/DevelGenerateForm.php \Drupal\devel_generate\Form\DevelGenerateForm
- 4.x devel_generate/src/Form/DevelGenerateForm.php \Drupal\devel_generate\Form\DevelGenerateForm
Defines a form that allows privileged users to generate entities.
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\devel_generate\Form\DevelGenerateForm extends \Drupal\Core\Form\FormBase
Expanded class hierarchy of DevelGenerateForm
1 file declares its use of DevelGenerateForm
- DevelGenerateRoutes.php in devel_generate/
src/ Routing/ DevelGenerateRoutes.php
File
-
devel_generate/
src/ Form/ DevelGenerateForm.php, line 15
Namespace
Drupal\devel_generate\FormView source
class DevelGenerateForm extends FormBase {
/**
* The manager to be used for instantiating plugins.
*/
protected PluginManagerInterface $develGenerateManager;
/**
* Logger service.
*/
protected LoggerInterface $logger;
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) : static {
$instance = parent::create($container);
$instance->develGenerateManager = $container->get('plugin.manager.develgenerate');
$instance->messenger = $container->get('messenger');
$instance->logger = $container->get('logger.channel.devel_generate');
$instance->requestStack = $container->get('request_stack');
$instance->stringTranslation = $container->get('string_translation');
return $instance;
}
/**
* {@inheritdoc}
*/
public function getFormId() : string {
return 'devel_generate_form_' . $this->getPluginIdFromRequest();
}
/**
* Returns the value of the param _plugin_id for the current request.
*
* @see \Drupal\devel_generate\Routing\DevelGenerateRouteSubscriber
*/
protected function getPluginIdFromRequest() {
$request = $this->requestStack
->getCurrentRequest();
return $request->get('_plugin_id');
}
/**
* Returns a DevelGenerate plugin instance for a given plugin id.
*
* @param string $plugin_id
* The plugin_id for the plugin instance.
*
* @return \Drupal\devel_generate\DevelGenerateBaseInterface
* A DevelGenerate plugin instance.
*/
public function getPluginInstance(string $plugin_id) : DevelGenerateBaseInterface {
return $this->develGenerateManager
->createInstance($plugin_id, []);
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state) : array {
$plugin_id = $this->getPluginIdFromRequest();
$instance = $this->getPluginInstance($plugin_id);
$form = $instance->settingsForm($form, $form_state);
$form['actions'] = [
'#type' => 'actions',
];
$form['actions']['submit'] = [
'#type' => 'submit',
'#value' => $this->t('Generate'),
'#button_type' => 'primary',
];
return $form;
}
/**
* {@inheritdoc}
*/
public function validateForm(array &$form, FormStateInterface $form_state) : void {
$plugin_id = $this->getPluginIdFromRequest();
$instance = $this->getPluginInstance($plugin_id);
$instance->settingsFormValidate($form, $form_state);
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) : void {
try {
$plugin_id = $this->getPluginIdFromRequest();
$instance = $this->getPluginInstance($plugin_id);
$instance->generate($form_state->getValues());
} catch (\Exception $e) {
$this->logger
->error($this->t('Failed to generate elements due to "%error".', [
'%error' => $e->getMessage(),
]));
$this->messenger
->addMessage($this->t('Failed to generate elements due to "%error".', [
'%error' => $e->getMessage(),
]));
}
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
DependencySerializationTrait::$_entityStorages | protected | property | |||
DependencySerializationTrait::$_serviceIds | protected | property | |||
DependencySerializationTrait::__sleep | public | function | 1 | ||
DependencySerializationTrait::__wakeup | public | function | 2 | ||
DevelGenerateForm::$develGenerateManager | protected | property | The manager to be used for instantiating plugins. | ||
DevelGenerateForm::$logger | protected | property | Logger service. | ||
DevelGenerateForm::buildForm | public | function | Form constructor. | Overrides FormInterface::buildForm | |
DevelGenerateForm::create | public static | function | Instantiates a new instance of this class. | Overrides FormBase::create | |
DevelGenerateForm::getFormId | public | function | Returns a unique string identifying the form. | Overrides FormInterface::getFormId | |
DevelGenerateForm::getPluginIdFromRequest | protected | function | Returns the value of the param _plugin_id for the current request. | ||
DevelGenerateForm::getPluginInstance | public | function | Returns a DevelGenerate plugin instance for a given plugin id. | ||
DevelGenerateForm::submitForm | public | function | Form submission handler. | Overrides FormInterface::submitForm | |
DevelGenerateForm::validateForm | public | function | Form validation handler. | Overrides FormBase::validateForm | |
FormBase::$configFactory | protected | property | The config factory. | 3 | |
FormBase::$requestStack | protected | property | The request stack. | 1 | |
FormBase::$routeMatch | protected | property | The route match. | ||
FormBase::config | protected | function | Retrieves a configuration object. | ||
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. | ||
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. |