WebSVN – Moodle – Diff – /backup/moodle2/restore_section_task.class.php

     public function get_taskbasepath() {
         return $this->get_basepath() . '/sections/section_' . $this->info->sectionid;
+    }
+    /**
+     * Get the course module that is delegating this section.
+     *
+     * @return int|null the course module id that is delegating this section
+     */
+    public function get_delegated_cm(): ?int {
+        if (!isset($this->info->parentcmid) || empty($this->info->parentcmid)) {
+            return null;
+        }
+        return intval($this->info->parentcmid);
+    }
+    /**
+     * Get the delegated activity modname if any.
+     *
+     * @return string|null the modname of the delegated activity
+     */
+    public function get_modname(): ?string {
+        if (!isset($this->info->modname) || empty($this->info->modname)) {
+            return null;
+        }
+        return $this->info->modname;
+    }
     public function set_sectionid($sectionid) {
         $this->sectionid = $sectionid;
     /**
      * Define the common setting that any restore section will have
      */
-    protected function define_settings() {
     protected function define_settings() {
         // All the settings related to this activity will include this prefix
         $settingprefix = 'section_' . $this->info->sectionid . '_';
+        // All these are common settings to be shared by all sections.
+        $sectionincluded = $this->add_section_included_setting($settingprefix);
+        $this->add_section_userinfo_setting($settingprefix, $sectionincluded);
+    }
+    /**
+     * Add the section included setting to the task.
+     *
+     * @param string $settingprefix the identifier of the setting
+     * @return section_backup_setting the setting added
+     */
-        // All these are common settings to be shared by all sections
+    protected function add_section_included_setting(string $settingprefix): section_backup_setting {
+        global $DB;
+        // Define sectionincluded (to decide if the whole task must be really executed).
+        $settingname = $settingprefix . 'included';
-        // Define section_included (to decide if the whole task must be really executed)
+        $delegatedcmid = $this->get_delegated_cm();
-        $settingname = $settingprefix . 'included';
+        if ($delegatedcmid) {
-        $section_included = new restore_section_included_setting($settingname, base_setting::IS_BOOLEAN, true);
+            $sectionincluded = new restore_subsection_included_setting($settingname, base_setting::IS_BOOLEAN, true);
-        if (is_number($this->info->title)) {
+            // Subsections depends on the parent activity included setting.
+            $settingname = $this->get_modname() . '_' . $delegatedcmid . '_included';
+            if ($this->plan->setting_exists($settingname)) {
+                $cmincluded = $this->plan->get_setting($settingname);
+                $cmincluded->add_dependency(
-            $label = get_string('includesection', 'backup', $this->info->title);
+                    $sectionincluded,
-        } elseif (empty($this->info->title)) { // Don't throw error if title is empty, gracefully continue restore.
+                );
+            }
+            $label = get_string('subsectioncontent', 'backup');
+        } else {
+            $sectionincluded = new restore_section_included_setting($settingname, base_setting::IS_BOOLEAN, true);
+            if (is_number($this->info->title)) {
+                $label = get_string('includesection', 'backup', $this->info->title);
+            } else if (empty($this->info->title)) { // Don't throw error if title is empty, gracefully continue restore.
+                $this->log(
+                    'Section title missing in backup for section id ' . $this->info->sectionid,
+                    backup::LOG_WARNING,
+                    $this->name
-            $this->log('Section title missing in backup for section id '.$this->info->sectionid, backup::LOG_WARNING, $this->name);
+                );
+                $label = get_string('unnamedsection', 'backup');
-            $label = get_string('unnamedsection', 'backup');
+            } else {
-        } else {
-            $label = $this->info->title;
+                $label = $this->info->title;
+            }
+        }
+        $sectionincluded->get_ui()->set_label($label);
+        $this->add_setting($sectionincluded);
+        return $sectionincluded;
+    }
+    /**
+     * Add the section userinfo setting to the task.
+     *
+     * @param string $settingprefix the identifier of the setting
+     * @param section_backup_setting $includefield the section included setting
+     * @return section_backup_setting the setting added
+     */
-        }
+    protected function add_section_userinfo_setting(
-        $section_included->get_ui()->set_label($label);
+        string $settingprefix,
-        $this->add_setting($section_included);
+        section_backup_setting $includefield
     ): section_backup_setting {
-        // Define section_userinfo. Dependent of:
+        // Define sectionuserinfo. Dependent of:
-        // - users root setting
+        // - users root setting.
-        // - section_included setting.
+        // - sectionincluded setting.
         $settingname = $settingprefix . 'userinfo';
+        $defaultvalue = false;
+        if (isset($this->info->settings[$settingname]) && $this->info->settings[$settingname]) { // Only enabled when available
+            $defaultvalue = true;
+        }
+        $delegatedcmid = $this->get_delegated_cm();
+        if ($delegatedcmid) {
+            $sectionuserinfo = new restore_subsection_userinfo_setting($settingname, base_setting::IS_BOOLEAN, $defaultvalue);
+            // Subsections depends on the parent activity included setting.
+            $settingname = $this->get_modname() . '_' . $delegatedcmid . '_userinfo';
+            if ($this->plan->setting_exists($settingname)) {
+                $cmincluded = $this->plan->get_setting($settingname);
-        $defaultvalue = false;
+                $cmincluded->add_dependency(
+                    $sectionuserinfo,
+                );
         if (isset($this->info->settings[$settingname]) && $this->info->settings[$settingname]) { // Only enabled when available
-            $defaultvalue = true;
+        } else {
             $sectionuserinfo = new restore_section_userinfo_setting($settingname, base_setting::IS_BOOLEAN, $defaultvalue);
+        }
         $section_userinfo = new restore_section_userinfo_setting($settingname, base_setting::IS_BOOLEAN, $defaultvalue);
         if (!$defaultvalue) {
             // This is a bit hacky, but if there is no user data to restore, then
             // we replace the standard check-box with a select menu with the
             // single choice 'No', and the select menu is clever enough that if
+            // there is only one choice, it just displays a static string.
-            // there is only one choice, it just displays a static string.
+            //
-            //
+            // It would probably be better design to have a special UI class
+            // setting_ui_checkbox_or_no, rather than this hack, but I am not
-            // It would probably be better design to have a special UI class
+            // going to do that today.
-            // setting_ui_checkbox_or_no, rather than this hack, but I am not
+            $sectionuserinfo->set_ui(
-            // going to do that today.
+                new backup_setting_ui_select($sectionuserinfo,
-            $section_userinfo->set_ui(new backup_setting_ui_select($section_userinfo, get_string('includeuserinfo','backup'),
+                    get_string('includeuserinfo', 'backup'), [0 => get_string('no')])
-                    array(0 => get_string('no'))));
+            );
         } else {
-            $section_userinfo->get_ui()->set_label(get_string('includeuserinfo','backup'));
+            $sectionuserinfo->get_ui()->set_label(get_string('includeuserinfo', 'backup'));
+        }
+        $this->add_setting($sectionuserinfo);
-        }
-        $this->add_setting($section_userinfo);
+        // Look for "users" root setting.
         $users = $this->plan->get_setting('users');

Proyectos de Subversion Moodle

(root)/backup/moodle2/restore_section_task.class.php – Rev 1 → 1441