class PurgerMoveForm in Purge 8.3
Move purger {id} in the purger execution order - 'up' or 'down'.
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfirmFormBase implements ConfirmFormInterface
- class \Drupal\purge_ui\Form\PurgerMoveForm uses CloseDialogTrait
- class \Drupal\Core\Form\ConfirmFormBase implements ConfirmFormInterface
Expanded class hierarchy of PurgerMoveForm
2 files declare their use of PurgerMoveForm
- PurgerMoveFormDownTest.php in modules/
purge_ui/ tests/ src/ Functional/ Form/ PurgerMoveFormDownTest.php - PurgerMoveFormUpTest.php in modules/
purge_ui/ tests/ src/ Functional/ Form/ PurgerMoveFormUpTest.php
File
- modules/
purge_ui/ src/ Form/ PurgerMoveForm.php, line 15
Namespace
Drupal\purge_ui\FormView source
class PurgerMoveForm extends ConfirmFormBase {
use CloseDialogTrait;
/**
* Unique instance ID for the purger.
*
* @var string
*/
protected $id;
/**
* The plugin definition for the purger.
*
* @var array
*/
protected $definition;
/**
* Either 'up' or 'down' are valid directions to move execution order in.
*
* @var string
*/
protected $direction;
/**
* The 'purge.purgers' service.
*
* @var \Drupal\purge\Plugin\Purge\Purger\PurgersServiceInterface
*/
protected $purgePurgers;
/**
* Construct a PurgerMoveForm object.
*
* @param \Drupal\purge\Plugin\Purge\Purger\PurgersServiceInterface $purge_purgers
* The purgers service.
*/
public final function __construct(PurgersServiceInterface $purge_purgers) {
$this->purgePurgers = $purge_purgers;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container
->get('purge.purgers'));
}
/**
* {@inheritdoc}
*/
protected function getEditableConfigNames() {
return [];
}
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'purge_ui.purger_move_form';
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state) {
$this->definition = $form_state
->getBuildInfo()['args'][0]['definition'];
$this->direction = $form_state
->getBuildInfo()['args'][0]['direction'];
$this->id = $form_state
->getBuildInfo()['args'][0]['id'];
$form = parent::buildForm($form, $form_state);
// This is rendered as a modal dialog, so we need to set some extras.
$form['#attached']['library'][] = 'core/drupal.dialog.ajax';
// Update the buttons and bind callbacks.
$form['actions']['submit'] = [
'#type' => 'submit',
'#button_type' => 'primary',
'#value' => $this
->getConfirmText(),
'#ajax' => [
'callback' => '::movePurger',
],
];
$form['actions']['cancel'] = [
'#type' => 'submit',
'#value' => $this
->t('No'),
'#weight' => -10,
'#ajax' => [
'callback' => '::closeDialog',
],
];
return $form;
}
/**
* {@inheritdoc}
*/
public function getConfirmText() {
return $this
->t('Yes!');
}
/**
* {@inheritdoc}
*/
public function getQuestion() {
$label = [
'@label' => $this->purgePurgers
->getLabels()[$this->id],
];
if ($this->direction === 'up') {
return $this
->t('Do you want to move @label up in the execution order?', $label);
}
elseif ($this->direction === 'down') {
return $this
->t('Do you want to move @label down in the execution order?', $label);
}
return '';
}
/**
* {@inheritdoc}
*/
public function getCancelUrl() {
return NULL;
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
}
/**
* Move the purger.
*
* @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 movePurger(array &$form, FormStateInterface $form_state) {
$response = new AjaxResponse();
$response
->addCommand(new CloseModalDialogCommand());
if (isset($this->purgePurgers
->getPluginsEnabled()[$this->id])) {
$response
->addCommand(new ReloadConfigFormCommand('edit-purgers'));
if ($this->direction === 'up') {
$this->purgePurgers
->movePurgerUp($this->id);
}
elseif ($this->direction === 'down') {
$this->purgePurgers
->movePurgerDown($this->id);
}
}
return $response;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CloseDialogTrait:: |
public | function | Respond a CloseModalDialogCommand to close the modal dialog. | |
ConfirmFormBase:: |
public | function |
Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface:: |
1 |
ConfirmFormBase:: |
public | function |
Returns additional text to display as a description. Overrides ConfirmFormInterface:: |
11 |
ConfirmFormBase:: |
public | function |
Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface:: |
|
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 | Retrieves a configuration object. | |
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. | |
PurgerMoveForm:: |
protected | property | The plugin definition for the purger. | |
PurgerMoveForm:: |
protected | property | Either 'up' or 'down' are valid directions to move execution order in. | |
PurgerMoveForm:: |
protected | property | Unique instance ID for the purger. | |
PurgerMoveForm:: |
protected | property | The 'purge.purgers' service. | |
PurgerMoveForm:: |
public | function |
Form constructor. Overrides ConfirmFormBase:: |
|
PurgerMoveForm:: |
public static | function |
Instantiates a new instance of this class. Overrides FormBase:: |
|
PurgerMoveForm:: |
public | function |
Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface:: |
|
PurgerMoveForm:: |
public | function |
Returns a caption for the button that confirms the action. Overrides ConfirmFormBase:: |
|
PurgerMoveForm:: |
protected | function | ||
PurgerMoveForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
PurgerMoveForm:: |
public | function |
Returns the question to ask the user. Overrides ConfirmFormInterface:: |
|
PurgerMoveForm:: |
public | function | Move the purger. | |
PurgerMoveForm:: |
public | function |
Form submission handler. Overrides FormInterface:: |
|
PurgerMoveForm:: |
final public | function | Construct a PurgerMoveForm object. | |
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. |