Application API Documentation

Directional Consulting

Search Documentation

Classes

FosRestDescriber in package implements RouteDescriberInterface Uses RouteDescriberTrait

Interfaces, Classes and Traits

RouteDescriberInterface

Table of Contents

$annotationReader  : Reader
$mediaTypes  : array<string|int, string>
__construct()  : mixed
describe()  : mixed
describeCommonSchemaFromAnnotation()  : mixed
getAttributesAsAnnotation()  : array<string|int, AbstractAnnotation>
getContentSchemaForType()  : Schema
getFormat()  : mixed
getPattern()  : mixed
normalizePath()  : string

Properties

$annotationReader

private Reader $annotationReader

$mediaTypes

private array<string|int, string> $mediaTypes

Methods

__construct()

public __construct(Reader $annotationReader, array<string|int, mixed> $mediaTypes) : mixed
Parameters
$annotationReader : Reader
$mediaTypes : array<string|int, mixed>
Return values
mixed —

describe()

public describe(OpenApi $api, Route $route, ReflectionMethod $reflectionMethod) : mixed
Parameters
$api : OpenApi
$route : Route
$reflectionMethod : ReflectionMethod
Return values
mixed —

describeCommonSchemaFromAnnotation()

private describeCommonSchemaFromAnnotation(Schema $schema, mixed $annotation) : mixed
Parameters
$schema : Schema
$annotation : mixed
Return values
mixed —

getAttributesAsAnnotation()

private getAttributesAsAnnotation(ReflectionMethod $reflection, string $className) : array<string|int, AbstractAnnotation>
Parameters
$reflection : ReflectionMethod
$className : string
Return values
array<string|int, AbstractAnnotation> —

getContentSchemaForType()

private getContentSchemaForType(RequestBody $requestBody, string $type) : Schema
Parameters
$requestBody : RequestBody
$type : string
Return values
Schema —

getFormat()

private getFormat(mixed $requirements) : mixed
Parameters
$requirements : mixed
Return values
mixed —

getPattern()

private getPattern(mixed $requirements) : mixed
Parameters
$requirements : mixed
Return values
mixed —

normalizePath()

private normalizePath(string $path) : string
Parameters
$path : string
Return values
string — 

        

        
    




    

    

                    

    
Search Results

    

        

            
Search results

            
        

        

            
Found Results