WebSVN – Moodle – Diff – /question/bank/managecategories/classes/helper.php

 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+namespace qbank_managecategories;
+defined('MOODLE_INTERNAL') || die();
-namespace qbank_managecategories;
+require_once($CFG->libdir . "/questionlib.php");
 use context;
+use core_question\category_manager;
-use context;
+use core_question\local\bank\question_version_status;
-use core_question\local\bank\question_version_status;
+use core_question\output\question_category_selector;
 use moodle_exception;
 use html_writer;
  * @copyright  2021 Catalyst IT Australia Pty Ltd
  * @author     Guillermo Gomez Arias <guillermogomez@catalyst-au.net>
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class helper {
     /**
      * Name of this plugin.
      */
     const PLUGINNAME = 'qbank_managecategories';
     /**
      * Remove stale questions from a category.
      *
-     * While questions should not be left behind when they are not used any more,
+     * This finds and removes any old-style random questions (qtype = random),
+     * or any questions that were deleted while they were in use by a quiz (status = hidden),
+     * but those usages have since been removed.
-     * it does happen, maybe via restore, or old logic, or uncovered scenarios. When
+     *
-     * this happens, the users are unable to delete the question category unless
+     * If a category only contains stale questions, the users are unable to delete the question
-     * they move those stale questions to another one category, but to them the
+     * category unless they move those stale questions to another one category, but to them the
-     * category is empty as it does not contain anything. The purpose of this function
+     * category may appear empty. The purpose of this function is to detect the questions that
-     * is to detect the questions that may have gone stale and remove them.
+     * may have gone stale and remove them.
+     *
      * You will typically use this prior to checking if the category contains questions.
-     *
-     * The stale questions (unused and hidden to the user) handled are:
-     * - hidden questions
-     * - random questions
+     *
      * @param int $categoryid The category ID.
      * @throws \dml_exception
      */
     public static function question_remove_stale_questions_from_category(int $categoryid): void {
      * Checks whether this is the only child of a top category in a context.
+     *
      * @param int $categoryid a category id.
      * @return bool
      * @throws \dml_exception
+     * @deprecated Since Moodle 4.5. Use core_question\category_manager::is_only_child_of_top_category_in_context instead.
+     * @todo Final removal in Moodle 6.0 MDL-80804
      */
+    #[\core\attribute\deprecated(
+        'core_question\category_manager::is_only_child_of_top_category_in_context',
+        since: 4.5,
+        reason: 'Moved to core namespace',
+        mdl: 'MDL-72397'
+    )]
     public static function question_is_only_child_of_top_category_in_context(int $categoryid): bool {
-        global $DB;
-        return 1 == $DB->count_records_sql("
+        \core\deprecation::emit_deprecation([__CLASS__, __FUNCTION__]);
-            SELECT count(*)
-              FROM {question_categories} c
+        $manager = new category_manager();
-              JOIN {question_categories} p ON c.parent = p.id
-              JOIN {question_categories} s ON s.parent = c.parent
-             WHERE c.id = ? AND p.parent = 0", [$categoryid]);
+        return $manager->is_only_child_of_top_category_in_context($categoryid);
+    }
     /**
      * Checks whether the category is a "Top" category (with no parent).
+     *
      * @param int $categoryid a category id.
      * @return bool
+     * @throws \dml_exception
+     * @deprecated Since Moodle 4.5. Use core_question\category_manager::is_top_category instead.
-     * @throws \dml_exception
+     * @todo Final removal in Moodle 6.0 MDL-80804.
+     */
+    #[\core\attribute\deprecated(
+        'core_question\category_manager::is_top_category',
+        since: 4.5,
+        reason: 'Moved to core namespace',
+        mdl: 'MDL-72397'
-     */
+    )]
+    public static function question_is_top_category(int $categoryid): bool {
-    public static function question_is_top_category(int $categoryid): bool {
+        \core\deprecation::emit_deprecation([__CLASS__, __FUNCTION__]);
-        global $DB;
+        $manager = new category_manager();
-        return 0 == $DB->get_field('question_categories', 'parent', ['id' => $categoryid]);
+        return $manager->is_top_category($categoryid);
+    }
     /**
      * Ensures that this user is allowed to delete this category.
+     *
      * @param int $todelete a category id.
+     * @throws \required_capability_exception
+     * @throws \dml_exception|moodle_exception
-     * @throws \required_capability_exception
+     * @deprecated Since Moodle 4.5. Use core_question\category_manager::can_delete_category instead.
+     * @todo Final removal in Moodle 6.0 MDL-80804.
+     */
+    #[\core\attribute\deprecated(
+        'core_question\category_manager::can_delete_category',
+        since: 4.5,
+        reason: 'Moved to core namespace',
-     * @throws \dml_exception|moodle_exception
+        mdl: 'MDL-72397'
-     */
-    public static function question_can_delete_cat(int $todelete): void {
+    )]
-        global $DB;
+    public static function question_can_delete_cat(int $todelete): void {
-        if (self::question_is_top_category($todelete)) {
+        \core\deprecation::emit_deprecation([__CLASS__, __FUNCTION__]);
-            throw new moodle_exception('cannotdeletetopcat', 'question');
-        } else if (self::question_is_only_child_of_top_category_in_context($todelete)) {
-            throw new moodle_exception('cannotdeletecate', 'question');
-        } else {
-            $contextid = $DB->get_field('question_categories', 'contextid', ['id' => $todelete]);
-            require_capability('moodle/question:managecategory', context::instance_by_id($contextid));
+        $manager = new category_manager();
         $manager->require_can_delete_category($todelete);
+    }
         // Recursively indent the children.
         foreach ($categories[$id]->childids as $childid) {
             if ($childid != $nochildrenof) {
+                $newcategories = $newcategories + self::flatten_category_tree(
+                    $categories,
+                    $childid,
-                $newcategories = $newcategories + self::flatten_category_tree(
+                    $depth + 1,
+                    $nochildrenof,
-                        $categories, $childid, $depth + 1, $nochildrenof);
+                );
+            }
+        }
         // Build the tree structure, and record which categories are top-level.
         // We have to be careful, because the categories array may include published
         // categories from other courses, but not their parents.
         $toplevelcategoryids = [];
         foreach (array_keys($categories) as $id) {
+            if (
-            if (!empty($categories[$id]->parent) &&
+                !empty($categories[$id]->parent) &&
-                array_key_exists($categories[$id]->parent, $categories)) {
+                array_key_exists($categories[$id]->parent, $categories)
+            ) {
                 $categories[$categories[$id]->parent]->childids[] = $id;
             } else {
                 $toplevelcategoryids[] = $id;
+            }
+        }
         // Flatten the tree to and add the indents.
         $newcategories = [];
         foreach ($toplevelcategoryids as $id) {
+            $newcategories = $newcategories + self::flatten_category_tree(
+                $categories,
+                $id,
-            $newcategories = $newcategories + self::flatten_category_tree(
+,
+                $nochildrenof,
-                    $categories, $id, 0, $nochildrenof);
+            );
+        }
      * @param int $currentcat
      * @param string $selected optionally, the id of a category to be selected by
      *      default in the dropdown.
      * @param int $nochildrenof
      * @param bool $return to return the string of the select menu or echo that from the method
+     * @return ?string The HTML, or null if the $return is false.
      * @throws \coding_exception|\dml_exception
      */
-    public static function question_category_select_menu(array $contexts, bool $top = false, int $currentcat = 0,
+    public static function question_category_select_menu(
+        array $contexts,
+        bool $top = false,
+        int $currentcat = 0,
+        string $selected = "",
-                                           string $selected = "", int $nochildrenof = -1, bool $return = false) {
+        int $nochildrenof = -1,
+        bool $return = false,
+    ): ?string {
-        $categoriesarray = self::question_category_options($contexts, $top, $currentcat,
+        $categoriesarray = self::question_category_options(
+            $contexts,
+            $top,
+            $currentcat,
+            false,
-            false, $nochildrenof, false);
+            $nochildrenof,
+            false,
+        );
         $choose = '';
         $options = [];
         foreach ($categoriesarray as $group => $opts) {
             $options[] = [$group => $opts];
+        }
+        $outputhtml = html_writer::label(
-        $outputhtml = html_writer::label(get_string('questioncategory', 'core_question'),
+            get_string('questioncategory', 'core_question'),
+            'id_movetocategory',
+            false,
-            'id_movetocategory', false, ['class' => 'accesshide']);
+            ['class' => 'accesshide'],
+        );
         $attrs = [
             'id' => 'id_movetocategory',
-            'class' => 'custom-select',
+            'class' => 'form-select',
             'data-action' => 'toggle',
             'data-togglegroup' => 'qbank',
             'data-toggle' => 'action',
             'disabled' => false,
         ];
         $outputhtml .= html_writer::select($options, 'category', $selected, $choose, $attrs);
         if ($return) {
             return $outputhtml;
         } else {
             echo $outputhtml;
+            return null;
+        }
+    }
     /**
      * Get all the category objects, including a count of the number of questions in that category,
      * for all the categories in the lists $contexts.
      *
-     * @param context $contexts
+     * @param string $contexts comma separated list of contextids
      * @param string $sortorder used as the ORDER BY clause in the select statement.
      * @param bool $top Whether to return the top categories or not.
      * @param int $showallversions 1 to show all versions not only the latest.
      * @return array of category objects.
      * @throws \dml_exception
      */
-    public static function get_categories_for_contexts($contexts, string $sortorder = 'parent, sortorder, name ASC',
-                                                       bool $top = false, int $showallversions = 0): array {
+    public static function get_categories_for_contexts(
-        global $DB;
+        string $contexts,
-        $topwhere = $top ? '' : 'AND c.parent <> 0';
-        $statuscondition = "AND (qv.status = '". question_version_status::QUESTION_STATUS_READY . "' " .
-            " OR qv.status = '" . question_version_status::QUESTION_STATUS_DRAFT . "' )";
+        string $sortorder = 'parent, sortorder, name ASC',
-        $sql = "SELECT c.*,
-                    (SELECT COUNT(1)
-                       FROM {question} q
-                       JOIN {question_versions} qv ON qv.questionid = q.id
-                       JOIN {question_bank_entries} qbe ON qbe.id = qv.questionbankentryid
-                      WHERE q.parent = '0'
-                        $statuscondition
-                            AND c.id = qbe.questioncategoryid
+        bool $top = false,
-                            AND ($showallversions = 1
-                                OR (qv.version = (SELECT MAX(v.version)
-                                                    FROM {question_versions} v
-                                                    JOIN {question_bank_entries} be ON be.id = v.questionbankentryid
-                                                   WHERE be.id = qbe.id)
-                                   )
+        int $showallversions = 0,
-                                )
-                            ) AS questioncount
-                  FROM {question_categories} c
+    ): array {
-                 WHERE c.contextid IN ($contexts) $topwhere
-              ORDER BY $sortorder";
-        return $DB->get_records_sql($sql);
+        return (new question_category_selector())->get_categories_for_contexts($contexts, $sortorder, $top, $showallversions);
+    }
     /**
      * @param int $nochildrenof
      * @param bool $escapecontextnames Whether the returned name of the thing is to be HTML escaped or not.
      * @return array
      * @throws \coding_exception|\dml_exception
      */
-    public static function question_category_options(array $contexts, bool $top = false, int $currentcat = 0,
+    public static function question_category_options(
-                                                     bool $popupform = false, int $nochildrenof = -1,
-                                                     bool $escapecontextnames = true): array {
-        global $CFG;
+        array $contexts,
-        $pcontexts = [];
+        bool $top = false,
-        foreach ($contexts as $context) {
+        int $currentcat = 0,
-            $pcontexts[] = $context->id;
+        bool $popupform = false,
-        }
-        $contextslist = join(', ', $pcontexts);
-        $categories = self::get_categories_for_contexts($contextslist, 'parent, sortorder, name ASC', $top);
-        if ($top) {
-            $categories = self::question_fix_top_names($categories);
-        }
-        $categories = self::question_add_context_in_key($categories);
-        $categories = self::add_indented_names($categories, $nochildrenof);
-        // Sort cats out into different contexts.
-        $categoriesarray = [];
+        int $nochildrenof = -1,
-        foreach ($pcontexts as $contextid) {
+        bool $escapecontextnames = true,
-            $context = \context::instance_by_id($contextid);
-            $contextstring = $context->get_context_name(true, true, $escapecontextnames);
-            foreach ($categories as $category) {
-                if ($category->contextid == $contextid) {
-                    $cid = $category->id;
-                    if ($currentcat != $cid || $currentcat == 0) {
-                        $a = new \stdClass;
-                        $a->name = format_string($category->indentedname, true,
-                            ['context' => $context]);
-                        if ($category->idnumber !== null && $category->idnumber !== '') {
-                            $a->idnumber = s($category->idnumber);
-                        }
+    ): array {
-                        if (!empty($category->questioncount)) {
+        return (new question_category_selector())->question_category_options(
-                            $a->questioncount = $category->questioncount;
-                        }
-                        if (isset($a->idnumber) && isset($a->questioncount)) {
-                            $formattedname = get_string('categorynamewithidnumberandcount', 'question', $a);
-                        } else if (isset($a->idnumber)) {
-                            $formattedname = get_string('categorynamewithidnumber', 'question', $a);
-                        } else if (isset($a->questioncount)) {
-                            $formattedname = get_string('categorynamewithcount', 'question', $a);
-                        } else {
-                            $formattedname = $a->name;
-                        }
-                        $categoriesarray[$contextstring][$cid] = $formattedname;
-                    }
+            $contexts,
-                }
+            $top,
-            }
+            $currentcat,
-        }
-        if ($popupform) {
+            $popupform,
-            $popupcats = [];
+            $nochildrenof,
-            foreach ($categoriesarray as $contextstring => $optgroup) {
-                $group = [];
-                foreach ($optgroup as $key => $value) {
-                    $key = str_replace($CFG->wwwroot, '', $key);
-                    $group[$key] = $value;
-                }
-                $popupcats[] = [$contextstring => $group];
-            }
-            return $popupcats;
+            $escapecontextnames,
-        } else {
-            return $categoriesarray;
-        }
+        );
+    }
     /**
      * Add context in categories key.
+     *
      * @param array $categories The list of categories.
      * @return array
      */
-    public static function question_add_context_in_key(array $categories): array {
-        $newcatarray = [];
-        foreach ($categories as $id => $category) {
-            $category->parent = "$category->parent,$category->contextid";
-            $category->id = "$category->id,$category->contextid";
+    public static function question_add_context_in_key(array $categories): array {
-            $newcatarray["$id,$category->contextid"] = $category;
-        }
-        return $newcatarray;
+        return (new question_category_selector())->question_add_context_in_key($categories);
+    }
     /**
      * @param bool $escape Whether the returned name of the thing is to be HTML escaped or not.
      * @return array The same question category list given to the function, with the top category names being translated.
      * @throws \coding_exception
      */
     public static function question_fix_top_names(array $categories, bool $escape = true): array {
+        return (new question_category_selector())->question_fix_top_names($categories, $escape);
+    }
+    /**
-        foreach ($categories as $id => $category) {
+     * Combine id and context id for a question category
-            if ($category->parent == 0) {
+     *
-                $context = \context::instance_by_id($category->contextid);
-                $categories[$id]->name = get_string('topfor', 'question', $context->get_context_name(false, false, $escape));
+     * @param \stdClass $category a category to extract its id and context id
-            }
+     * @return string the combined string
-        }
+     */
+    public static function combine_id_context(\stdClass $category): string {
-        return $categories;
+        return $category->id . ',' . $category->contextid;
+    }

Proyectos de Subversion Moodle

(root)/question/bank/managecategories/classes/helper.php – Rev 1 → 1441