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

 class backup_section_task extends backup_task {
     protected $sectionid;
+    /**
+     * @var stdClass $section The database section object.
+     */
+    protected stdClass $section;
+    /**
+     * @var int|null $delegatedcmid the course module that is delegating this section (if any)
+     */
+    protected ?int $delegatedcmid = null;
     /**
      * Constructor - instantiates one object of this class
      */
     public function __construct($name, $sectionid, $plan = null) {
         global $DB;
         // Check section exists
+        if (!$section = $DB->get_record('course_sections', array('id' => $sectionid))) {
-        if (!$section = $DB->get_record('course_sections', array('id' => $sectionid))) {
+            throw new backup_task_exception('section_task_section_not_found', $sectionid);
             throw new backup_task_exception('section_task_section_not_found', $sectionid);
+        $this->section = $section;
+        $this->sectionid  = $sectionid;
+        parent::__construct($name, $plan);
+    }
+    /**
+     * Set the course module that is delegating this section.
+     *
+     * Delegated section can belong to any kind of plugin. However, when a delegated
+     * section belongs to a course module, the UI will present all settings according.
+     *
+     * @param int $cmid the course module id that is delegating this section
+     */
+    public function set_delegated_cm(int $cmid) {
+        $this->delegatedcmid = $cmid;
+    }
+    /**
+     * 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 {
+        return $this->delegatedcmid;
+    }
+    /**
+     * Get the delegate activity modname (if any).
+     *
+     * @return string|null the modname of the delegated activity
+     */
+    public function get_modname(): ?string {
         if (empty($this->section->component)) {
-        $this->sectionid  = $sectionid;
+            return null;
+        }
-        parent::__construct($name, $plan);
+        return core_component::normalize_component($this->section->component)[1];
      */
     public function build() {
         // Set the backup::VAR_CONTEXTID setting to course context as far as next steps require that
         $coursectxid = context_course::instance($this->get_courseid())->id;
-        $this->add_setting(new backup_activity_generic_setting(backup::VAR_CONTEXTID, base_setting::IS_INTEGER, $coursectxid));
+        $this->add_section_setting(backup::VAR_CONTEXTID, base_setting::IS_INTEGER, $coursectxid);
         // Add some extra settings that related processors are going to need
-        $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_COURSEID, base_setting::IS_INTEGER, $this->get_courseid()));
+        $this->add_section_setting(backup::VAR_COURSEID, base_setting::IS_INTEGER, $this->get_courseid());
+    }
 // Protected API starts here
     /**
-     * Define the common setting that any backup section will have
+     * Define the common setting that any backup section will have.
      */
     protected function define_settings() {
         global $DB;
+        // All the settings related to this activity will include this prefix.
+        $settingprefix = 'section_' . $this->sectionid . '_';
+        $incudefield = $this->add_section_included_setting($settingprefix);
+        $this->add_section_userinfo_setting($settingprefix, $incudefield);
+    }
+    /**
+     * 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
-        // All the settings related to this activity will include this prefix
+     * @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): section_backup_setting {
+        if ($this->get_delegated_cm()) {
+            $setting = new backup_subsection_generic_setting($identifier, $type, $value);
+        } else {
+            $setting = new backup_section_generic_setting($identifier, $type, $value);
+        }
+        $this->add_setting($setting);
+        return $setting;
+    }
+    /**
+     * Add the section included setting to the task.
+     *
-        $settingprefix = 'section_' . $this->sectionid . '_';
+     * @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;
+        $course = $DB->get_record('course', ['id' => $this->section->course], '*', MUST_EXIST);
+        // Define sectionincluded (to decide if the whole task must be really executed).
+        $settingname = $settingprefix . 'included';
+        $delegatedcmid = $this->get_delegated_cm();
+        if ($delegatedcmid) {
+            $sectionincluded = new backup_subsection_included_setting($settingname, base_setting::IS_BOOLEAN, true);
+            // 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(
-        $section = $DB->get_record('course_sections', array('id' => $this->sectionid), '*', MUST_EXIST);
+                    $sectionincluded,
+                );
+            }
-        $course = $DB->get_record('course', array('id' => $section->course), '*', MUST_EXIST);
+            $sectionincluded->get_ui()->set_label(get_string('subsectioncontent', 'backup'));
+        } else {
+            $sectionincluded = new backup_section_included_setting($settingname, base_setting::IS_BOOLEAN, true);
+            $sectionincluded->get_ui()->set_label(get_section_name($course, $this->section));
+        }
+        $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 setting to depend on
-        // Define section_included (to decide if the whole task must be really executed)
+     * @return section_backup_setting the setting added
-        $settingname = $settingprefix . 'included';
+     */
-        $section_included = new backup_section_included_setting($settingname, base_setting::IS_BOOLEAN, true);
+    protected function add_section_userinfo_setting(
-        $section_included->get_ui()->set_label(get_section_name($course, $section));
+        string $settingprefix,
+        section_backup_setting $includefield
+    ): section_backup_setting {
+        // Define sectionuserinfo. Dependent of:
+        // - users root setting.
+        // - section_included setting.
+        $settingname = $settingprefix . 'userinfo';
+        $delegatedcmid = $this->get_delegated_cm();
+        if ($delegatedcmid) {
+            $sectionuserinfo = new backup_subsection_userinfo_setting($settingname, base_setting::IS_BOOLEAN, true);
+            // Subsections depends on the parent activity included setting.
+            $settingname = $this->get_modname() . '_' . $delegatedcmid . '_userinfo';
+            if ($this->plan->setting_exists($settingname)) {
-        $this->add_setting($section_included);
+                $cmincluded = $this->plan->get_setting($settingname);
+                $cmincluded->add_dependency(
+                    $sectionuserinfo,
+                );
+            }
+        } else {
+            $sectionuserinfo = new backup_section_userinfo_setting($settingname, base_setting::IS_BOOLEAN, true);
-        // Define section_userinfo. Dependent of:
+        }
-        // - users root setting
-        // - section_included setting
+        $sectionuserinfo->get_ui()->set_label(get_string('includeuserinfo', 'backup'));
-        $settingname = $settingprefix . 'userinfo';
+        $sectionuserinfo->get_ui()->set_visually_hidden_label(
-        $section_userinfo = new backup_section_userinfo_setting($settingname, base_setting::IS_BOOLEAN, true);
+            get_string('section_prefix', 'core_backup', $this->section->name ?: $this->section->section)
-        $section_userinfo->get_ui()->set_label(get_string('includeuserinfo','backup'));
+        );
+        $this->add_setting($sectionuserinfo);
+        // Look for "users" root setting.
-        $this->add_setting($section_userinfo);
+        $users = $this->plan->get_setting('users');
-        // Look for "users" root setting
+        $users->add_dependency($sectionuserinfo);

Proyectos de Subversion Moodle

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