core\router\schema\request_body Class Reference

Inheritance diagram for core\router\schema\request_body:

Public Member Functions
	__construct (protected string string $description='', protected payload_response_type|media_type[] array|payload_response_type $content=[], protected bool bool $required=false,... $args,)
	Create a new request body.
	get_body_for_request (ServerRequestInterface $request,)
	Get the relevant body for the specified request.
	get_openapi_description (specification $api, ?string $path=null,)
	Get the OpenAPI data to include in the OpenAPI specification.
	get_openapi_schema (specification $api, ?string $path=null,)
	Get the OpenAPI data to include in the OpenAPI specification.
	get_reference (bool $qualify=true,)
	Get the $ref for this class.
	get_schema_from_type (param $type)
	Get the schema for a given type.
	is_required ()
	Whether this query parameter is required.

Static Public Member Functions
static	escape_reference (string $reference)
	Escape a reference following rules defined at https://swagger.io/docs/specification/using-ref/.
static	get_reference_for_class (string $classname, bool $qualify=true,)
	Get the $ref a class name.
static	get_reference_for_example (string $reference)
	Get the qualified $ref for an example.
static	get_reference_for_header (string $reference)
	Get the qualified $ref for a parameter.
static	get_reference_for_parameter (string $reference)
	Get the qualified $ref for a parameter.
static	get_reference_for_request_body (string $reference)
	Get the qualified $ref for a request body.
static	get_reference_for_response (string $reference)
	Get the qualified $ref for a response.
static	get_reference_for_schema (string $reference)
	Get the qualified $ref for a schema.

Constructor & Destructor Documentation

__construct()

core\router\schema\request_body::__construct	(	protected string string	$description = '',
		protected payload_response_type|media_type[]array|payload_response_type	$content = [],
		protected bool bool	$required = false,
			... )

Create a new request body.

Parameters

string	$description	A brief description of the request body.
payload_response_type | payload_response_type[]	$content	The content of the request body.
bool	$required	Whether the request body is required
	mixed	...$args Extra args for future compatibility.

Exceptions

coding_exception

if the content is not an instance of media_type.

Parameters

$description

A brief description of the request body.

This could contain examples of use. CommonMark syntax MAY be used for rich text representation.

Parameters

$content	The content of the request body.
$required	Whether the request body is required

Member Function Documentation

escape_reference()

static core\router\schema\openapi_base::escape_reference ( string $reference )

staticinherited

Escape a reference following rules defined at https://swagger.io/docs/specification/using-ref/.

Parameters

string

$reference

Return values

string

get_body_for_request()

core\router\schema\request_body::get_body_for_request

(

ServerRequestInterface

$request

)

Get the relevant body for the specified request.

Request bodies can be different for different content-types, as noted in the request.

Parameters

ServerRequestInterface

$request

Return values

media_type

Exceptions

invalid_parameter_exception

get_openapi_description()

core\router\schema\request_body::get_openapi_description	(	specification	$api,
		?string	$path = null )

Get the OpenAPI data to include in the OpenAPI specification.

Parameters

specification	$api
null | string	$path

Return values

null|stdClass

Reimplemented from core\router\schema\openapi_base.

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

null|stdClass

Exceptions

coding_exception

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

string

get_reference_for_class()

static core\router\schema\openapi_base::get_reference_for_class ( string $classname, bool $qualify = true )

staticinherited

Get the $ref a class name.

https://swagger.io/docs/specification/using-ref/

Parameters

string	$classname	The class to get a reference for
bool	$qualify	Whether to qualify the reference with the #/components/ part

Return values

string

The reference

Exceptions

coding_exception

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

string

$reference

Return values

string

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

string

$reference

Return values

string

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

string

$reference

Return values

string

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

string

$reference

Return values

string

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

string

$reference

Return values

string

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

string

$reference

Return values

string

get_schema_from_type()

core\router\schema\openapi_base::get_schema_from_type ( param $type )

inherited

Get the schema for a given type.

Parameters

param

$type

Return values

stdClass

is_required()

core\router\schema\request_body::is_required

(

)

Whether this query parameter is required.

Return values

bool

---

The documentation for this class was generated from the following file:

• lib/classes/router/schema/request_body.php