Andrew Nicols
114 lines
3.2 KiB
PHP
114 lines
3.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\schema\objects;
|
|
|
|
use core\exception\coding_exception;
|
|
use core\router\schema\specification;
|
|
|
|
/**
|
|
* A schema to describe an array of things. These could be any type, including other schema definitions.
|
|
*
|
|
* See https://spec.openapis.org/oas/v3.1.0#model-with-map-dictionary-properties for relevant documentation.
|
|
*
|
|
* @package core
|
|
* @copyright 2023 Andrew Lyons <andrew@nicols.co.uk>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class schema_object extends type_base {
|
|
/**
|
|
* An array of things.
|
|
*
|
|
* @param type_base[] $content The child content
|
|
* @param mixed[] ...$extra
|
|
* @throws coding_exception
|
|
*/
|
|
public function __construct(
|
|
/** @var type_base[] The child content */
|
|
protected array $content,
|
|
|
|
...$extra,
|
|
) {
|
|
foreach ($content as $child) {
|
|
if (!$child instanceof type_base) {
|
|
throw new coding_exception('Content must be an array of type_base objects');
|
|
}
|
|
}
|
|
|
|
parent::__construct(...$extra);
|
|
}
|
|
|
|
/**
|
|
* Whether this schema object has this key as a type.
|
|
*
|
|
* @param string $key
|
|
* @return bool
|
|
*/
|
|
public function has(string $key): bool {
|
|
return isset($this->content[$key]);
|
|
}
|
|
|
|
/**
|
|
* Get the schema object for this key.
|
|
*
|
|
* @param string $key
|
|
* @return type_base
|
|
*/
|
|
public function get(string $key): type_base {
|
|
return $this->content[$key];
|
|
}
|
|
|
|
#[\Override]
|
|
public function validate_data(mixed $data) {
|
|
foreach ($data as $key => $values) {
|
|
if (!$this->has($key)) {
|
|
// We do not know about this one.
|
|
// Remove it from the params array.
|
|
$data = array_diff_key(
|
|
$data,
|
|
[$key => $values],
|
|
);
|
|
continue;
|
|
}
|
|
|
|
// Validate this parameter.
|
|
$child = $this->content[$key];
|
|
$data[$key] = $child->validate_data($values);
|
|
}
|
|
|
|
return $data;
|
|
}
|
|
|
|
#[\Override]
|
|
public function get_openapi_description(
|
|
specification $api,
|
|
?string $path = null,
|
|
): ?\stdClass {
|
|
$data = (object) [
|
|
'type' => 'object',
|
|
'properties' => (object) [],
|
|
];
|
|
|
|
foreach ($this->content as $name => $content) {
|
|
$data->properties->{$name} = $content->get_openapi_schema(
|
|
$api,
|
|
);
|
|
}
|
|
|
|
return $data;
|
|
}
|
|
}
|