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

  */
 abstract class backup_activity_task extends backup_task {
     protected $moduleid;
+    protected $sectionid;
+    /** @var stdClass the section object */
-    protected $sectionid;
+    protected $section;
     protected $modulename;
     protected $activityid;
     protected $contextid;
      * @param string $name the task identifier
      * @param int $moduleid course module id (id in course_modules table)
      * @param backup_plan|null $plan the backup plan instance this task is part of
      */
     public function __construct($name, $moduleid, $plan = null) {
+        global $DB;
         // Check moduleid exists
         if (!$coursemodule = get_coursemodule_from_id(false, $moduleid)) {
             throw new backup_task_exception('activity_task_coursemodule_not_found', $moduleid);
         $this->moduleid   = $moduleid;
         $this->sectionid  = $coursemodule->section;
         $this->modulename = $coursemodule->modname;
         $this->activityid = $coursemodule->instance;
         $this->contextid  = context_module::instance($this->moduleid)->id;
+        $this->section = $DB->get_record('course_sections', ['id' => $this->sectionid]);
         parent::__construct($name, $plan);
+    }
     public function get_modulename() {
         return $this->modulename;
+    }
+    /**
+     * Return if the activity is inside a subsection.
+     *
+     * @return bool
+     */
+    public function is_in_subsection(): bool {
+        return !empty($this->section->component);
+    }
     /**
      * @return int the id of the activity instance (id in the activity's instances table)
      */
     public function get_activityid() {
         return $this->activityid;
             $this->built = true;
             return;
+        }
         // Add some extra settings that related processors are going to need
-        $this->add_setting(new backup_activity_generic_setting(backup::VAR_MODID, base_setting::IS_INTEGER, $this->moduleid));
+        $this->add_section_setting(backup::VAR_MODID, base_setting::IS_INTEGER, $this->moduleid);
-        $this->add_setting(new backup_activity_generic_setting(backup::VAR_COURSEID, base_setting::IS_INTEGER, $this->get_courseid()));
+        $this->add_section_setting(backup::VAR_COURSEID, base_setting::IS_INTEGER, $this->get_courseid());
-        $this->add_setting(new backup_activity_generic_setting(backup::VAR_SECTIONID, base_setting::IS_INTEGER, $this->sectionid));
+        $this->add_section_setting(backup::VAR_SECTIONID, base_setting::IS_INTEGER, $this->sectionid);
-        $this->add_setting(new backup_activity_generic_setting(backup::VAR_MODNAME, base_setting::IS_FILENAME, $this->modulename));
+        $this->add_section_setting(backup::VAR_MODNAME, base_setting::IS_FILENAME, $this->modulename);
-        $this->add_setting(new backup_activity_generic_setting(backup::VAR_ACTIVITYID, base_setting::IS_INTEGER, $this->activityid));
+        $this->add_section_setting(backup::VAR_ACTIVITYID, base_setting::IS_INTEGER, $this->activityid);
-        $this->add_setting(new backup_activity_generic_setting(backup::VAR_CONTEXTID, base_setting::IS_INTEGER, $this->contextid));
+        $this->add_section_setting(backup::VAR_CONTEXTID, base_setting::IS_INTEGER, $this->contextid);
         // Create the activity directory
+    }
 // Protected API starts here
     /**
-     * Defines the common setting that any backup activity will have
+     * Defines the common setting that any backup activity will have.
      */
     protected function define_settings() {
         global $CFG;
         require_once($CFG->libdir.'/questionlib.php');
+        // All the settings related to this activity will include this prefix.
+        $settingprefix = $this->modulename . '_' . $this->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 a setting to the task. This method is used to add a setting to the task
+     *
+     * @param int|string $identifier the identifier of the setting
+     * @param string $type the type of the setting
+     * @param string|int $value the value of the setting
+     * @return section_backup_setting the setting added
+     */
+    protected function add_section_setting(int|string $identifier, string $type, string|int $value): activity_backup_setting {
+        if ($this->is_in_subsection()) {
+            $setting = new backup_subactivity_generic_setting($identifier, $type, $value);
+        } else {
+            $setting = new backup_activity_generic_setting($identifier, $type, $value);
+        }
+        $this->add_setting($setting);
+        return $setting;
+    }
+    /**
+     * Add the section include setting to the task.
         // All the settings related to this activity will include this prefix
-        $settingprefix = $this->modulename . '_' . $this->moduleid . '_';
+     * @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_include (to decide if the whole task must be really executed)
+        // Dependent of:
-        // Dependent of:
-        // - activities root setting
-        // - section_included setting (if exists)
-        $settingname = $settingprefix . 'included';
+        // - activities root setting.
-        $activity_included = new backup_activity_generic_setting($settingname, base_setting::IS_BOOLEAN, true);
-        $activity_included->get_ui()->set_icon(new image_icon('monologo', get_string('pluginname', $this->modulename),
-            $this->modulename, array('class' => 'iconlarge icon-post ml-1')));
-        $this->add_setting($activity_included);
-        // Look for "activities" root setting
+        // - sectionincluded setting (if exists).
-        $activities = $this->plan->get_setting('activities');
-        $activities->add_dependency($activity_included);
+        $settingname = $settingprefix . 'included';
+        if ($this->is_in_subsection()) {
+            $activityincluded = new backup_subactivity_generic_setting($settingname, base_setting::IS_BOOLEAN, true);
+        } else {
+            $activityincluded = new backup_activity_generic_setting($settingname, base_setting::IS_BOOLEAN, true);
+        }
+        $activityincluded->get_ui()->set_icon(new image_icon('monologo', get_string('pluginname', $this->modulename),
+            $this->modulename, array('class' => 'ms-1')));
+        $this->add_setting($activityincluded);
         if (question_module_uses_questions($this->modulename)) {
-            $questionbank = $this->plan->get_setting('questionbank');
+        // Look for "activities" root setting.
-            $questionbank->add_dependency($activity_included);
+        $activities = $this->plan->get_setting('activities');
-        }
+        $activities->add_dependency($activityincluded);
+        // Look for "sectionincluded" section setting (if exists).
+        $settingname = 'section_' . $this->sectionid . '_included';
+        if ($this->plan->setting_exists($settingname)) {
+            $sectionincluded = $this->plan->get_setting($settingname);
+            $sectionincluded->add_dependency($activityincluded);
+        }
+        return $activityincluded;
+    }
+    /**
+     * Add the section userinfo setting to the task.
+     *
+     * @param string $settingprefix the identifier of the setting
-        // Look for "section_included" section setting (if exists)
+     * @param activity_backup_setting $includefield the setting to depend on
-        $settingname = 'section_' . $this->sectionid . '_included';
+     * @return activity_backup_setting the setting added
-        if ($this->plan->setting_exists($settingname)) {
+     */
-            $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:
+        // - users root setting.
+        // - sectionuserinfo setting (if exists).
+        // - includefield setting.
-        // Define activity_userinfo. Dependent of:
+        $settingname = $settingprefix . 'userinfo';
+        if ($this->is_in_subsection()) {
+            $activityuserinfo = new backup_subactivity_userinfo_setting($settingname, base_setting::IS_BOOLEAN, true);
+        } else {
-        // - users root setting
+            $activityuserinfo = new backup_activity_userinfo_setting($settingname, base_setting::IS_BOOLEAN, true);
-        // - section_userinfo setting (if exists)
+        }
         // - activity_included setting
-        $settingname = $settingprefix . 'userinfo';
+        $activityuserinfo->get_ui()->set_label('-');
+        $activityuserinfo->get_ui()->set_visually_hidden_label(
-        $activity_userinfo = new backup_activity_userinfo_setting($settingname, base_setting::IS_BOOLEAN, true);
+            get_string('includeuserinfo_instance', 'core_backup', $this->name)
-        //$activity_userinfo->get_ui()->set_label(get_string('includeuserinfo','backup'));
+        );
-        $activity_userinfo->get_ui()->set_label('-');
+        $this->add_setting($activityuserinfo);
-        $this->add_setting($activity_userinfo);
+        // Look for "users" root setting.
-        // Look for "users" root setting
+        $users = $this->plan->get_setting('users');
-        $users = $this->plan->get_setting('users');
+        $users->add_dependency($activityuserinfo);
-        $users->add_dependency($activity_userinfo);
-        // Look for "section_userinfo" section setting (if exists)
-        $settingname = 'section_' . $this->sectionid . '_userinfo';
-        if ($this->plan->setting_exists($settingname)) {
+        // Look for "sectionuserinfo" section setting (if exists).
-            $section_userinfo = $this->plan->get_setting($settingname);
+        $settingname = 'section_' . $this->sectionid . '_userinfo';
-            $section_userinfo->add_dependency($activity_userinfo);
+        if ($this->plan->setting_exists($settingname)) {
             $sectionuserinfo = $this->plan->get_setting($settingname);
-        // Look for "activity_included" setting
+            $sectionuserinfo->add_dependency($activityuserinfo);

Proyectos de Subversion Moodle

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