|
string const | IN_COOKIE = 'cookie' |
| A cookie parameter.
|
|
string const | IN_HEADER = 'header' |
| A header parameter.
|
|
string const | IN_PATH = 'path' |
| A URI path parameter.
|
|
string const | IN_QUERY = 'query' |
| A query parameter.
|
|
◆ __construct()
core\router\parameters\path_component::__construct |
( |
string | $name = 'component', |
|
|
| ... ) |
Create a new path_component parameter.
- Parameters
-
string | $name | The name of the parameter to use for the component name |
| mixed | ...$extra Additional arguments |
◆ escape_reference()
static core\router\schema\openapi_base::escape_reference |
( |
string | $reference | ) |
|
|
staticinherited |
◆ get_in()
core\router\schema\parameter::get_in |
( |
| ) |
|
|
inherited |
Get the OpenAPI 'in' property.
- Return values
-
◆ get_name()
core\router\schema\parameter::get_name |
( |
| ) |
|
|
inherited |
Get the name of the parameter.
- Return values
-
◆ get_openapi_description()
core\router\schema\parameters\path_parameter::get_openapi_description |
( |
specification | $api, |
|
|
?string | $path = null ) |
|
finalinherited |
Get the OpenAPI data to include in the OpenAPI specification.
- Parameters
-
specification | $api | |
null | string | $path | |
- Return values
-
Reimplemented from core\router\schema\parameter.
◆ get_openapi_schema()
core\router\schema\openapi_base::get_openapi_schema |
( |
specification | $api, |
|
|
?string | $path = null ) |
|
finalinherited |
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 | ) |
|
|
inherited |
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 ) |
|
staticinherited |
◆ get_reference_for_example()
static core\router\schema\openapi_base::get_reference_for_example |
( |
string | $reference | ) |
|
|
staticinherited |
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 | ) |
|
|
staticinherited |
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 | ) |
|
|
staticinherited |
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 | ) |
|
|
staticinherited |
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 | ) |
|
|
staticinherited |
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 | ) |
|
|
staticinherited |
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 | ) |
|
|
inherited |
Get the schema for a given type.
- Parameters
-
- Return values
-
◆ get_type()
core\router\schema\parameter::get_type |
( |
| ) |
|
|
inherited |
Fetch the underlying param.
- Return values
-
◆ is_required()
core\router\schema\parameters\path_parameter::is_required |
( |
route | $route | ) |
|
|
inherited |
◆ validate()
core\router\schema\parameters\path_parameter::validate |
( |
ServerRequestInterface | $request, |
|
|
RoutingRoute | $route ) |
|
inherited |
Validate the path parameter.
- Parameters
-
ServerRequestInterface | $request | |
RoutingRoute | $route | |
- Return values
-
ServerRequestInterface | The modified request with parameters updated |
The documentation for this class was generated from the following file:
- lib/classes/router/parameters/path_component.php