Skip to content

Add ability to add multiple sub-templates #8381

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Sesquipedalian merged 7 commits into from
Jan 1, 2025
Merged

Add ability to add multiple sub-templates #8381

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
7e42108
Add ability to add multiple sub-templates
live627 Dec 29, 2024
384de12
Update Sources/Theme.php
live627 Dec 30, 2024
ef862f1
reverse indentation
live627 Dec 30, 2024
bc51997
ensure that only string is sent to debug
live627 Dec 30, 2024
0f1f4d1
no need to die violently if a given sub-template was not found
live627 Dec 30, 2024
36168cf
formatting
live627 Dec 30, 2024
f69a6d7
reverse indentation
live627 Dec 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
95 changes: 66 additions & 29 deletions Sources/Theme.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -391,39 +391,82 @@ public static function loadTemplate(string|bool $template_name, array|string $st
}

/**
* Loads a sub-template.
* Loads sub-templates into the current theme context.
*
* - Loads the sub template specified by sub_template_name, which must be
* in an already-loaded template.
* This method loads each sub-template in the `sub_templates` array. If it is
* not defined, loads a single sub-template specified by `sub_template` or
* falls back to loading the `main` template.
*/
public static function loadSubTemplates(): void
{
if (isset(Utils::$context['sub_templates'])) {
foreach (Utils::$context['sub_templates'] as $sub_template) {
self::loadSubTemplate($sub_template);
}
} else {
self::loadSubTemplate(Utils::$context['sub_template'] ?? 'main');
}
}

/**
* Loads a sub-template.
*
* - If ?debug is in the query string, shows administrators a marker after
* every sub template for debugging purposes.
* This function attempts to load and execute a sub-template by constructing its function name
* and calling it dynamically. If the sub-template cannot be loaded, it handles errors based
* on the `$fatal` parameter.
*
* @todo get rid of reading $_REQUEST directly
* - Sub-template function names must follow the format `template_{name}`.
* - When debugging is enabled, administrators can see markers after each loaded sub-template.
*
* @param string $sub_template_name The name of the sub-template to load
* @param bool|string $fatal Whether to die with an error if the sub-template can't be loaded
* @param string|array $sub_template_name The name of the sub-template to load.
* If an array is provided, the first element is the name,
* and the second element is an array of parameters to pass to the sub-template.
* @param bool|string $fatal Specifies error handling behavior:
* - `false` (default): Logs and handles the error.
* - `true`: Dies with an error message.
* - `'ignore'`: Silently ignore any errors.
*/
public static function loadSubTemplate(string $sub_template_name, bool|string $fatal = false): void
public static function loadSubTemplate(string|array $sub_template_name, bool|string $fatal = false): void
{
$template_name = is_array($sub_template_name) ? $sub_template_name[0] : $sub_template_name;

// Add the sub-template to the debug context if debugging is enabled.
if (!empty(Config::$db_show_debug)) {
Utils::$context['debug']['sub_templates'][] = $sub_template_name;
Utils::$context['debug']['sub_templates'][] = $template_name;
}

// Figure out what the template function is named.
$theme_function = 'template_' . $sub_template_name;
// Determine the template function name and any associated parameters.
if (is_array($sub_template_name)) {
$theme_function = 'template_' . $sub_template_name[0];
$function_params = $sub_template_name[1] ?? [];
} else {
$theme_function = 'template_' . $sub_template_name;
$function_params = [];
}

if (function_exists($theme_function)) {
$theme_function();
} elseif ($fatal === false) {
ErrorHandler::fatalLang('theme_template_error', 'template', ['template_name' => (string) $sub_template_name, 'type' => 'sub']);
} elseif ($fatal !== 'ignore') {
die(ErrorHandler::log(Lang::formatText(Lang::$txt['theme_template_error'] ?? 'Unable to load the {template_name} sub-template.', ['template_name' => (string) $sub_template_name, 'type' => 'sub']), 'template'));
// Attempt to call the sub-template function.
if (is_callable($theme_function)) {
call_user_func_array($theme_function, $function_params);
} else {
// Handle errors based on the $fatal parameter.
if ($fatal === false) {
ErrorHandler::fatalLang(
'theme_template_error',
'template',
['template_name' => $template_name, 'type' => 'sub']
);
} elseif ($fatal !== 'ignore') {
$error_message = Lang::formatText(
Lang::$txt['theme_template_error'] ?? 'Unable to load the {template_name} sub-template.',
['template_name' => $template_name, 'type' => 'sub']
);
die(ErrorHandler::log($error_message, 'template'));
}
}

// Are we showing debugging for templates? Just make sure not to do it before the doctype...
if (isset(User::$me) && User::$me->allowedTo('admin_forum') && isset($_REQUEST['debug']) && !in_array($sub_template_name, ['init', 'main_below']) && ob_get_length() > 0 && !isset($_REQUEST['xml'])) {
echo "\n" . '<div class="noticebox">---- ', $sub_template_name, ' ends ----</div>';
// Show debug markers for administrators if enabled.
if (isset(User::$me) && User::$me->allowedTo('admin_forum') && isset($_REQUEST['debug']) && !in_array($template_name, ['init', 'html_below']) && ob_get_length() > 0 && !isset($_REQUEST['xml'])) {
echo "\n" . '<div class="noticebox">---- ', $template_name, ' ends ----</div>';
}
}

Expand Down Expand Up @@ -1290,18 +1333,12 @@ public static function template_header(): void

header('content-type: text/' . (isset($_REQUEST['xml']) ? 'xml' : 'html') . '; charset=' . (empty(Utils::$context['character_set']) ? 'ISO-8859-1' : Utils::$context['character_set']));

// We need to splice this in after the body layer, or after the main layer for older stuff.
// We need to splice this in after the body layer.
if (Utils::$context['in_maintenance'] && User::$me->is_admin) {
$position = array_search('body', Utils::$context['template_layers']);

if ($position === false) {
$position = array_search('main', Utils::$context['template_layers']);
}

if ($position !== false) {
$before = array_slice(Utils::$context['template_layers'], 0, $position + 1);
$after = array_slice(Utils::$context['template_layers'], $position + 1);
Utils::$context['template_layers'] = array_merge($before, ['maint_warning'], $after);
array_splice(Utils::$context['template_layers'], $position + 1, 0, ['maint_warning']);
Copy link
Contributor

@dragomano dragomano Dec 29, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By the way, what is maint_warning? Maybe main_warning, main, or warning?

Copy link
Member

@Sesquipedalian Sesquipedalian Dec 30, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maintenance warning.

}
}

Expand Down
4 changes: 2 additions & 2 deletions Sources/Utils.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2347,7 +2347,6 @@ public static function obExit(?bool $header = null, ?bool $do_footer = null, boo
],
);
}

}

// Start up the session URL fixer.
Expand Down Expand Up @@ -2385,7 +2384,7 @@ public static function obExit(?bool $header = null, ?bool $do_footer = null, boo
}

if ($do_footer) {
Theme::loadSubTemplate(Utils::$context['sub_template'] ?? 'main');
Theme::loadSubTemplates();

// Anything special to put out?
if (!empty(Utils::$context['insert_after_template']) && !isset($_REQUEST['xml'])) {
Expand All @@ -2397,6 +2396,7 @@ public static function obExit(?bool $header = null, ?bool $do_footer = null, boo
$footer_done = true;
Theme::template_footer();

// Add $db_show_debug = true; to Settings.php if you want to show the debugging information.
// (since this is just debugging... it's okay that it's after </html>.)
if (!isset($_REQUEST['xml'])) {
Logging::displayDebug();
Expand Down
Loading