139 lines
4.5 KiB
PHP
139 lines
4.5 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/>.
|
|
|
|
/**
|
|
* Helper functions for converting a Moodle WS structure to a TS type.
|
|
*/
|
|
|
|
/**
|
|
* Fix a comment: make sure first letter is uppercase and add a dot at the end if needed.
|
|
*/
|
|
function fix_comment($desc) {
|
|
$desc = trim($desc);
|
|
$desc = ucfirst($desc);
|
|
|
|
if (substr($desc, -1) !== '.') {
|
|
$desc .= '.';
|
|
}
|
|
|
|
return $desc;
|
|
}
|
|
|
|
/**
|
|
* Get an inline comment based on a certain text.
|
|
*/
|
|
function get_inline_comment($desc) {
|
|
if (empty($desc)) {
|
|
return '';
|
|
}
|
|
|
|
return ' // ' . fix_comment($desc);
|
|
}
|
|
|
|
/**
|
|
* Add the TS documentation of a certain element.
|
|
*/
|
|
function get_ts_doc($type, $desc, $indentation) {
|
|
if (empty($desc)) {
|
|
// If no key, it's probably in an array. We only document object properties.
|
|
return '';
|
|
}
|
|
|
|
return $indentation . "/**\n" .
|
|
$indentation . " * " . fix_comment($desc) . "\n" .
|
|
(!empty($type) ? ($indentation . " * @type {" . $type . "}\n") : '') .
|
|
$indentation . " */\n";
|
|
}
|
|
|
|
/**
|
|
* Specify a certain type, with or without a key.
|
|
*/
|
|
function convert_key_type($key, $type, $required, $indentation) {
|
|
if ($key) {
|
|
// It has a key, it's inside an object.
|
|
return $indentation . "$key" . ($required == VALUE_OPTIONAL ? '?' : '') . ": $type";
|
|
} else {
|
|
// No key, it's probably in an array. Just include the type.
|
|
return $type;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Convert a certain element into a TS structure.
|
|
*/
|
|
function convert_to_ts($key, $value, $boolisnumber = false, $indentation = '', $arraydesc = '') {
|
|
if ($value instanceof external_value || $value instanceof external_warnings || $value instanceof external_files) {
|
|
// It's a basic field or a pre-defined type like warnings.
|
|
$type = 'string';
|
|
|
|
if ($value instanceof external_warnings) {
|
|
$type = 'CoreWSExternalWarning[]';
|
|
} else if ($value instanceof external_files) {
|
|
$type = 'CoreWSExternalFile[]';
|
|
} else if ($value->type == PARAM_BOOL && !$boolisnumber) {
|
|
$type = 'boolean';
|
|
} else if (($value->type == PARAM_BOOL && $boolisnumber) || $value->type == PARAM_INT || $value->type == PARAM_FLOAT ||
|
|
$value->type == PARAM_LOCALISEDFLOAT || $value->type == PARAM_PERMISSION || $value->type == PARAM_INTEGER ||
|
|
$value->type == PARAM_NUMBER) {
|
|
$type = 'number';
|
|
}
|
|
|
|
$result = convert_key_type($key, $type, $value->required, $indentation);
|
|
|
|
return $result;
|
|
|
|
} else if ($value instanceof external_single_structure) {
|
|
// It's an object.
|
|
$result = convert_key_type($key, '{', $value->required, $indentation);
|
|
|
|
if ($arraydesc) {
|
|
// It's an array of objects. Print the array description now.
|
|
$result .= get_inline_comment($arraydesc);
|
|
}
|
|
|
|
$result .= "\n";
|
|
|
|
foreach ($value->keys as $key => $value) {
|
|
$result .= convert_to_ts($key, $value, $boolisnumber, $indentation . ' ') . ';';
|
|
|
|
if (!$value instanceof external_multiple_structure || !$value->content instanceof external_single_structure) {
|
|
// Add inline comments after the field, except for arrays of objects where it's added at the start.
|
|
$result .= get_inline_comment($value->desc);
|
|
}
|
|
|
|
$result .= "\n";
|
|
}
|
|
|
|
$result .= "$indentation}";
|
|
|
|
return $result;
|
|
|
|
} else if ($value instanceof external_multiple_structure) {
|
|
// It's an array.
|
|
$result = convert_key_type($key, '', $value->required, $indentation);
|
|
|
|
$result .= convert_to_ts(null, $value->content, $boolisnumber, $indentation, $value->desc);
|
|
|
|
$result .= "[]";
|
|
|
|
return $result;
|
|
} else {
|
|
echo "WARNING: Unknown structure: $key " . get_class($value) . " \n";
|
|
|
|
return "";
|
|
}
|
|
}
|