mirror of
https://github.com/moodle/moodle.git
synced 2025-07-14 10:56:54 +02:00
136 lines
4.2 KiB
PHP
136 lines
4.2 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\router\parameters;
|
|
|
|
use core\exception\not_found_exception;
|
|
use core\param;
|
|
use core\router\schema\example;
|
|
use core\router\schema\parameters\mapped_property_parameter;
|
|
use core\router\schema\referenced_object;
|
|
use Psr\Http\Message\ServerRequestInterface;
|
|
|
|
/**
|
|
* A Moodle parameter referenced in the path.
|
|
*
|
|
* @package core
|
|
* @copyright 2023 Andrew Lyons <andrew@nicols.co.uk>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class path_course extends \core\router\schema\parameters\path_parameter implements
|
|
mapped_property_parameter,
|
|
referenced_object
|
|
{
|
|
/**
|
|
* Create a new path_course parameter.
|
|
*
|
|
* @param string $name The name of the parameter to use for the course identifier
|
|
* @param mixed ...$extra Additional arguments
|
|
*/
|
|
public function __construct(
|
|
string $name = 'course',
|
|
...$extra,
|
|
) {
|
|
$extra['name'] = $name;
|
|
$extra['type'] = param::RAW;
|
|
$extra['description'] = <<<EOF
|
|
The course identifier.
|
|
|
|
This can be the id of the course, the idnumber of the course, or the shortname of the course.
|
|
|
|
If specifying a course idnumber, the value should be in the format `idnumber:[idnumber]`.
|
|
|
|
If specifying a course shortname, the value should be in the format `name:[shortname]`.
|
|
EOF;
|
|
$extra['examples'] = [
|
|
new example(
|
|
name: 'A course id',
|
|
value: 54,
|
|
),
|
|
new example(
|
|
name: 'A course specified by its idnumber',
|
|
value: 'idnumber:000117-physics-101-1',
|
|
),
|
|
new example(
|
|
name: 'A course specified by its shortname',
|
|
value: 'name:000117-phys101-0',
|
|
),
|
|
];
|
|
|
|
parent::__construct(...$extra);
|
|
}
|
|
|
|
/**
|
|
* Get the course object for the given identifier.
|
|
*
|
|
* @param string $value A course id, idnumber, or shortname
|
|
* @return object
|
|
* @throws not_found_exception If the course cannot be found
|
|
*/
|
|
protected function get_course_for_value(string $value): mixed {
|
|
global $DB;
|
|
|
|
$data = false;
|
|
|
|
if (is_numeric($value)) {
|
|
$data = $DB->get_record('course', [
|
|
'id' => $value,
|
|
]);
|
|
} else if (str_starts_with($value, 'idnumber:')) {
|
|
$data = $DB->get_record('course', [
|
|
'idnumber' => substr($value, strlen('idnumber:')),
|
|
]);
|
|
} else if (str_starts_with($value, 'name:')) {
|
|
$data = $DB->get_record('course', [
|
|
'shortname' => substr($value, strlen('name:')),
|
|
]);
|
|
}
|
|
|
|
if ($data) {
|
|
return $data;
|
|
}
|
|
|
|
throw new not_found_exception('course', $value);
|
|
}
|
|
|
|
#[\Override]
|
|
public function add_attributes_for_parameter_value(
|
|
ServerRequestInterface $request,
|
|
string $value,
|
|
): ServerRequestInterface {
|
|
$course = $this->get_course_for_value($value);
|
|
|
|
return $request
|
|
->withAttribute($this->name, $course)
|
|
->withAttribute("{$this->name}context", \core\context\course::instance($course->id));
|
|
}
|
|
|
|
#[\Override]
|
|
public function get_schema_from_type(param $type): \stdClass {
|
|
$schema = parent::get_schema_from_type($type);
|
|
|
|
$schema->pattern = "^(";
|
|
$schema->pattern .= implode("|", [
|
|
'\d+',
|
|
'idnumber:.+',
|
|
'name:.+',
|
|
]);
|
|
$schema->pattern .= ")$";
|
|
|
|
return $schema;
|
|
}
|
|
}
|