function UpdateRequirements::requirementCheck

Fills in the requirements array.

This is shared for both core and contrib to generate the right elements in the array for hook_runtime_requirements().

Parameters

array $project: Array of information about the project we're testing as returned by update_calculate_project_data().

string $type: What kind of project this is ('core' or 'contrib').

Return value

array An array to be included in the nested $requirements array.

See also

hook_requirements()

update_requirements()

update_calculate_project_data()

1 call to UpdateRequirements::requirementCheck()
UpdateRequirements::runtime in core/modules/update/src/Hook/UpdateRequirements.php
Implements hook_runtime_requirements().

File

core/modules/update/src/Hook/UpdateRequirements.php, line 106

Class

UpdateRequirements
Requirements for the update module.

Namespace

Drupal\update\Hook

Code

protected function requirementCheck($project, $type) : array {
  $requirement = [];
  if ($type == 'core') {
    $requirement['title'] = $this->t('Drupal core update status');
  }
  else {
    $requirement['title'] = $this->t('Module and theme update status');
  }
  $status = $project['status'];
  if ($status != UpdateManagerInterface::CURRENT) {
    $requirement['reason'] = $status;
    $requirement['severity'] = RequirementSeverity::Error;
    // When updates are available, append the available updates link to the
    // message from _update_message_text(), and format the two translated
    // strings together in a single paragraph.
    $requirement['description'][] = [
      '#markup' => _update_message_text($type, $status),
    ];
    if (!in_array($status, [
      UpdateFetcherInterface::UNKNOWN,
      UpdateFetcherInterface::NOT_CHECKED,
      UpdateFetcherInterface::NOT_FETCHED,
      UpdateFetcherInterface::FETCH_PENDING,
    ])) {
      $requirement['description'][] = [
        '#prefix' => ' ',
        '#markup' => $this->t('See the <a href=":available_updates">available updates</a> page for more information.', [
          ':available_updates' => Url::fromRoute('update.status')->toString(),
        ]),
      ];
    }
  }
  switch ($status) {
    case UpdateManagerInterface::NOT_SECURE:
      $requirement_label = $this->t('Not secure!');
      break;

    case UpdateManagerInterface::REVOKED:
      $requirement_label = $this->t('Revoked!');
      break;

    case UpdateManagerInterface::NOT_SUPPORTED:
      $requirement_label = $this->t('Unsupported release');
      break;

    case UpdateManagerInterface::NOT_CURRENT:
      $requirement_label = $this->t('Out of date');
      $requirement['severity'] = RequirementSeverity::Warning;
      break;

    case UpdateFetcherInterface::UNKNOWN:
    case UpdateFetcherInterface::NOT_CHECKED:
    case UpdateFetcherInterface::NOT_FETCHED:
    case UpdateFetcherInterface::FETCH_PENDING:
      $requirement_label = $project['reason'] ?? $this->t('Can not determine status');
      $requirement['severity'] = RequirementSeverity::Warning;
      break;

    default:
      $requirement_label = $this->t('Up to date');
  }
  if ($status != UpdateManagerInterface::CURRENT && $type == 'core' && isset($project['recommended'])) {
    $requirement_label .= ' ' . $this->t('(version @version available)', [
      '@version' => $project['recommended'],
    ]);
  }
  $requirement['value'] = Link::fromTextAndUrl($requirement_label, Url::fromRoute('update.status'))->toString();
  return $requirement;
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.