◆ __construct()
core\router\schema\openapi_base::__construct |
( |
mixed ... | $extra | ) |
|
Base constructor which does nothing.
We keep an $extra parameter here for future-proofing. This allows named parameters to be used and allows contrib plugins to make use of parameters in newer versions even if they don't exist in older versions.
- Parameters
-
mixed | ...$extra Extra arguments to allow for future versions of Moodle to add options without breaking plugins |
◆ escape_reference()
static core\router\schema\openapi_base::escape_reference |
( |
string | $reference | ) |
|
|
static |
◆ get_openapi_description()
core\router\schema\openapi_base::get_openapi_description |
( |
specification | $api, |
|
|
?string | $path = null ) |
|
abstract |
Get the OpenAPI data to include in the OpenAPI specification.
- Parameters
-
specification | $api | |
null | string | $path | |
- Return values
-
Reimplemented in core\router\schema\example, core\router\schema\header_object, core\router\schema\objects\array_of_things, core\router\schema\objects\scalar_type, core\router\schema\objects\schema_object, core\router\schema\objects\stacktrace, core\router\schema\objects\type_base, core\router\schema\parameter, core\router\schema\parameters\path_parameter, core\router\schema\parameters\query_parameter, core\router\schema\request_body, core\router\schema\response\content\media_type, core\router\schema\response\content\payload_response_type, and core\router\schema\response\response.
◆ get_openapi_schema()
core\router\schema\openapi_base::get_openapi_schema |
( |
specification | $api, |
|
|
?string | $path = null ) |
|
final |
Get the OpenAPI data to include in the OpenAPI specification.
- Parameters
-
specification | $api | |
null | string | $path | |
- Return values
-
- Exceptions
-
◆ get_reference()
core\router\schema\openapi_base::get_reference |
( |
bool | $qualify = true | ) |
|
Get the $ref for this class.
- Parameters
-
bool | $qualify | Whether to qualify the reference with the #/components/ part. |
- Return values
-
◆ get_reference_for_class()
static core\router\schema\openapi_base::get_reference_for_class |
( |
string | $classname, |
|
|
bool | $qualify = true ) |
|
static |
◆ get_reference_for_example()
static core\router\schema\openapi_base::get_reference_for_example |
( |
string | $reference | ) |
|
|
static |
Get the qualified $ref for an example.
- Parameters
-
- Return values
-
◆ get_reference_for_header()
static core\router\schema\openapi_base::get_reference_for_header |
( |
string | $reference | ) |
|
|
static |
Get the qualified $ref for a parameter.
- Parameters
-
- Return values
-
◆ get_reference_for_parameter()
static core\router\schema\openapi_base::get_reference_for_parameter |
( |
string | $reference | ) |
|
|
static |
Get the qualified $ref for a parameter.
- Parameters
-
- Return values
-
◆ get_reference_for_request_body()
static core\router\schema\openapi_base::get_reference_for_request_body |
( |
string | $reference | ) |
|
|
static |
Get the qualified $ref for a request body.
- Parameters
-
- Return values
-
◆ get_reference_for_response()
static core\router\schema\openapi_base::get_reference_for_response |
( |
string | $reference | ) |
|
|
static |
Get the qualified $ref for a response.
- Parameters
-
- Return values
-
◆ get_reference_for_schema()
static core\router\schema\openapi_base::get_reference_for_schema |
( |
string | $reference | ) |
|
|
static |
Get the qualified $ref for a schema.
- Parameters
-
- Return values
-
◆ get_schema_from_type()
core\router\schema\openapi_base::get_schema_from_type |
( |
param | $type | ) |
|
Get the schema for a given type.
- Parameters
-
- Return values
-
The documentation for this class was generated from the following file:
- lib/classes/router/schema/openapi_base.php