References Components
Reference
C
Class

ApiPlatform\OpenApi\Model\Components

class ApiPlatform\OpenApi\Model\Components
{
    public __construct(null|array<string, >|array<string, `<a href="/docs/main/references/OpenApi/Model/Reference">ApiPlatform\OpenApi\Model\Reference</a>`> $schemas, null|array<string, `<a href="/docs/main/references/OpenApi/Model/Response">ApiPlatform\OpenApi\Model\Response</a>`>|array<string, `<a href="/docs/main/references/OpenApi/Model/Reference">ApiPlatform\OpenApi\Model\Reference</a>`> $responses, null|array<string, `<a href="/docs/main/references/OpenApi/Model/Parameter">ApiPlatform\OpenApi\Model\Parameter</a>`>|array<string, `<a href="/docs/main/references/OpenApi/Model/Reference">ApiPlatform\OpenApi\Model\Reference</a>`> $parameters, null|array<string, `<a href="/docs/main/references/OpenApi/Model/Example">ApiPlatform\OpenApi\Model\Example</a>`>|array<string, `<a href="/docs/main/references/OpenApi/Model/Reference">ApiPlatform\OpenApi\Model\Reference</a>`> $examples, null|array<string, `<a href="/docs/main/references/OpenApi/Model/RequestBody">ApiPlatform\OpenApi\Model\RequestBody</a>`>|array<string, `<a href="/docs/main/references/OpenApi/Model/Reference">ApiPlatform\OpenApi\Model\Reference</a>`> $requestBodies, null|array<string, `<a href="/docs/main/references/OpenApi/Model/Header">ApiPlatform\OpenApi\Model\Header</a>`>|array<string, `<a href="/docs/main/references/OpenApi/Model/Reference">ApiPlatform\OpenApi\Model\Reference</a>`> $headers, null|ArrayObject $securitySchemes, null|array<string, `<a href="/docs/main/references/OpenApi/Model/Link">ApiPlatform\OpenApi\Model\Link</a>`>|array<string, `<a href="/docs/main/references/OpenApi/Model/Reference">ApiPlatform\OpenApi\Model\Reference</a>`> $links, null|array<string, array<string, `<a href="/docs/main/references/OpenApi/Model/PathItem">ApiPlatform\OpenApi\Model\PathItem</a>`>>|array<string, array<string, `<a href="/docs/main/references/OpenApi/Model/Reference">ApiPlatform\OpenApi\Model\Reference</a>`>> $callbacks, null|array<string, `<a href="/docs/main/references/OpenApi/Model/PathItem">ApiPlatform\OpenApi\Model\PathItem</a>`>|array<string, `<a href="/docs/main/references/OpenApi/Model/Reference">ApiPlatform\OpenApi\Model\Reference> $pathItems)
    public getSchemas(): ArrayObject
    public getResponses(): ArrayObject
    public getParameters(): ArrayObject
    public getExamples(): ArrayObject
    public getRequestBodies(): ArrayObject
    public getHeaders(): ArrayObject
    public getSecuritySchemes(): ArrayObject
    public getLinks(): ArrayObject
    public getCallbacks(): ArrayObject
    public getPathItems(): ArrayObject
    public withSchemas(ArrayObject $schemas): ApiPlatform\OpenApi\Model\Components
    public withResponses(ArrayObject $responses): ApiPlatform\OpenApi\Model\Components
    public withParameters(ArrayObject $parameters): ApiPlatform\OpenApi\Model\Components
    public withExamples(ArrayObject $examples): ApiPlatform\OpenApi\Model\Components
    public withRequestBodies(ArrayObject $requestBodies): ApiPlatform\OpenApi\Model\Components
    public withHeaders(ArrayObject $headers): ApiPlatform\OpenApi\Model\Components
    public withSecuritySchemes(ArrayObject $securitySchemes): ApiPlatform\OpenApi\Model\Components
    public withLinks(ArrayObject $links): ApiPlatform\OpenApi\Model\Components
    public withCallbacks(ArrayObject $callbacks): ApiPlatform\OpenApi\Model\Components
    public withPathItems(ArrayObject $pathItems): ApiPlatform\OpenApi\Model\Components
    public withExtensionProperty(string $key, $value)
    public getExtensionProperties(): array
}

Methods

__construct

public __construct(null|array<string, >|array<string, `<a href="/docs/main/references/OpenApi/Model/Reference">ApiPlatform\OpenApi\Model\Reference</a>`> $schemas, null|array<string, `<a href="/docs/main/references/OpenApi/Model/Response">ApiPlatform\OpenApi\Model\Response</a>`>|array<string, `<a href="/docs/main/references/OpenApi/Model/Reference">ApiPlatform\OpenApi\Model\Reference</a>`> $responses, null|array<string, `<a href="/docs/main/references/OpenApi/Model/Parameter">ApiPlatform\OpenApi\Model\Parameter</a>`>|array<string, `<a href="/docs/main/references/OpenApi/Model/Reference">ApiPlatform\OpenApi\Model\Reference</a>`> $parameters, null|array<string, `<a href="/docs/main/references/OpenApi/Model/Example">ApiPlatform\OpenApi\Model\Example</a>`>|array<string, `<a href="/docs/main/references/OpenApi/Model/Reference">ApiPlatform\OpenApi\Model\Reference</a>`> $examples, null|array<string, `<a href="/docs/main/references/OpenApi/Model/RequestBody">ApiPlatform\OpenApi\Model\RequestBody</a>`>|array<string, `<a href="/docs/main/references/OpenApi/Model/Reference">ApiPlatform\OpenApi\Model\Reference</a>`> $requestBodies, null|array<string, `<a href="/docs/main/references/OpenApi/Model/Header">ApiPlatform\OpenApi\Model\Header</a>`>|array<string, `<a href="/docs/main/references/OpenApi/Model/Reference">ApiPlatform\OpenApi\Model\Reference</a>`> $headers, null|ArrayObject $securitySchemes, null|array<string, `<a href="/docs/main/references/OpenApi/Model/Link">ApiPlatform\OpenApi\Model\Link</a>`>|array<string, `<a href="/docs/main/references/OpenApi/Model/Reference">ApiPlatform\OpenApi\Model\Reference</a>`> $links, null|array<string, array<string, `<a href="/docs/main/references/OpenApi/Model/PathItem">ApiPlatform\OpenApi\Model\PathItem</a>`>>|array<string, array<string, `<a href="/docs/main/references/OpenApi/Model/Reference">ApiPlatform\OpenApi\Model\Reference</a>`>> $callbacks, null|array<string, `<a href="/docs/main/references/OpenApi/Model/PathItem">ApiPlatform\OpenApi\Model\PathItem</a>`>|array<string, `<a href="/docs/main/references/OpenApi/Model/Reference">ApiPlatform\OpenApi\Model\Reference> $pathItems)

Parameters

schemasarray<string, `ApiPlatform\OpenApi\Model\Schema`>
array<string, `ApiPlatform\OpenApi\Model\Reference`>
responsesarray<string, `ApiPlatform\OpenApi\Model\Response`>
array<string, `ApiPlatform\OpenApi\Model\Reference`>
parametersarray<string, `ApiPlatform\OpenApi\Model\Parameter`>
array<string, `ApiPlatform\OpenApi\Model\Reference`>
examplesarray<string, `ApiPlatform\OpenApi\Model\Example`>
array<string, `ApiPlatform\OpenApi\Model\Reference`>
requestBodiesarray<string, `ApiPlatform\OpenApi\Model\RequestBody`>
array<string, `ApiPlatform\OpenApi\Model\Reference`>
headersarray<string, `ApiPlatform\OpenApi\Model\Header`>
array<string, `ApiPlatform\OpenApi\Model\Reference`>
securitySchemesArrayObject
linksarray<string, `ApiPlatform\OpenApi\Model\Link`>
array<string, `ApiPlatform\OpenApi\Model\Reference`>
callbacksarray<string, array<string, `ApiPlatform\OpenApi\Model\PathItem`>>
array<string, array<string, `ApiPlatform\OpenApi\Model\Reference`>>
pathItemsarray<string, `ApiPlatform\OpenApi\Model\PathItem`>
array<string, `ApiPlatform\OpenApi\Model\Reference`>

getSchemas

public getSchemas(): ArrayObject

Returns

ArrayObject

getResponses

public getResponses(): ArrayObject

Returns

ArrayObject

getParameters

public getParameters(): ArrayObject

Returns

ArrayObject

getExamples

public getExamples(): ArrayObject

Returns

ArrayObject

getRequestBodies

public getRequestBodies(): ArrayObject

Returns

ArrayObject

getHeaders

public getHeaders(): ArrayObject

Returns

ArrayObject

getSecuritySchemes

public getSecuritySchemes(): ArrayObject

Returns

ArrayObject

public getLinks(): ArrayObject

Returns

ArrayObject

getCallbacks

public getCallbacks(): ArrayObject

Returns

ArrayObject

getPathItems

public getPathItems(): ArrayObject

Returns

ArrayObject

withSchemas

public withSchemas(ArrayObject $schemas): ApiPlatform\OpenApi\Model\Components

Parameters

schemasArrayObject

Returns

<a href="/docs/main/references/OpenApi/Model/Components">ApiPlatform\OpenApi\Model\Components</a>

withResponses

public withResponses(ArrayObject $responses): ApiPlatform\OpenApi\Model\Components

Parameters

responsesArrayObject

Returns

<a href="/docs/main/references/OpenApi/Model/Components">ApiPlatform\OpenApi\Model\Components</a>

withParameters

public withParameters(ArrayObject $parameters): ApiPlatform\OpenApi\Model\Components

Parameters

parametersArrayObject

Returns

<a href="/docs/main/references/OpenApi/Model/Components">ApiPlatform\OpenApi\Model\Components</a>

withExamples

public withExamples(ArrayObject $examples): ApiPlatform\OpenApi\Model\Components

Parameters

examplesArrayObject

Returns

<a href="/docs/main/references/OpenApi/Model/Components">ApiPlatform\OpenApi\Model\Components</a>

withRequestBodies

public withRequestBodies(ArrayObject $requestBodies): ApiPlatform\OpenApi\Model\Components

Parameters

requestBodiesArrayObject

Returns

<a href="/docs/main/references/OpenApi/Model/Components">ApiPlatform\OpenApi\Model\Components</a>

withHeaders

public withHeaders(ArrayObject $headers): ApiPlatform\OpenApi\Model\Components

Parameters

headersArrayObject

Returns

<a href="/docs/main/references/OpenApi/Model/Components">ApiPlatform\OpenApi\Model\Components</a>

withSecuritySchemes

public withSecuritySchemes(ArrayObject $securitySchemes): ApiPlatform\OpenApi\Model\Components

Parameters

securitySchemesArrayObject

Returns

<a href="/docs/main/references/OpenApi/Model/Components">ApiPlatform\OpenApi\Model\Components</a>

public withLinks(ArrayObject $links): ApiPlatform\OpenApi\Model\Components

Parameters

linksArrayObject

Returns

<a href="/docs/main/references/OpenApi/Model/Components">ApiPlatform\OpenApi\Model\Components</a>

withCallbacks

public withCallbacks(ArrayObject $callbacks): ApiPlatform\OpenApi\Model\Components

Parameters

callbacksArrayObject

Returns

<a href="/docs/main/references/OpenApi/Model/Components">ApiPlatform\OpenApi\Model\Components</a>

withPathItems

public withPathItems(ArrayObject $pathItems): ApiPlatform\OpenApi\Model\Components

Parameters

pathItemsArrayObject

Returns

<a href="/docs/main/references/OpenApi/Model/Components">ApiPlatform\OpenApi\Model\Components</a>

withExtensionProperty

public withExtensionProperty(string $key, $value)

Parameters

keystring
value

Returns

getExtensionProperties

public getExtensionProperties(): array

Returns

array

Made with love by

Les-Tilleuls.coop can help you design and develop your APIs and web projects, and train your teams in API Platform, Symfony, Next.js, Kubernetes and a wide range of other technologies.

Learn more

Copyright © 2023 Kévin Dunglas

Sponsored by Les-Tilleuls.coop