class CronForm in Drupal 9

Same name and namespace in other branches

8 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 ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\system\Form\CronForm uses ConfigFormBaseTrait

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\Form

View 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->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.'));
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigFormBaseTrait::config	protected	function	Retrieves a configuration object.
CronForm::$cron	protected	property	The cron service.
CronForm::$dateFormatter	protected	property	The date formatter service.
CronForm::$moduleHandler	protected	property	The module handler service.
CronForm::$state	protected	property	Stores the state storage service.
CronForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
CronForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
CronForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
CronForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
CronForm::runCron	public	function	Form submission handler for running cron manually.
CronForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
CronForm::__construct	public	function	Constructs a CronForm object.
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
FormBase::$configFactory	protected	property	The config factory.	3
FormBase::$requestStack	protected	property	The request stack.	1
FormBase::$routeMatch	protected	property	The route match.
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.
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.
FormBase::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	72
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.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
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.	4
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.

You are here

class CronForm in Drupal 9

Hierarchy

File

Namespace

Members

API Navigation