<?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/>.

/**
 * backup_theme_boost_magnific_plugin.class.php
 *
 * @package   theme_boost_magnific
 * @copyright 2026 Eduardo Kraus {@link https://eduardokraus.com}
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

// phpcs:disable moodle.Files.MoodleInternal.MoodleInternalGlobalState
require_once("{$CFG->dirroot}/backup/moodle2/backup_theme_plugin.class.php");

/**
 * Class backup_theme_boost_magnific_plugin
 */
class backup_theme_boost_magnific_plugin extends backup_theme_plugin {

    /**
     * Defines the course-level structure for theme_boost_magnific data.
     *
     * @return backup_plugin_element
     * @throws base_element_struct_exception
     */
    protected function define_course_plugin_structure() {
        global $DB;

        $plugin = $this->get_plugin_element(null, $this->get_theme_condition(), "boost_magnific");

        $pluginwrapper = new backup_nested_element($this->get_recommended_name());
        $plugin->add_child($pluginwrapper);

        $courseopts = new backup_nested_element("courseopts", ["courseid"], [
            "course_summary_banner",
            "course_sections_icons",
            "override_course_primarycolor",
            "override_course_secondarycolor",
            "banner_course_file",
        ]);
        $pluginwrapper->add_child($courseopts);

        $namecoursesummary = $DB->sql_concat("'course_summary_banner_'", "c.id");
        $namesectionsicons = $DB->sql_concat("'course_sections_icons_'", "c.id");
        $nameprimary = $DB->sql_concat("'override_course_primarycolor_'", "c.id");
        $namesecondary = $DB->sql_concat("'override_course_secondarycolor_'", "c.id");
        $namebannerfile = $DB->sql_concat("'banner_course_file_'", "c.id");

        $courseopts->set_source_sql(
            "
            SELECT
                c.id AS courseid,
                csb.value AS course_summary_banner,
                csi.value AS course_sections_icons,
                pcol.value AS override_course_primarycolor,
                scol.value AS override_course_secondarycolor,
                bfile.value AS banner_course_file
            FROM {course} c
            LEFT JOIN {config_plugins} csb
                   ON csb.plugin = 'theme_boost_magnific' AND csb.name = {$namecoursesummary}
            LEFT JOIN {config_plugins} csi
                   ON csi.plugin = 'theme_boost_magnific' AND csi.name = {$namesectionsicons}
            LEFT JOIN {config_plugins} pcol
                   ON pcol.plugin = 'theme_boost_magnific' AND pcol.name = {$nameprimary}
            LEFT JOIN {config_plugins} scol
                   ON scol.plugin = 'theme_boost_magnific' AND scol.name = {$namesecondary}
            LEFT JOIN {config_plugins} bfile
                   ON bfile.plugin = 'theme_boost_magnific' AND bfile.name = {$namebannerfile}
            WHERE c.id = :courseid
        ", ["courseid" => backup::VAR_COURSEID]
        );

        // Banner in course context, stable filearea.
        $courseopts->annotate_files("theme_boost_magnific", "banner_course_file", null);

        return $plugin;
    }
}
