class CronForm
Same name and namespace in other branches
- 11.x core/modules/system/src/Form/CronForm.php \Drupal\system\Form\CronForm
- 10 core/modules/system/src/Form/CronForm.php \Drupal\system\Form\CronForm
- 8.9.x core/modules/system/src/Form/CronForm.php \Drupal\system\Form\CronForm
Configure cron settings for this site.
@internal
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\system\Form\CronForm uses \Drupal\Core\Form\ConfigFormBaseTrait extends \Drupal\Core\Form\FormBase
Expanded class hierarchy of CronForm
1 string reference to 'CronForm'
- system.routing.yml in core/
modules/ system/ system.routing.yml - core/modules/system/system.routing.yml
File
-
core/
modules/ system/ src/ Form/ CronForm.php, line 21
Namespace
Drupal\system\FormView source
class CronForm extends FormBase {
use ConfigFormBaseTrait;
/**
* Stores the state storage service.
*
* @var \Drupal\Core\State\StateInterface
*/
protected $state;
/**
* The cron service.
*
* @var \Drupal\Core\CronInterface
*/
protected $cron;
/**
* The date formatter service.
*
* @var \Drupal\Core\Datetime\DateFormatterInterface
*/
protected $dateFormatter;
/**
* The module handler service.
*
* @var \Drupal\Core\Extension\ModuleHandlerInterface
*/
protected $moduleHandler;
/**
* Constructs a CronForm object.
*
* @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
* The factory for configuration objects.
* @param \Drupal\Core\State\StateInterface $state
* The state key value store.
* @param \Drupal\Core\CronInterface $cron
* The cron service.
* @param \Drupal\Core\Datetime\DateFormatterInterface $date_formatter
* The date formatter service.
* @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
* The module handler service.
*/
public function __construct(ConfigFactoryInterface $config_factory, StateInterface $state, CronInterface $cron, DateFormatterInterface $date_formatter, ModuleHandlerInterface $module_handler) {
$this->configFactory = $config_factory;
$this->state = $state;
$this->cron = $cron;
$this->dateFormatter = $date_formatter;
$this->moduleHandler = $module_handler;
}
/**
* {@inheritdoc}
*/
protected function getEditableConfigNames() {
return [
'system.cron',
];
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container->get('config.factory'), $container->get('state'), $container->get('cron'), $container->get('date.formatter'), $container->get('module_handler'));
}
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'system_cron_settings';
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state) {
$form['description'] = [
'#markup' => '<p>' . $this->t('Cron takes care of running periodic tasks like checking for updates and indexing content for search.') . '</p>',
];
$form['run'] = [
'#type' => 'submit',
'#value' => $this->t('Run cron'),
'#submit' => [
'::runCron',
],
];
$status = '<p>' . $this->t('Last run: %time ago.', [
'%time' => $this->dateFormatter
->formatTimeDiffSince($this->state
->get('system.cron_last')),
]) . '</p>';
$form['status'] = [
'#markup' => $status,
];
$cron_url = Url::fromRoute('system.cron', [
'key' => $this->state
->get('system.cron_key'),
], [
'absolute' => TRUE,
])
->toString();
$form['cron_url'] = [
'#markup' => '<p>' . $this->t('To run cron from outside the site, go to <a href=":cron" class="system-cron-settings__link">@cron</a>', [
':cron' => $cron_url,
'@cron' => $cron_url,
]) . '</p>',
];
if (!$this->moduleHandler
->moduleExists('automated_cron')) {
$form['automated_cron'] = [
'#markup' => $this->t('Enable the <em>Automated Cron</em> module to allow cron execution at the end of a server response.'),
];
}
$form['cron'] = [
'#title' => $this->t('Cron settings'),
'#type' => 'details',
'#open' => TRUE,
];
$form['cron']['logging'] = [
'#type' => 'checkbox',
'#title' => $this->t('Detailed cron logging'),
'#default_value' => $this->config('system.cron')
->get('logging'),
'#description' => $this->t('Run times of individual cron jobs will be written to watchdog'),
];
$form['actions']['#type'] = 'actions';
$form['actions']['submit'] = [
'#type' => 'submit',
'#value' => $this->t('Save configuration'),
'#button_type' => 'primary',
];
return $form;
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
$this->config('system.cron')
->set('logging', $form_state->getValue('logging'))
->save();
$this->messenger()
->addStatus($this->t('The configuration options have been saved.'));
}
/**
* Form submission handler for running cron manually.
*/
public function runCron(array &$form, FormStateInterface $form_state) {
if ($this->cron
->run()) {
$this->messenger()
->addStatus($this->t('Cron ran successfully.'));
}
else {
$this->messenger()
->addError($this->t('Cron run failed.'));
}
}
}
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.