You are here

Home » API reference » Ultimate Cron 8.2 » JobController.php

class JobController in Ultimate Cron 8.2

A controller to interact with CronJob entities.

Hierarchy

Expanded class hierarchy of JobController

File

src/Controller/JobController.php, line 12

Namespace

Drupal\ultimate_cron\Controller
View source 
class JobController extends ControllerBase {

  /**
   * Runs a single cron job.
   *
   * @param \Drupal\ultimate_cron\Entity\CronJob $ultimate_cron_job
   *   The cron job which will be run.
   *
   * @return \Symfony\Component\HttpFoundation\RedirectResponse
   *   Redirects to the job listing after running a job.
   */
  public function runCronJob(CronJob $ultimate_cron_job) {
    $ultimate_cron_job
      ->run($this
      ->t('Launched manually'));
    $this
      ->messenger()
      ->addStatus($this
      ->t('Cron job @job_label (@module) was successfully run.', [
      '@job_label' => $ultimate_cron_job
        ->label(),
      '@module' => $ultimate_cron_job
        ->getModuleName(),
    ]));
    return $this
      ->redirect('entity.ultimate_cron_job.collection');
  }

  /**
   * Discovers new default cron jobs.
   */
  public function discoverJobs() {
    \Drupal::service('ultimate_cron.discovery')
      ->discoverCronJobs();
    $this
      ->messenger()
      ->addStatus($this
      ->t('Completed discovery for new cron jobs.'));
    return $this
      ->redirect('entity.ultimate_cron_job.collection');
  }

  /**
   * Displays a detailed cron job logs table.
   *
   * @param \Drupal\ultimate_cron\Entity\CronJob $ultimate_cron_job
   *   The cron job which will be run.
   *
   * @return array
   *   A render array as expected by drupal_render().
   */
  public function showLogs(CronJob $ultimate_cron_job) {
    $header = array(
      $this
        ->t('Severity'),
      $this
        ->t('Start Time'),
      $this
        ->t('End Time'),
      $this
        ->t('Message'),
      $this
        ->t('Duration'),
    );
    $build['ultimate_cron_job_logs_table'] = [
      '#type' => 'table',
      '#header' => $header,
      '#empty' => $this
        ->t('No log information available.'),
    ];
    $log_entries = $ultimate_cron_job
      ->getLogEntries();
    foreach ($log_entries as $log_entry) {
      list($status, $title) = $log_entry
        ->formatSeverity();
      $title = $log_entry->message ? $log_entry->message : $title;
      $row = [];
      $row['severity'] = $status;
      $row['severity']['#wrapper_attributes']['title'] = strip_tags($title);
      $row['start_time']['#markup'] = $log_entry
        ->formatStartTime();
      $row['end_time']['#markup'] = $log_entry
        ->formatEndTime();
      $row['message']['#markup'] = $log_entry->message ?: $log_entry
        ->formatInitMessage();
      $row['duration']['#markup'] = $log_entry
        ->formatDuration();
      $build['ultimate_cron_job_logs_table'][] = $row;
    }
    $build['#title'] = $this
      ->t('Logs for %label', [
      '%label' => $ultimate_cron_job
        ->label(),
    ]);
    return $build;
  }

  /**
   * Unlocks a single cron job.
   *
   * @param \Drupal\ultimate_cron\Entity\CronJob $ultimate_cron_job
   *   The cron job which will be unlocked.
   *
   * @return \Symfony\Component\HttpFoundation\RedirectResponse
   *   Redirects to the job listing after running a job.
   */
  public function unlockCronJob(CronJob $ultimate_cron_job) {
    $lock_id = $ultimate_cron_job
      ->isLocked();
    $name = $ultimate_cron_job
      ->label();

    // Unlock the process.
    if ($ultimate_cron_job
      ->unlock($lock_id, TRUE)) {
      $user = \Drupal::currentUser();
      \Drupal::logger('ultimate_cron')
        ->warning('@name manually unlocked by user @username (@uid)', array(
        '@name' => $ultimate_cron_job
          ->id(),
        '@username' => $user
          ->getDisplayName(),
        '@uid' => $user
          ->id(),
      ));
      $this
        ->messenger()
        ->addStatus($this
        ->t('Cron job @name unlocked successfully.', [
        '@name' => $name,
      ]));
    }
    else {
      $this
        ->messenger()
        ->addError($this
        ->t('Could not unlock cron job @name', [
        '@name' => $name,
      ]));
    }
    return $this
      ->redirect('entity.ultimate_cron_job.collection');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityManager protected property The entity manager.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 40
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityManager Deprecated protected function Retrieves the entity manager service.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state protected function Returns the state storage service.
JobController::discoverJobs public function Discovers new default cron jobs.
JobController::runCronJob public function Runs a single cron job.
JobController::showLogs public function Displays a detailed cron job logs table.
JobController::unlockCronJob public function Unlocks a single cron job.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
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. 29
MessengerTrait::messenger public function Gets the messenger. 29
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. 1
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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.