Simplify sections preferences code (MDL-74977)

Author: james-cnz

lib.php

@@ -647,7 +647,7 @@ public function get_sections_preferences(): array {
             return $coursesections;
         }
 
-        $sectionpreferences = $this->fmt_set_get_sections_preferences();
+        $sectionpreferences = $this->get_sections_preferences_by_preference();
 
         foreach ($sectionpreferences as $preference => $sectionids) {
             if (!empty($sectionids) && is_array($sectionids)) {
@@ -670,29 +670,6 @@ public function get_sections_preferences(): array {
      * @return array of preferences indexed by preference name
      */
     public function get_sections_preferences_by_preference(): array {
-        return $this->fmt_set_get_sections_preferences();
-    }
-
-    /**
-     * Set the format section preferences.
-     *
-     * @param string $preferencename preference name
-     * @param int[] $sectionids affected section IDs
-     *
-     */
-    public function set_sections_preference(string $preferencename, array $sectionids): void {
-        $this->fmt_set_get_sections_preferences($preferencename, $sectionids);
-    }
-
-    /**
-     * Set and return the format section preferences.
-     *
-     * @param string|null $preferencename preference name
-     * @param int[]|null $sectionids affected section IDs
-     * @return array of preferences indexed by section ID
-     *
-     */
-    protected function fmt_set_get_sections_preferences(?string $preferencename = null, ?array $sectionids = null): array {
 
         $course = $this->get_course();
         $sectionsextra = $this->fmt_get_sections_extra();
@@ -708,23 +685,23 @@ protected function fmt_set_get_sections_preferences(?string $preferencename = nu
             if ($prefname != 'fmtcollapsedset') {
                 foreach ($sectids as $i => $sectionid) {
                     if (!isset($sectionsextra[$sectionid])) {
-                        unset($sectids[$i]);
+                        $sectionpreferences[$prefname][$i] = 0;
                     } else if ($prefname == 'contentcollapsed') {
                         $contentcollapsedindexed[$sectionid] = true;
                     }
                 }
             }
         }
 
-        // Try autocollapsing content.
+        // Figure out autocollapse changes.
         $sectionidsold = $sectionpreferences['contentcollapsed'] ?? null;
         $collapsedset = $collapsedsetold;
         $autocollapsedchanged = false;
         foreach ($sectionsextra as $sectionid => $sectionextra) {
             $section = $sectionextra->sectionbase;
             if (
-                $sectionid > $collapsedsetold
-                && $sectionextra->levelsan >= FORMAT_MULTITOPIC_SECTION_LEVEL_TOPIC
+                ($sectionid > $collapsedsetold)
+                && ($sectionextra->levelsan >= FORMAT_MULTITOPIC_SECTION_LEVEL_TOPIC)
                 && ((($section->collapsible != '') ? $section->collapsible : $course->collapsible) != '0')
                 && !isset($contentcollapsedindexed[$sectionid])
             ) {
@@ -737,10 +714,12 @@ protected function fmt_set_get_sections_preferences(?string $preferencename = nu
             $collapsedset = max($collapsedset, $sectionid);
         }
         $sectionpreferences['fmtcollapsedset'] = [ $collapsedset ];
+
+        // Try writing autocollapse changes.
         $collapsedsetupdated = false;
         if ($autocollapsedchanged) {
             try {
-                $this->fmt_set_sections_preferences_sub($sectionpreferences);
+                $this->persist_to_user_preference($sectionpreferences);
                 $collapsedsetupdated = true;
             } catch (coding_exception $e) {
                 if (isset($sectionidsold)) {
@@ -751,71 +730,30 @@ protected function fmt_set_get_sections_preferences(?string $preferencename = nu
             }
         }
 
-        // Try writing specified changes.
-        $error = null;
-        if ($preferencename) {
-            $sectionidsold = $sectionpreferences[$preferencename] ?? null;
-            $sectionpreferences[$preferencename] = $sectionids;
+        // If nothing else, try writing last seen section.
+        if (!$collapsedsetupdated && ($collapsedset > $collapsedsetold)) {
             try {
-                $this->fmt_set_sections_preferences_sub($sectionpreferences);
-                $collapsedsetupdated = true;
+                $this->persist_to_user_preference($sectionpreferences);
             } catch (coding_exception $e) {
-                $error = $e;  // We may want to rethrow this.
-            }
-
-            // Try writing specified changes without last seen section.
-            if (
-                $error && isset($sectionidsold) && count($sectionids) < count($sectionidsold)
-                && !$collapsedsetupdated && $collapsedset > $collapsedsetold
-            ) {
-                $error = null;
                 if ($collapsedsetold > 0) {
                     $sectionpreferences['fmtcollapsedset'] = [ $collapsedsetold ];
                 } else {
                     unset($sectionpreferences['fmtcollapsedset']);
                 }
-                try {
-                    $this->fmt_set_sections_preferences_sub($sectionpreferences);
-                } catch (coding_exception $e) {
-                    $error = $e;  // We will want to rethrow this.
-                }
-            }
-
-            if ($error) {
-                if (isset($sectionidsold)) {
-                    $sectionpreferences[$preferencename] = $sectionidsold;
-                } else {
-                    unset($sectionpreferences[$preferencename]);
-                }
-            }
-        }
-
-        // If nothing else, try writing last seen section.
-        if (!$collapsedsetupdated && $collapsedset > $collapsedsetold) {
-            $sectionpreferences['fmtcollapsedset'] = [ $collapsedset ];
-            try {
-                $this->fmt_set_sections_preferences_sub($sectionpreferences);
-                $collapsedsetupdated = true;
-            } catch (coding_exception $e) {
-                // Do nothing, because there's nothing we can do.
-                $collapsedsetupdated = false;
             }
         }
 
-        if ($error) {
-            throw $error;
-        }
-
         return $sectionpreferences;
     }
 
     /**
-     * Set the format section preferences, given all preferences indexed by preference.
-     *
-     * @param array $sectionpreferences of preferences indexed by preference
+     * Persist the section preferences to the user preferences.
      *
+     * @param array $sectionpreferences the section preferences
      */
-    protected function fmt_set_sections_preferences_sub(array $sectionpreferences): void {
+    protected function persist_to_user_preference(
+        array $sectionpreferences,
+    ): void {
         global $USER;
         $course = $this->get_course();
         set_user_preference('coursesectionspreferences_' . $course->id, json_encode($sectionpreferences), $USER->id);