class UpdateReady in Automatic Updates 8.2
Defines a form to commit staged updates.
@internal Form classes are internal.
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\automatic_updates\Form\UpdateReady
Expanded class hierarchy of UpdateReady
1 string reference to 'UpdateReady'
File
- src/
Form/ UpdateReady.php, line 20
Namespace
Drupal\automatic_updates\FormView source
class UpdateReady extends FormBase {
/**
* The updater service.
*
* @var \Drupal\automatic_updates\Updater
*/
protected $updater;
/**
* The state service.
*
* @var \Drupal\Core\State\StateInterface
*/
protected $state;
/**
* Constructs a new UpdateReady object.
*
* @param \Drupal\automatic_updates\Updater $updater
* The updater service.
* @param \Drupal\Core\Messenger\MessengerInterface $messenger
* The messenger service.
* @param \Drupal\Core\State\StateInterface $state
* The state service.
*/
public function __construct(Updater $updater, MessengerInterface $messenger, StateInterface $state) {
$this->updater = $updater;
$this
->setMessenger($messenger);
$this->state = $state;
}
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'automatic_updates_update_ready_form';
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container
->get('automatic_updates.updater'), $container
->get('messenger'), $container
->get('state'));
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state) {
$form['backup'] = [
'#prefix' => '<strong>',
'#markup' => $this
->t('Back up your database and site before you continue. <a href=":backup_url">Learn how</a>.', [
':backup_url' => 'https://www.drupal.org/node/22281',
]),
'#suffix' => '</strong>',
];
$form['maintenance_mode'] = [
'#title' => $this
->t('Perform updates with site in maintenance mode (strongly recommended)'),
'#type' => 'checkbox',
'#default_value' => TRUE,
];
$form['actions'] = [
'#type' => 'actions',
];
$form['actions']['submit'] = [
'#type' => 'submit',
'#value' => $this
->t('Continue'),
];
return $form;
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
$session = $this
->getRequest()
->getSession();
// Store maintenance_mode setting so we can restore it when done.
$session
->set('maintenance_mode', $this->state
->get('system.maintenance_mode'));
if ($form_state
->getValue('maintenance_mode') === TRUE) {
$this->state
->set('system.maintenance_mode', TRUE);
// @todo unset after updater. After db update?
}
$batch = (new BatchBuilder())
->setTitle($this
->t('Apply updates'))
->setInitMessage($this
->t('Preparing to apply updates'))
->addOperation([
BatchProcessor::class,
'commit',
])
->addOperation([
BatchProcessor::class,
'clean',
])
->setFinishCallback([
BatchProcessor::class,
'finishCommit',
])
->toArray();
batch_set($batch);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
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. | |
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. | |
UpdateReady:: |
protected | property | The state service. | |
UpdateReady:: |
protected | property | The updater service. | |
UpdateReady:: |
public | function |
Form constructor. Overrides FormInterface:: |
|
UpdateReady:: |
public static | function |
Instantiates a new instance of this class. Overrides FormBase:: |
|
UpdateReady:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
UpdateReady:: |
public | function |
Form submission handler. Overrides FormInterface:: |
|
UpdateReady:: |
public | function | Constructs a new UpdateReady object. | |
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. |