class QueuerAddForm in Purge 8.3
Add a queuer.
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\purge_ui\Form\QueuerAddForm uses CloseDialogTrait
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
Expanded class hierarchy of QueuerAddForm
1 file declares its use of QueuerAddForm
- QueuerAddFormTest.php in modules/
purge_ui/ tests/ src/ Functional/ Form/ QueuerAddFormTest.php
File
- modules/
purge_ui/ src/ Form/ QueuerAddForm.php, line 15
Namespace
Drupal\purge_ui\FormView source
class QueuerAddForm extends ConfigFormBase {
use CloseDialogTrait;
/**
* The 'purge.queuers' service.
*
* @var \Drupal\purge\Plugin\Purge\Queuer\QueuersServiceInterface
*/
protected $purgeQueuers;
/**
* Construct a QueuerAddForm object.
*
* @param \Drupal\purge\Plugin\Purge\Queuer\QueuersServiceInterface $purge_queuers
* The purge queuers service.
*/
public final function __construct(QueuersServiceInterface $purge_queuers) {
$this->purgeQueuers = $purge_queuers;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container
->get('purge.queuers'));
}
/**
* {@inheritdoc}
*/
protected function getEditableConfigNames() {
return [];
}
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'purge_ui.queuer_add_form';
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state) {
$definitions = $this->purgeQueuers
->getPlugins();
$form = parent::buildForm($form, $form_state);
$form['#attached']['library'][] = 'core/drupal.dialog.ajax';
// List all available queuers.
$options = [];
foreach ($this->purgeQueuers
->getPluginsAvailable() as $plugin_id) {
$options[$plugin_id] = $this
->t("@label: @description", [
'@label' => $definitions[$plugin_id]['label'],
'@description' => $definitions[$plugin_id]['description'],
]);
}
$form['id'] = [
'#default_value' => count($options) ? key($options) : NULL,
'#type' => 'radios',
'#options' => $options,
];
// Update the buttons and bind callbacks.
$form['actions']['submit'] = [
'#access' => count($options),
'#type' => 'submit',
'#button_type' => 'primary',
'#value' => $this
->t("Add"),
'#ajax' => [
'callback' => '::addQueuer',
],
];
$form['actions']['cancel'] = [
'#type' => 'submit',
'#value' => $this
->t('Cancel'),
'#weight' => -10,
'#ajax' => [
'callback' => '::closeDialog',
],
];
return $form;
}
/**
* Add the queuer.
*
* @param array $form
* An associative array containing the structure of the form.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current state of the form.
*
* @return \Drupal\Core\Ajax\AjaxResponse
* The AJAX response object.
*/
public function addQueuer(array &$form, FormStateInterface $form_state) {
$response = new AjaxResponse();
$id = $form_state
->getValue('id');
$response
->addCommand(new CloseModalDialogCommand());
if (in_array($id, $this->purgeQueuers
->getPluginsAvailable())) {
$enabled = $this->purgeQueuers
->getPluginsEnabled();
$enabled[] = $id;
$this->purgeQueuers
->setPluginsEnabled($enabled);
$response
->addCommand(new ReloadConfigFormCommand('edit-queue'));
}
return $response;
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CloseDialogTrait:: |
public | function | Respond a CloseModalDialogCommand to close the modal dialog. | |
ConfigFormBase:: |
public | function |
Form submission handler. Overrides FormInterface:: |
26 |
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. | |
QueuerAddForm:: |
protected | property | The 'purge.queuers' service. | |
QueuerAddForm:: |
public | function | Add the queuer. | |
QueuerAddForm:: |
public | function |
Form constructor. Overrides ConfigFormBase:: |
|
QueuerAddForm:: |
public static | function |
Instantiates a new instance of this class. Overrides ConfigFormBase:: |
|
QueuerAddForm:: |
protected | function |
Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait:: |
|
QueuerAddForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
QueuerAddForm:: |
final public | function |
Construct a QueuerAddForm object. Overrides ConfigFormBase:: |
|
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. | |
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. |