function template_preprocess_update_project_status
Same name in other branches
- 9 core/modules/update/update.report.inc \template_preprocess_update_project_status()
- 8.9.x core/modules/update/update.report.inc \template_preprocess_update_project_status()
- 11.x core/modules/update/update.report.inc \template_preprocess_update_project_status()
Prepares variables for update project status templates.
Default template: update-project-status.html.twig.
Parameters
array $variables: An associative array containing:
- project: An array of information about the project.
File
-
core/
modules/ update/ update.report.inc, line 146
Code
function template_preprocess_update_project_status(&$variables) {
// Storing by reference because we are sorting the project values.
$project =& $variables['project'];
// Set the project title and URL.
$variables['title'] = isset($project['title']) ? $project['title'] : $project['name'];
$variables['url'] = isset($project['link']) ? Url::fromUri($project['link'])->toString() : NULL;
$variables['install_type'] = $project['install_type'];
if ($project['install_type'] == 'dev' && !empty($project['datestamp'])) {
$variables['datestamp'] = \Drupal::service('date.formatter')->format($project['datestamp'], 'custom', 'Y-M-d');
}
$variables['existing_version'] = $project['existing_version'];
$versions_inner = [];
$security_class = [];
$version_class = [];
if (isset($project['recommended'])) {
if ($project['status'] != UpdateManagerInterface::CURRENT || $project['existing_version'] !== $project['recommended']) {
// First, figure out what to recommend.
// If there's only 1 security update and it has the same version we're
// recommending, give it the same CSS class as if it was recommended,
// but don't print out a separate "Recommended" line for this project.
if (!empty($project['security updates']) && count($project['security updates']) == 1 && $project['security updates'][0]['version'] === $project['recommended']) {
$security_class[] = 'project-update__version--recommended';
$security_class[] = 'project-update__version---strong';
}
else {
$version_class[] = 'project-update__version--recommended';
// Apply an extra class if we're displaying both a recommended
// version and anything else for an extra visual hint.
if ($project['recommended'] !== $project['latest_version'] || !empty($project['also']) || $project['install_type'] == 'dev' && isset($project['dev_version']) && $project['latest_version'] !== $project['dev_version'] && $project['recommended'] !== $project['dev_version'] || isset($project['security updates'][0]) && $project['recommended'] !== $project['security updates'][0]) {
$version_class[] = 'project-update__version--recommended-strong';
}
$versions_inner[] = [
'#theme' => 'update_version',
'#version' => $project['releases'][$project['recommended']],
'#title' => t('Recommended version:'),
'#attributes' => [
'class' => $version_class,
],
];
}
// Now, print any security updates.
if (!empty($project['security updates'])) {
$security_class[] = 'version-security';
foreach ($project['security updates'] as $security_update) {
$versions_inner[] = [
'#theme' => 'update_version',
'#version' => $security_update,
'#title' => t('Security update:'),
'#attributes' => [
'class' => $security_class,
],
];
}
}
}
if ($project['recommended'] !== $project['latest_version']) {
$versions_inner[] = [
'#theme' => 'update_version',
'#version' => $project['releases'][$project['latest_version']],
'#title' => t('Latest version:'),
'#attributes' => [
'class' => [
'version-latest',
],
],
];
}
if ($project['install_type'] == 'dev' && $project['status'] != UpdateManagerInterface::CURRENT && isset($project['dev_version']) && $project['recommended'] !== $project['dev_version']) {
$versions_inner[] = [
'#theme' => 'update_version',
'#version' => $project['releases'][$project['dev_version']],
'#title' => t('Development version:'),
'#attributes' => [
'class' => [
'version-latest',
],
],
];
}
}
if (isset($project['also'])) {
foreach ($project['also'] as $also) {
$versions_inner[] = [
'#theme' => 'update_version',
'#version' => $project['releases'][$also],
'#title' => t('Also available:'),
'#attributes' => [
'class' => [
'version-also-available',
],
],
];
}
}
if (!empty($versions_inner)) {
$variables['versions'] = $versions_inner;
}
if (!empty($project['disabled'])) {
sort($project['disabled']);
$variables['disabled'] = $project['disabled'];
}
sort($project['includes']);
$variables['includes'] = $project['includes'];
$variables['extras'] = [];
if (!empty($project['extra'])) {
foreach ($project['extra'] as $value) {
$extra_item = [];
$extra_item['attributes'] = new Attribute();
$extra_item['label'] = $value['label'];
$extra_item['data'] = [
'#prefix' => '<em>',
'#markup' => $value['data'],
'#suffix' => '</em>',
];
$variables['extras'][] = $extra_item;
}
}
// Set the project status details.
$status_label = NULL;
switch ($project['status']) {
case UpdateManagerInterface::NOT_SECURE:
$status_label = t('Security update required!');
break;
case UpdateManagerInterface::REVOKED:
$status_label = t('Revoked!');
break;
case UpdateManagerInterface::NOT_SUPPORTED:
$status_label = t('Not supported!');
break;
case UpdateManagerInterface::NOT_CURRENT:
$status_label = t('Update available');
break;
case UpdateManagerInterface::CURRENT:
$status_label = t('Up to date');
break;
}
$variables['status']['label'] = $status_label;
$variables['status']['attributes'] = new Attribute();
$variables['status']['reason'] = isset($project['reason']) ? $project['reason'] : NULL;
switch ($project['status']) {
case UpdateManagerInterface::CURRENT:
$uri = 'core/misc/icons/73b355/check.svg';
$text = t('Ok');
break;
case UpdateFetcherInterface::UNKNOWN:
case UpdateFetcherInterface::FETCH_PENDING:
case UpdateFetcherInterface::NOT_FETCHED:
$uri = 'core/misc/icons/e29700/warning.svg';
$text = t('Warning');
break;
case UpdateManagerInterface::NOT_SECURE:
case UpdateManagerInterface::REVOKED:
case UpdateManagerInterface::NOT_SUPPORTED:
$uri = 'core/misc/icons/e32700/error.svg';
$text = t('Error');
break;
case UpdateFetcherInterface::NOT_CHECKED:
case UpdateManagerInterface::NOT_CURRENT:
default:
$uri = 'core/misc/icons/e29700/warning.svg';
$text = t('Warning');
break;
}
$variables['status']['icon'] = [
'#theme' => 'image',
'#width' => 18,
'#height' => 18,
'#uri' => $uri,
'#alt' => $text,
'#title' => $text,
];
}
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.