Proyectos de Subversion Moodle

<?php

// This file is part of Moodle - http://moodle.org/

//

// Moodle is free software: you can redistribute it and/or modify

// it under the terms of the GNU General Public License as published by

// the Free Software Foundation, either version 3 of the License, or

// (at your option) any later version.

//

// Moodle is distributed in the hope that it will be useful,

// but WITHOUT ANY WARRANTY; without even the implied warranty of

// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

// GNU General Public License for more details.

//

// You should have received a copy of the GNU General Public License

// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

namespace core_courseformat\output\local\overview;

use core\context\course as context_course;

use core\output\named_templatable;

use core\output\renderable;

use core\url;

use core_course\output\activity_icon;

use core_collator;

use stdClass;

/**

 * Class overview page

 *

 * @package    core_course

 * @copyright  2025 Ferran Recio <ferran@moodle.com>

 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

 */

class overviewpage implements renderable, named_templatable {

    /** @var context_course the context. */

    protected context_course $context;

    /**

     * Constructor.

     *

     * @param stdClass $course the course object.

     * @param string[] $expanded the sections to be expanded on load.

     */

    public function __construct(

        /** @var stdClass the course object  */

        protected stdClass $course,

        /** @var string[] the sections to be expanded on load  */

        protected array $expanded = [],

    ) {

        $this->context = context_course::instance($this->course->id);

    }

    /**

     * Gets the URL to the course overview page for a given course and module name.

     *

     * @param int $courseid

     * @param string $modname

     * @return url

     */

    public static function get_modname_url(int $courseid, string $modname): url {

        return new url(

            url: '/course/overview.php',

            params: ['id' => $courseid, 'expand[]' => $modname],

            anchor: "{$modname}_overview_collapsible",

        );

    }

    #[\Override]

    public function export_for_template(\renderer_base $output): stdClass {

        $modfullnames = $this->get_course_activities_overview_list();

        $elements = [];

        foreach ($modfullnames as $modname => $modfullname) {

            $elements[] = $this->export_activity_overview_section_data($output, $modname, $modfullname);

        }

        return (object) [

            'elements' => $elements,

            'courseid' => $this->course->id,

            'contextid' => $this->context->id,

        ];

    }

    /**

     * Retrieves a list of course activities overview.

     *

     * @return string[] An associative array module name => module plural name.

     */

    private function get_course_activities_overview_list(): array {

        $modinfo = get_fast_modinfo($this->course);

        $modfullnames = [];

        $archetypes = [];

        foreach ($modinfo->cms as $cm) {

            // Exclude activities that aren't visible or have no view link (e.g. label).

            // Account for folder being displayed inline.

            if (!$cm->uservisible || (!$cm->has_view() && strcmp($cm->modname, 'folder') !== 0)) {

                continue;

            }

            if (array_key_exists($cm->modname, $modfullnames)) {

                continue;

            }

            if (!array_key_exists($cm->modname, $archetypes)) {

                $archetypes[$cm->modname] = plugin_supports(

                    type: 'mod',

                    name: $cm->modname,

                    feature: FEATURE_MOD_ARCHETYPE,

                    default: MOD_ARCHETYPE_OTHER

                );

            }

            if ($archetypes[$cm->modname] == MOD_ARCHETYPE_RESOURCE) {

                if (!array_key_exists('resource', $modfullnames)) {

                    $modfullnames['resource'] = get_string('resources');

                }

            } else {

                $modfullnames[$cm->modname] = $cm->modplural;

            }

        }

        core_collator::asort($modfullnames);

        return $modfullnames;

    }

    /**

     * Exports the data for the activity overview section.

     *

     * This function checks if the activity has an overview integration,

     * and return the data accordingly.

     *

     * @param \renderer_base $output

     * @param string $modname The name of the module.

     * @param string $modfullname The full name of the module.

     * @return stdClass The exported data for the activity overview section.

     */

    private function export_activity_overview_section_data(

        \renderer_base $output,

        string $modname,

        string $modfullname

    ): stdClass {

        return (object) [

            'fragment' => $this->export_overview_fragment($modname),

            'icon' => $this->get_activity_overview_icon($output, $modname),

            'name' => $modfullname,

            'shortname' => $modname,

            'open' => in_array($modname, $this->expanded),

        ];

    }

    /**

     * Generates the activity overview icon for a given module.

     *

     * @param \renderer_base $output

     * @param string $modname The name of the module for which the icon is being generated.

     * @return string The HTML string for the activity overview icon.

     */

    private function get_activity_overview_icon(\renderer_base $output, string $modname): string {

        // Resource is a generic term for all modules with MOD_ARCHETYPE_RESOURCE.

        // We group all of them under the mod_page icon.

        if ($modname === 'resource') {

            $modname = 'page';

        }

        return $output->render(activity_icon::from_modname($modname));

    }

    /**

     * Exports an overview fragment for a given module name.

     *

     * This function creates and returns an object containing details

     * about the course overview fragment for the specified module.

     *

     * @param string $modname

     * @return stdClass The exported overview fragment data.

     */

    private function export_overview_fragment(string $modname): stdClass {

        // If the element is expanded, we don't need to load the fragment.

        if (in_array($modname, $this->expanded)) {

            return (object) [

                'preloadedcontent' => course_output_fragment_course_overview([

                    'courseid' => $this->course->id,

                    'modname' => $modname,

                ]),

            ];

        }

        return (object) [

            'component' => 'core_course',

            'method' => 'overview_table',

            'course' => $this->course,

            'modname' => $modname,

        ];

    }

    /**

     * Get the name of the template to use for this templatable.

     *

     * @param \renderer_base $renderer The renderer requesting the template name

     * @return string

     */

    public function get_template_name(\renderer_base $renderer): string {

        return 'core_courseformat/local/overview/overviewpage';

    }

}