Change the UserPreferences to an instance class

Author: MauricioFauth

error.php

@@ -725,7 +725,7 @@
 // ============================================================================
 // If no match was found till this point, the last action is to start a
 // search with the URI the user typed in
-$fallback = (UserPreferences::$searchType === UserPreferences::URL_MANUAL ? "404manual" : "404quickref");
+$fallback = ($userPreferences->searchType === UserPreferences::URL_MANUAL ? "404manual" : "404quickref");
 mirror_redirect(
     '/search.php?show=' . $fallback . '&lang=' . urlencode($LANG) .
     '&pattern=' . substr($_SERVER['REQUEST_URI'], 1),

include/langchooser.inc

@@ -29,7 +29,6 @@
 */
 
 use phpweb\LangChooser;
-use phpweb\UserPreferences;
 
 require_once __DIR__ . '/../src/autoload.php';
 
@@ -38,7 +37,7 @@ $_SERVER['STRIPPED_URI'] = htmlspecialchars($_SERVER['REQUEST_URI'], ENT_QUOTES,
 
 // The code is encapsulated in a function,
 // so the variable namespace is not polluted
-list($LANG, $EXPL_LANG) = (new LangChooser($LANGUAGES, $INACTIVE_ONLINE_LANGUAGES, UserPreferences::$languageCode, default_language() ?: ''))->chooseCode(
+list($LANG, $EXPL_LANG) = (new LangChooser($LANGUAGES, $INACTIVE_ONLINE_LANGUAGES, $userPreferences->languageCode, default_language() ?: ''))->chooseCode(
     $_REQUEST['lang'] ?? null,
     $_SERVER['REQUEST_URI'],
     $_SERVER['HTTP_ACCEPT_LANGUAGE'] ?? null,

include/layout.inc

@@ -1,7 +1,6 @@
 <?php
 
 use phpweb\Navigation\NavItem;
-use phpweb\UserPreferences;
 
 $_SERVER['STATIC_ROOT'] = $MYSITE;
 $_SERVER['MYSITE'] = $MYSITE;
@@ -426,13 +425,13 @@ EOT;
 
 function site_header(string $title = 'Hypertext Preprocessor', array $config = []): void
 {
-    global $MYSITE;
+    global $MYSITE, $LANG;
 
     $meta_image_path = $MYSITE . 'images/meta-image.png';
     $meta_description = "PHP is a popular general-purpose scripting language that powers everything from your blog to the most popular websites in the world.";
 
     $defaults = [
-        "lang" => UserPreferences::$languageCode,
+        "lang" => $LANG,
         "current" => "",
         "meta-navigation" => [],
         'classes' => '',

include/prepend.inc

@@ -75,8 +75,10 @@ unset($COUNTRY);
 unset($ONLOAD);
 unset($LAST_UPDATED);
 
+$userPreferences = new UserPreferences();
+
 // Load the My PHP.net settings before any includes
-UserPreferences::load();
+$userPreferences->load();
 
 // Site details (mirror site information)
 include __DIR__ . '/site.inc';

my.php

@@ -16,7 +16,7 @@
 if (isset($_POST['my_lang'], $langs[$_POST['my_lang']])) {
 
     // Set the language preference
-    UserPreferences::$languageCode = $_POST['my_lang'];
+    $userPreferences->languageCode = $_POST['my_lang'];
 
     // Add this as first option, selected
     $options[] = '<option value="' . $_POST['my_lang'] . '" selected>' .
@@ -27,14 +27,14 @@
 }
 
 // We have received a cookie and it is an available language
-elseif (isset($langs[UserPreferences::$languageCode])) {
+elseif (isset($langs[$userPreferences->languageCode])) {
 
     // Add this as first option, selected
-    $options[] = '<option value="' . UserPreferences::$languageCode . '" selected>' .
-                 $langs[UserPreferences::$languageCode] . "</option>\n";
+    $options[] = '<option value="' . $userPreferences->languageCode . '" selected>' .
+                 $langs[$userPreferences->languageCode] . "</option>\n";
 
     // Remove, so it is not listed two times
-    unset($langs[UserPreferences::$languageCode]);
+    unset($langs[$userPreferences->languageCode]);
 }
 
 // We have no cookie and no form submitted
@@ -54,18 +54,18 @@
 
 // Save URL shortcut fallback setting
 if (isset($_POST['urlsearch'])) {
-    UserPreferences::setUrlSearchType($_POST['urlsearch']);
+    $userPreferences->setUrlSearchType($_POST['urlsearch']);
 }
 
 if (isset($_POST["showug"])) {
-    UserPreferences::setIsUserGroupTipsEnabled($_POST["showug"] === "enable");
+    $userPreferences->setIsUserGroupTipsEnabled($_POST["showug"] === "enable");
 }
 
 // Prepare mirror array
 $mirror_sites = $MIRRORS;
 $mirror_sites["NONE"] = [7 => MIRROR_OK];
 
-UserPreferences::save();
+$userPreferences->save();
 
 site_header("My PHP.net", ["current" => "community"]);
 ?>
@@ -177,7 +177,7 @@
 <div class="indent">
  Your setting: <input id="form-urlsearch-quickref" type="radio" name="urlsearch" value="quickref"
 <?php
-$type = UserPreferences::$searchType;
+$type = $userPreferences->searchType;
 if ($type === UserPreferences::URL_NONE || $type === UserPreferences::URL_FUNC) {
     echo ' checked="checked"';
 }
@@ -196,8 +196,8 @@
 We are experimenting with listing nearby user groups. This feature is highly experimental
 and will very likely change a lot and be broken at times.
 </p>
-<label for="showugenable">Enable UG tips</label> <input type="radio" name="showug" id="showugenable" value="enable" <?php echo UserPreferences::$isUserGroupTipsEnabled ? "checked=checked" : "" ?>><br>
-<label for="showugdisable">Disable UG tips</label> <input type="radio" name="showug" id="showugdisable" value="disable" <?php echo UserPreferences::$isUserGroupTipsEnabled ? "" : "checked=checked" ?>>
+<label for="showugenable">Enable UG tips</label> <input type="radio" name="showug" id="showugenable" value="enable" <?php echo $userPreferences->isUserGroupTipsEnabled ? "checked=checked" : "" ?>><br>
+<label for="showugdisable">Disable UG tips</label> <input type="radio" name="showug" id="showugdisable" value="disable" <?php echo $userPreferences->isUserGroupTipsEnabled ? "" : "checked=checked" ?>>
 
 <p class="center">
  <input type="submit" value="Set All Preferences">

src/UserPreferences.php

@@ -1,7 +1,15 @@
 <?php
 
+declare(strict_types=1);
+
 namespace phpweb;
 
+use function explode;
+use function in_array;
+use function is_string;
+use function join;
+use function mirror_setcookie;
+
 /**
  * Handles the "My PHP.net" preferences.
  */
@@ -13,22 +21,19 @@ final class UserPreferences
 
     public const URL_MANUAL = 'manual';
 
-    public static string $languageCode = '';
-
-    /**
-     * URL search fallback
-     *
-     * @var 'manual'|'quickref'|false
-     */
-    public static string|false $searchType = self::URL_NONE;
-
-    public static bool $isUserGroupTipsEnabled = false;
+    /** @param self::URL_* $searchType URL search fallback */
+    public function __construct(
+        public string $languageCode = '',
+        public string|false $searchType = self::URL_NONE,
+        public bool $isUserGroupTipsEnabled = false,
+    ) {
+    }
 
-    public static function load(): void
+    public function load(): void
     {
-        self::$languageCode = '';
-        self::$searchType = self::URL_NONE;
-        self::$isUserGroupTipsEnabled = false;
+        $this->languageCode = '';
+        $this->searchType = self::URL_NONE;
+        $this->isUserGroupTipsEnabled = false;
 
         if (!isset($_COOKIE['MYPHPNET']) || !is_string($_COOKIE['MYPHPNET']) || $_COOKIE['MYPHPNET'] === '') {
             return;
@@ -42,30 +47,30 @@ public static function load(): void
          * 4 - Documentation developmental server (removed)
          */
         $preferences = explode(",", $_COOKIE['MYPHPNET']);
-        self::$languageCode = $preferences[0] ?? '';
-        self::setUrlSearchType($preferences[1] ?? self::URL_NONE);
-        self::$isUserGroupTipsEnabled = isset($preferences[3]) && $preferences[3];
+        $this->languageCode = $preferences[0] ?? '';
+        $this->setUrlSearchType($preferences[1] ?? self::URL_NONE);
+        $this->isUserGroupTipsEnabled = isset($preferences[3]) && $preferences[3];
     }
 
-    public static function setUrlSearchType(mixed $type): void
+    public function setUrlSearchType(mixed $type): void
     {
         if (!in_array($type, [self::URL_FUNC, self::URL_MANUAL, self::URL_NONE], true)) {
             return;
         }
 
-        self::$searchType = $type;
+        $this->searchType = $type;
     }
 
-    public static function setIsUserGroupTipsEnabled(bool $enable): void {
+    public function setIsUserGroupTipsEnabled(bool $enable): void {
         // Show the ug tips to lucky few, depending on time.
         if ($_SERVER["REQUEST_TIME"] % 10) {
             $enable = true;
         }
 
-        self::$isUserGroupTipsEnabled = $enable;
+        $this->isUserGroupTipsEnabled = $enable;
     }
 
-    public static function save(): void
+    public function save(): void
     {
         /**
          * 0 - Language code
@@ -74,7 +79,7 @@ public static function save(): void
          * 3 - User Group tips
          * 4 - Documentation developmental server (removed)
          */
-        $preferences = [self::$languageCode, self::$searchType, '', self::$isUserGroupTipsEnabled];
+        $preferences = [$this->languageCode, $this->searchType, '', $this->isUserGroupTipsEnabled];
 
         // Set all the preferred values for a year
         mirror_setcookie("MYPHPNET", join(",", $preferences), 60 * 60 * 24 * 365);

tests/Unit/LangChooserTest.php

@@ -6,7 +6,6 @@
 
 use phpweb\LangChooser;
 use PHPUnit\Framework;
-use phpweb\UserPreferences;
 
 #[Framework\Attributes\CoversClass(LangChooser::class)]
 class LangChooserTest extends Framework\TestCase
@@ -107,9 +106,7 @@ public function testChooseCodeWithLangParameterAndManualPath(): void
 
     public function testChooseCodeWithManualPathAndUserPreference(): void
     {
-        UserPreferences::$languageCode = 'en';
-
-        $langChooser = new LangChooser(self::DEFAULT_LANGUAGE_LIST, [], '', 'en');
+        $langChooser = new LangChooser(self::DEFAULT_LANGUAGE_LIST, [], 'en', 'en');
         $result = $langChooser->chooseCode('', '/manual/de', null);
 
         self::assertSame(['de', 'de'], $result);

tests/Unit/UserPreferencesTest.php

@@ -22,11 +22,12 @@ public function testLoad(
     ): void {
         $_COOKIE = $cookie;
 
-        UserPreferences::load();
+        $userPreferences = new UserPreferences();
+        $userPreferences->load();
 
-        self::assertSame($languageCode, UserPreferences::$languageCode);
-        self::assertSame($searchType, UserPreferences::$searchType);
-        self::assertSame($isUserGroupTipsEnabled, UserPreferences::$isUserGroupTipsEnabled);
+        self::assertSame($languageCode, $userPreferences->languageCode);
+        self::assertSame($searchType, $userPreferences->searchType);
+        self::assertSame($isUserGroupTipsEnabled, $userPreferences->isUserGroupTipsEnabled);
     }
 
     /** @return array<int, array{array<string, mixed>, string, string|false, bool}> */
@@ -51,9 +52,9 @@ public static function loadCookiesProvider(): array
     #[DataProvider('urlSearchTypeProvider')]
     public function testSetUrlSearchType(mixed $type, string|false $expected): void
     {
-        UserPreferences::$searchType = UserPreferences::URL_NONE;
-        UserPreferences::setUrlSearchType($type);
-        self::assertSame($expected, UserPreferences::$searchType);
+        $userPreferences = new UserPreferences(searchType: UserPreferences::URL_NONE);
+        $userPreferences->setUrlSearchType($type);
+        self::assertSame($expected, $userPreferences->searchType);
     }
 
     /** @return array<int, array{mixed, string|false}> */
@@ -74,19 +75,19 @@ public function testSetIsUserGroupTipsEnabled(): void
         $timeBackup = $_SERVER['REQUEST_TIME'];
         $_SERVER['REQUEST_TIME'] = 1726600070;
 
-        UserPreferences::$isUserGroupTipsEnabled = false;
-        UserPreferences::setIsUserGroupTipsEnabled(true);
-        self::assertTrue(UserPreferences::$isUserGroupTipsEnabled);
+        $userPreferences = new UserPreferences(isUserGroupTipsEnabled: false);
+        $userPreferences->setIsUserGroupTipsEnabled(true);
+        self::assertTrue($userPreferences->isUserGroupTipsEnabled);
 
-        UserPreferences::$isUserGroupTipsEnabled = true;
-        UserPreferences::setIsUserGroupTipsEnabled(false);
-        self::assertFalse(UserPreferences::$isUserGroupTipsEnabled);
+        $userPreferences = new UserPreferences(isUserGroupTipsEnabled: true);
+        $userPreferences->setIsUserGroupTipsEnabled(false);
+        self::assertFalse($userPreferences->isUserGroupTipsEnabled);
 
         $_SERVER['REQUEST_TIME'] = 1726600066;
 
-        UserPreferences::$isUserGroupTipsEnabled = false;
-        UserPreferences::setIsUserGroupTipsEnabled(false);
-        self::assertTrue(UserPreferences::$isUserGroupTipsEnabled);
+        $userPreferences = new UserPreferences(isUserGroupTipsEnabled: false);
+        $userPreferences->setIsUserGroupTipsEnabled(false);
+        self::assertTrue($userPreferences->isUserGroupTipsEnabled);
 
         $_SERVER['REQUEST_TIME'] = $timeBackup;
     }