Files
moodle/course/format/classes/sectiondelegate.php
T
Ferran Recio 34ce0eddc0 MDL-80190 core_courseformat: prevent delegated sections loops
This patch prevent dropping an activity with delegated sections inside
another delegated section. Without this patch the teacher can create a
deadlock drag&droping the subsection inside itself. We won't allow
subsections inside subsections so any activity with subsection cannot
be dropped inside a subsección.
2024-02-07 12:14:59 +01:00

81 lines
2.4 KiB
PHP

<?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;
use section_info;
/**
* Section delegate base class.
*
* Plugins using delegate sections must extend this class into
* their PLUGINNAME\courseformat\sectiondelegate class.
*
* @package core_courseformat
* @copyright 2023 Ferran Recio <ferran@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
abstract class sectiondelegate {
/**
* Constructor.
* @param section_info $sectioninfo
*/
public function __construct(
protected section_info $sectioninfo
) {
}
/**
* Get the section info instance if available.
*
* @param section_info $sectioninfo
* @return section_info|null
*/
public static function instance(section_info $sectioninfo): ?self {
if (empty($sectioninfo->component)) {
return null;
}
$classname = self::get_delegate_class_name($sectioninfo->component);
if ($classname === null) {
return null;
}
return new $classname($sectioninfo);
}
/**
* Return the delgate class name of a plugin, if any.
* @param string $pluginname
* @return string|null the delegate class name or null if not found.
*/
protected static function get_delegate_class_name(string $pluginname): ?string {
$classname = $pluginname . '\courseformat\sectiondelegate';
if (!class_exists($classname)) {
return null;
}
return $classname;
}
/**
* Check if a plugin has a delegate class.
* @param string $pluginname
* @return bool
*/
public static function has_delegate_class(string $pluginname): bool {
return self::get_delegate_class_name($pluginname) !== null;
}
}