Skip to content

Commit

Permalink
Merge pull request #1190 from CuBoulder/issue/1188
Browse files Browse the repository at this point in the history 
Adds "University of Colorado Boulder" to the end of page titles
  • Loading branch information
@jcsparks @web-flow
jcsparks authored and web-flow committed Aug 8, 2024
2 parents 7097028 + d913082 commit 5382910
Show file tree
Hide file tree
Showing 2 changed files with 88 additions and 72 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

- ### Adds "University of Colorado Boulder" to the end of page titles
This update:
- [change] Adds "University of Colorado Boulder" to the end of page titles. It first checks if the site is already called that to prevent this text from being duplicated on the home page. Resolves CuBoulder/tiamat-theme#1188
- [change] Cleans up PHPCS errors in `boulder_base.theme`.
---

- ### Article List blocks: Chronological Order
### Article Aggregator Blocks
Previously Article Aggregator Blocks (includes `Article List`, `Article Feature`, `Article Grid`, `Article Slider`) could sometimes display `Articles` out of chronological order. This issue was due to the asynchronous nature of the chained API calls, which could cause Articles that required additional processing (e.g., generating a summary from the article body) to be placed out of order after processing completed while other more field complete (but potentially chronologically earlier) Articles "finished" before them.
Expand Down
154 changes: 82 additions & 72 deletions boulder_base.theme
View file
Original file line number Diff line number Diff line change
@@ -1,47 +1,50 @@
<?php

use Drupal\Core\Entity\ContentEntityBase;
use Drupal\node\Entity\Node;

/**
* @file
* Functions to support the UC Boulder D9 Base theme.
* Contains functions to support the CU Boulder Drupal 10 base theme.
*/

use Drupal\Core\Form\FormStateInterface;
use Drupal\node\Entity\Node;
use Drupal\node\NodeInterface;
use Drupal\user\Entity\User;

/**
* Implements hook_theme_suggestions_HOOK_alter().
*/
function boulder_base_theme_suggestions_page_alter(array &$suggestions, array $variables) {
if ($node = \Drupal::routeMatch()->getParameter('node')) {
$content_type = $node->bundle();
$suggestions[] = 'page__'.$content_type;
$suggestions[] = 'page__' . $content_type;
}
}

/**
* Implements hook_theme_suggestions_HOOK_alter().
*/
function boulder_base_theme_suggestions_block_alter(array &$suggestions, array $variables) {
if (isset($variables['elements']['content']['#block_content'])) {
$bundle = $variables['elements']['content']['#block_content']->bundle();
array_splice($suggestions, 1, 0, 'block__' . $bundle);
}
if (isset($variables['elements']['content']['#block_content'])) {
$bundle = $variables['elements']['content']['#block_content']->bundle();
array_splice($suggestions, 1, 0, 'block__' . $bundle);
}
}

/***
* This a helper function to set the favicon appropriately
/**
* This a helper function to set the favicon appropriately.
*/
function boulder_base_page_attachments_alter(array &$page) {
foreach($page['#attached']['html_head_link'] as $k => $v) {
foreach ($page['#attached']['html_head_link'] as $k => $v) {
if (array_key_exists('rel', $v[0]) && $v[0]['rel'] == 'icon') {
$page['#attached']['html_head_link'][$k][0]['href'] = base_path() . \Drupal::service('extension.list.theme')->getPath('boulder_base') . '/favicon.png';
}
}
$page['#attached']['drupalSettings']['themePath'] = \Drupal::theme()->getActiveTheme()->getPath(); // Exposes a relative theme path in drupalSettings
// Exposes a relative theme path in drupalSettings.
$page['#attached']['drupalSettings']['themePath'] = \Drupal::theme()->getActiveTheme()->getPath();
}

/**
* Preprocess function to check if this page is set as front page, available to all nodes
* Preprocess function to check if this page is set as front page, available to all nodes.
*/
function boulder_base_preprocess(&$variables, $hook) {
try {
Expand All @@ -54,12 +57,17 @@ function boulder_base_preprocess(&$variables, $hook) {
$variables['#cache']['contexts'][] = 'url.path.is_front';
}

/***
* Preprocess function to get the variables we'll need on the html template
/**
* Preprocess function to get the variables we'll need on the html template.
*/
function boulder_base_preprocess_html(array &$variables) {
$variables['ucb_gtm_account'] = theme_get_setting('ucb_gtm_account');
$variables['theme_path'] = base_path() . $variables['directory'];
if (\Drupal::config('system.site')->get('name') != 'University of Colorado Boulder') {
// Adds "University of Colorado Boulder" to the title of the page if the
// site isn't already called that. Resolves tiamat-theme#1188.
$variables['head_title'][] = 'University of Colorado Boulder';
}
}

/**
Expand Down Expand Up @@ -89,16 +97,16 @@ function boulder_base_preprocess_menu(array &$variables) {
}
}

/***
* Preprocess function to get the variables we'll need on the block template
/**
* Preprocess function to get the variables we'll need on the block template.
*/
function boulder_base_preprocess_block(array &$variables) {
$config = \Drupal::config('system.site');
$variables['site_name'] = $config->get('name');
}

/***
* Preprocess function to get the variables we'll need on the page template
/**
* Preprocess function to get the variables we'll need on the page template.
*/
function boulder_base_preprocess_page(array &$variables) {
$config = \Drupal::config('system.site');
Expand All @@ -117,19 +125,19 @@ function boulder_base_preprocess_page(array &$variables) {
$variables['ucb_heading_font'] = theme_get_setting('ucb_heading_font');
$useCustomLogo = theme_get_setting('ucb_use_custom_logo');
if ($useCustomLogo) {
$logoDarkURL = file_create_url(theme_get_setting('ucb_custom_logo_dark_path'));
$logoLightURL = file_create_url(theme_get_setting('ucb_custom_logo_light_path'));
$variables['ucb_custom_logo'] = [
'dark_url' => $logoDarkURL,
'light_url' => $logoLightURL,
'url' => $headerColor == '1' || $headerColor == '2' ? $logoLightURL : $logoDarkURL,
'scale' => theme_get_setting('ucb_custom_logo_scale') ?? '2x'
];
$logoDarkURL = file_create_url(theme_get_setting('ucb_custom_logo_dark_path'));
$logoLightURL = file_create_url(theme_get_setting('ucb_custom_logo_light_path'));
$variables['ucb_custom_logo'] = [
'dark_url' => $logoDarkURL,
'light_url' => $logoLightURL,
'url' => $headerColor == '1' || $headerColor == '2' ? $logoLightURL : $logoDarkURL,
'scale' => theme_get_setting('ucb_custom_logo_scale') ?? '2x',
];
}
}

/***
* Preprocess function to get the variables we'll need on the page user template
/**
* Preprocess function to get the variables we'll need on the page user template.
*/
function boulder_base_preprocess_page__user(array &$variables) {
$config = \Drupal::config('system.site');
Expand All @@ -143,8 +151,8 @@ function boulder_base_preprocess_page__user(array &$variables) {
$variables['ucb_be_boulder'] = theme_get_setting('ucb_be_boulder');
}

/***
* Preprocess function to get the variables we'll need on the page user login template
/**
* Preprocess function to get the variables we'll need on the page user login template.
*/
function boulder_base_preprocess_page__user__login(array &$variables) {
$config = \Drupal::config('system.site');
Expand All @@ -162,54 +170,55 @@ function boulder_base_preprocess_page__user__login(array &$variables) {
* Exposes theme variables to the primary menu region.
*/
function boulder_base_preprocess_region__primary_menu(array &$variables) {
$variables['ucb_secondary_menu_position'] = theme_get_setting('ucb_secondary_menu_position');
$variables['ucb_secondary_menu_position'] = theme_get_setting('ucb_secondary_menu_position');
}

/**
* Exposes theme variables to the secondary menu region.
*/
function boulder_base_preprocess_region__secondary_menu(array &$variables) {
$variables['ucb_secondary_menu_default_links'] = theme_get_setting('ucb_secondary_menu_default_links');
$variables['ucb_secondary_menu_position'] = theme_get_setting('ucb_secondary_menu_position');
$variables['ucb_secondary_menu_button_display'] = theme_get_setting('ucb_secondary_menu_button_display');
$variables['ucb_secondary_menu_default_links'] = theme_get_setting('ucb_secondary_menu_default_links');
$variables['ucb_secondary_menu_position'] = theme_get_setting('ucb_secondary_menu_position');
$variables['ucb_secondary_menu_button_display'] = theme_get_setting('ucb_secondary_menu_button_display');
}

/**
* Preprocess function to show or hide the breadcrumb nav based on the selected setting
* Preprocess function to show or hide the breadcrumb nav based on the selected setting.
*/
function boulder_base_preprocess_region__breadcrumb(array &$variables) {
$variables['show_breadcrumb'] = theme_get_setting('ucb_breadcrumb_nav');
$variables['show_breadcrumb'] = theme_get_setting('ucb_breadcrumb_nav');
}

/**
* Preprocess function to enable the current page title to show up in the breadcrumb nav
* Preprocess function to enable the current page title to show up in the breadcrumb nav.
*/
function boulder_base_preprocess_breadcrumb(array &$variables) {
$variables['current_page_title'] = \Drupal::service('title_resolver')->getTitle(\Drupal::request(), \Drupal::routeMatch()->getRouteObject());
$variables['#cache']['contexts'][] = 'url';
$node = \Drupal::routeMatch()->getParameter('node');
if ($node instanceof \Drupal\node\NodeInterface)
$variables['#cache']['tags'][] = 'node:' . $node->id();
$variables['current_page_title'] = \Drupal::service('title_resolver')->getTitle(\Drupal::request(), \Drupal::routeMatch()->getRouteObject());
$variables['#cache']['contexts'][] = 'url';
$node = \Drupal::routeMatch()->getParameter('node');
if ($node instanceof NodeInterface) {
$variables['#cache']['tags'][] = 'node:' . $node->id();
}
}

/***
* Preprocess function to get the variables we'll need on the header region template
/**
* Preprocess function to get the variables we'll need on the header region template.
*/
function boulder_base_preprocess_region__header(array &$variables) {
$variables['theme_path'] = base_path() . $variables['directory'];
$variables['ucb_be_boulder'] = theme_get_setting('ucb_be_boulder');
}

/***
* Preprocess function to get the variables we'll need on the footer region template
/**
* Preprocess function to get the variables we'll need on the footer region template.
*/
function boulder_base_preprocess_region__site_information(array &$variables) {
$variables['theme_path'] = base_path() . $variables['directory'];
$variables['ucb_be_boulder'] = theme_get_setting('ucb_be_boulder');
}

/***
* preprocess function to get the variables we'll need on the Organization node template
/**
* Preprocess function to get the variables we'll need on the Organization node template.
*/
function boulder_base_preprocess_node__organization(array &$variables) {
$variables['uuid'] = $variables['node']->uuid();
Expand All @@ -219,35 +228,36 @@ function boulder_base_preprocess_node__organization(array &$variables) {
* Exposes a variable to indicate if a user can edit a node.
*/
function boulder_base_preprocess_node__ucb_article(array &$variables) {
if ($node = \Drupal::routeMatch()->getParameter('node')) {
$user = \Drupal\user\Entity\User::load(\Drupal::currentUser()->id());
$userCanEdit = $node->access('update', $user);
$variables['user_can_edit'] = $userCanEdit;
}
}

/***
* Custom theme settings worker function
***/
function boulder_base_form_system_theme_settings_alter(&$form, \Drupal\Core\Form\FormStateInterface &$form_state, $form_id = NULL)
{
if ($node = \Drupal::routeMatch()->getParameter('node')) {
$user = User::load(\Drupal::currentUser()->id());
$userCanEdit = $node->access('update', $user);
$variables['user_can_edit'] = $userCanEdit;
}
}

/**
* Custom theme settings worker function.
*/
function boulder_base_form_system_theme_settings_alter(&$form, FormStateInterface &$form_state, $form_id = NULL) {
// Work-around for a core bug affecting admin themes. See issue #943212.
if (isset($form_id)) {
return;
}

if(\Drupal::service('module_handler')->moduleExists('ucb_site_configuration')) {
// This call relies on the module dependency `ucb_site_configuration`.
// It uses the function `buildThemeSettingsForm` in the module to build the theme settings form.
\Drupal::service('ucb_site_configuration')->buildThemeSettingsForm($form, $form_state);
} else {
\Drupal::service('messenger')->addError('Module `CU Boulder Site Configuration`, required to display the CU Boulder theme settings form, isn\'t installed.');
if (\Drupal::service('module_handler')->moduleExists('ucb_site_configuration')) {
// This call relies on the module dependency `ucb_site_configuration`.
// It uses the function `buildThemeSettingsForm` in the module to build the
// theme settings form.
\Drupal::service('ucb_site_configuration')->buildThemeSettingsForm($form, $form_state);
}
else {
\Drupal::service('messenger')->addError('Module `CU Boulder Site Configuration`, required to display the CU Boulder theme settings form, isn\'t installed.');
}
}

/*
* This is for list styles during migration
*/
/**
* This is for list styles during migration.
*/
function boulder_base_page_attachments(array &$attachments) {
$attachments['#attached']['library'][] = 'boulder_base/migrate_styles';
}
}

0 comments on commit 5382910

Please sign in to comment.