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

     public function get_moduleid() {
         return $this->moduleid;
+    }
+    /**
+     * Return if the activity is inside a subsection.
+     *
+     * @return bool
+     */
+    public function is_in_subsection(): bool {
+        return !empty($this->info->insubsection);
+    }
     /**
      * Returns the old course module id (cmid of activity which will be restored)
+     *
      * @return int
      */
     /**
      * Define the common setting that any restore activity will have
      */
-    protected function define_settings() {
     protected function define_settings() {
         // All the settings related to this activity will include this prefix
         $settingprefix = $this->info->modulename . '_' . $this->info->moduleid . '_';
+        // All these are common settings to be shared by all activities
+        $activityincluded = $this->add_activity_included_setting($settingprefix);
+        $this->add_activity_userinfo_setting($settingprefix, $activityincluded);
+        // End of common activity settings, let's add the particular ones.
+        $this->define_my_settings();
+    }
+    /**
+     * Add the activity included setting to the task.
+     *
+     * @param string $settingprefix the identifier of the setting
+     * @return activity_backup_setting the setting added
-        // All these are common settings to be shared by all activities
+     */
+    protected function add_activity_included_setting(string $settingprefix): activity_backup_setting {
-        // Define activity_include (to decide if the whole task must be really executed)
+        // Define activity_included (to decide if the whole task must be really executed)
         // Dependent of:
+        // - activities root setting.
+        // - sectionincluded setting (if exists).
+        $settingname = $settingprefix . 'included';
-        // - activities root setting
+        if ($this->is_in_subsection()) {
+            $activityincluded = new restore_subactivity_generic_setting($settingname, base_setting::IS_BOOLEAN, true);
+        } else {
-        // - section_included setting (if exists)
+            $activityincluded = new restore_activity_generic_setting($settingname, base_setting::IS_BOOLEAN, true);
-        $settingname = $settingprefix . 'included';
+        }
-        $activity_included = new restore_activity_generic_setting($settingname, base_setting::IS_BOOLEAN, true);
-        $activity_included->get_ui()->set_icon(new image_icon('monologo', get_string('pluginname', $this->modulename),
+        $activityincluded->get_ui()->set_icon(new image_icon('monologo', get_string('pluginname', $this->modulename),
-            $this->modulename, array('class' => 'iconlarge icon-post ml-1')));
+            $this->modulename, ['class' => 'ms-1']));
-        $this->add_setting($activity_included);
+        $this->add_setting($activityincluded);
-        // Look for "activities" root setting
+        // Look for "activities" root setting.
         $activities = $this->plan->get_setting('activities');
-        $activities->add_dependency($activity_included);
+        $activities->add_dependency($activityincluded);
-        // Look for "section_included" section setting (if exists)
+        // Look for "sectionincluded" section setting (if exists).
         $settingname = 'section_' . $this->info->sectionid . '_included';
         if ($this->plan->setting_exists($settingname)) {
+            $sectionincluded = $this->plan->get_setting($settingname);
+            $sectionincluded->add_dependency($activityincluded);
+        }
+        return $activityincluded;
+    }
+    /**
+     * Add the activity userinfo setting to the task.
+     *
+     * @param string $settingprefix the identifier of the setting
+     * @param activity_backup_setting $includefield the activity included setting
+     * @return activity_backup_setting the setting added
+     */
-            $section_included = $this->plan->get_setting($settingname);
+    protected function add_activity_userinfo_setting(
-            $section_included->add_dependency($activity_included);
+        string $settingprefix,
-        }
+        activity_backup_setting $includefield
+    ): activity_backup_setting {
-        // Define activity_userinfo. Dependent of:
+        // Define activityuserinfo. Dependent of:
-        // - users root setting
+        // - users root setting.
-        // - section_userinfo setting (if exists)
+        // - sectionuserinfo setting (if exists).
-        // - activity_included setting.
+        // - activity included setting.
         $settingname = $settingprefix . 'userinfo';
+        $defaultvalue = false;
+        if (isset($this->info->settings[$settingname]) && $this->info->settings[$settingname]) { // Only enabled when available
+            $defaultvalue = true;
-        $defaultvalue = false;
+        }
+        if ($this->is_in_subsection()) {
-        if (isset($this->info->settings[$settingname]) && $this->info->settings[$settingname]) { // Only enabled when available
+            $activityuserinfo = new restore_subactivity_userinfo_setting($settingname, base_setting::IS_BOOLEAN, $defaultvalue);
-            $defaultvalue = true;
+        } else {
             $activityuserinfo = new restore_activity_userinfo_setting($settingname, base_setting::IS_BOOLEAN, $defaultvalue);
+        }
         $activity_userinfo = new restore_activity_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
-            //
+            // going to do that today.
+            $activityuserinfo->set_ui(
+                new backup_setting_ui_select(
-            // It would probably be better design to have a special UI class
+                    $activityuserinfo,
-            // setting_ui_checkbox_or_no, rather than this hack, but I am not
+                    '-',
-            // going to do that today.
+                    [0 => get_string('no')]
-            $activity_userinfo->set_ui(new backup_setting_ui_select($activity_userinfo, '-',
+                )
-                    array(0 => get_string('no'))));
+            );
         } else {
-            $activity_userinfo->get_ui()->set_label('-');
+            $activityuserinfo->get_ui()->set_label('-');
         }
-        $this->add_setting($activity_userinfo);
+        $this->add_setting($activityuserinfo);
-        // Look for "users" root setting
+        // Look for "users" root setting.
         $users = $this->plan->get_setting('users');
-        $users->add_dependency($activity_userinfo);
+        $users->add_dependency($activityuserinfo);
-        // Look for "section_userinfo" section setting (if exists)
-        $settingname = 'section_' . $this->info->sectionid . '_userinfo';
+        // Look for "sectionuserinfo" section setting (if exists).
-        if ($this->plan->setting_exists($settingname)) {
+        $settingname = 'section_' . $this->info->sectionid . '_userinfo';
-            $section_userinfo = $this->plan->get_setting($settingname);
+        if ($this->plan->setting_exists($settingname)) {
-            $section_userinfo->add_dependency($activity_userinfo);
+            $sectionuserinfo = $this->plan->get_setting($settingname);
             $sectionuserinfo->add_dependency($activityuserinfo);

Proyectos de Subversion Moodle

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