From bfa81490c1085978f6431e06025e2794f7232768 Mon Sep 17 00:00:00 2001
From: Harald Eilertsen <haraldei@anduin.net>
Date: Fri, 3 May 2024 13:00:14 +0200
Subject: Rename HelpHelper to HelpHelperTrait.

PHPCS prefers traits to be suffixed with "Trait", and I think I agree.
---
 Zotlabs/Lib/Traits/HelpHelperTrait.php | 68 ++++++++++++++++++++++++++++++++++
 1 file changed, 68 insertions(+)
 create mode 100644 Zotlabs/Lib/Traits/HelpHelperTrait.php

(limited to 'Zotlabs/Lib/Traits/HelpHelperTrait.php')

diff --git a/Zotlabs/Lib/Traits/HelpHelperTrait.php b/Zotlabs/Lib/Traits/HelpHelperTrait.php
new file mode 100644
index 000000000..b7711bbd5
--- /dev/null
+++ b/Zotlabs/Lib/Traits/HelpHelperTrait.php
@@ -0,0 +1,68 @@
+<?php
+
+namespace Zotlabs\Lib\Traits;
+
+use CommerceGuys\Intl\Language\LanguageRepository;
+
+trait HelpHelperTrait {
+
+	// PHP versions before 8.2 does not support trait constants,
+	// Leave this commented out until we drop support for PHP 8.1.
+	//
+	// const VALID_FILE_EXT = ['md', 'bb', 'html'];
+
+	private string $file_name = '';
+	private string $file_type = '';
+
+	/**
+	 * Determines help language.
+	 *
+	 * If the language was specified in the URL, override the language preference
+	 * of the browser. Default to English if both of these are absent.
+	 *
+	 * Updates the `$lang` property of the module.
+	 */
+	private function determine_help_language() {
+
+		$language_repository = new LanguageRepository;
+		$languages = $language_repository->getList();
+
+		if(array_key_exists(argv(1), $languages)) {
+			$lang = argv(1);
+			$from_url = true;
+		} else {
+			$lang = \App::$language;
+			if(! isset($lang))
+				$lang = 'en';
+
+			$from_url = false;
+		}
+
+		$this->lang =  array('language' => $lang, 'from_url' => $from_url);
+	}
+
+	/**
+	 * Find the full path name of the file, given it's base path and
+	 * the language of the request.
+	 *
+	 * @param string $base_path		The path of the file to find, relative to the
+	 *	doc root path, and without the extension.
+	 */
+	private function find_help_file(string $base_path, string $lang): void {
+
+		// Use local variable until we can use trait constants.
+		$valid_file_ext = ['md', 'bb', 'html'];
+
+		$base_path = "doc/{$lang}/${base_path}";
+
+		foreach ($valid_file_ext as $ext) {
+			$path = "{$base_path}.{$ext}";
+			if (file_exists($path)) {
+				$this->file_name = $path;
+				$this->file_type = $ext;
+
+				break;
+			}
+		}
+	}
+}
-- 
cgit v1.2.3