path: root/Zotlabs/Lib/Traits/HelpHelperTrait.php

<?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 = '';

	/**
	 * Associative array containing the detected language.
	 */
	private array $lang = [
		'language' => 'en',		//! Detected language, 2-letter ISO 639-1 code ("en")
		'from_url' => false,	//! true if language from URL overrides browser default
		'missing' => false,		//! true if topic not found in detected language
	];

	/**
	 * 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)) {
			$this->lang['language']	= argv(1);
			$this->lang['from_url'] = true;
		} else {
			if(isset(\App::$language)) {
				$this->lang['language'] = \App::$language;
			}

			$this->lang['from_url'] = false;
		}
	}

	/**
	 * 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_with_lang = "doc/{$lang}/${base_path}";

		foreach ($valid_file_ext as $ext) {
			$path = "{$base_path_with_lang}.{$ext}";
			if (file_exists($path)) {
				$this->file_name = $path;
				$this->file_type = $ext;

				break;
			}
		}

		if (empty($this->file_name) && $lang !== 'en') {
			$this->lang['missing'] = true;
			$this->find_help_file($base_path, 'en');
		}
	}

	public function missing_translation(): bool {
		return !!$this->lang['missing'];
	}

	public function missing_translation_message(): string {
		$prefered_language_name = get_language_name(
			$this->lang['language'],
			$this->lang['language']
		);

		return bbcode(
			t("This page is not yet available in {$prefered_language_name}. See [observer.baseurl]/help/developer/developer_guide#Translations for information about how to help.")
		);
	}
}