BaseEndpoint implements Endpoint
Interfaces, Classes and Traits
Table of Contents
- $body : mixed
- $headerParameters : mixed
- $queryParameters : mixed
- getAuthenticationScopes() : array<string|int, mixed>
- Get security scopes of an endpoint.
- getBody() : array<string|int, mixed>
- Get body for an endpoint.
- getHeaders() : array<string|int, mixed>
- Get the headers of an endpoint.
- getMethod() : string
- Get the HTTP method of an endpoint (like GET, POST, ...).
- getQueryString() : string
- Get the query string of an endpoint without the starting ? (like foo=foo&bar=bar).
- getUri() : string
- Get the URI of an endpoint (like /foo-uri).
- getExtraHeaders() : array<string|int, mixed>
- getFormBody() : array<string|int, mixed>
- getFormOptionsResolver() : OptionsResolver
- getHeadersOptionsResolver() : OptionsResolver
- getMultipartBody() : array<string|int, mixed>
- getQueryOptionsResolver() : OptionsResolver
- getSerializedBody() : array<string|int, mixed>
- transformResponseBody() : mixed
Properties
$body
protected
mixed
$body
$headerParameters
protected
mixed
$headerParameters
= []
$queryParameters
protected
mixed
$queryParameters
= []
Methods
getAuthenticationScopes()
Get security scopes of an endpoint.
public
abstract getAuthenticationScopes() : array<string|int, mixed>
Return values
array<string|int, mixed> —getBody()
Get body for an endpoint.
public
abstract getBody(SerializerInterface $serializer[, mixed $streamFactory = null ]) : array<string|int, mixed>
Return value consist of an array where the first item will be a list of headers to add on the request (like the Content Type) And the second value consist of the body object.
Parameters
- $serializer : SerializerInterface
- $streamFactory : mixed = null
Return values
array<string|int, mixed> —getHeaders()
Get the headers of an endpoint.
public
getHeaders([array<string|int, mixed> $baseHeaders = [] ]) : array<string|int, mixed>
Parameters
- $baseHeaders : array<string|int, mixed> = []
Return values
array<string|int, mixed> —getMethod()
Get the HTTP method of an endpoint (like GET, POST, ...).
public
abstract getMethod() : string
Return values
string —getQueryString()
Get the query string of an endpoint without the starting ? (like foo=foo&bar=bar).
public
getQueryString() : string
Return values
string —getUri()
Get the URI of an endpoint (like /foo-uri).
public
abstract getUri() : string
Return values
string —getExtraHeaders()
protected
getExtraHeaders() : array<string|int, mixed>
Return values
array<string|int, mixed> —getFormBody()
protected
getFormBody() : array<string|int, mixed>
Return values
array<string|int, mixed> —getFormOptionsResolver()
protected
getFormOptionsResolver() : OptionsResolver
Return values
OptionsResolver —getHeadersOptionsResolver()
protected
getHeadersOptionsResolver() : OptionsResolver
Return values
OptionsResolver —getMultipartBody()
protected
getMultipartBody([mixed $streamFactory = null ]) : array<string|int, mixed>
Parameters
- $streamFactory : mixed = null
Return values
array<string|int, mixed> —getQueryOptionsResolver()
protected
getQueryOptionsResolver() : OptionsResolver
Return values
OptionsResolver —getSerializedBody()
protected
getSerializedBody(SerializerInterface $serializer) : array<string|int, mixed>
Parameters
- $serializer : SerializerInterface
Return values
array<string|int, mixed> —transformResponseBody()
protected
abstract transformResponseBody(string $body, int $status, SerializerInterface $serializer, string|null $contentType) : mixed
Parameters
- $body : string
- $status : int
- $serializer : SerializerInterface
- $contentType : string|null