Reference
C
Class

ApiPlatform\OpenApi\Model\Info

class ApiPlatform\OpenApi\Model\Info
{
    public __construct(string $title, string $version, string $description, null|string $termsOfService, null|$contact, null|`<a href="/docs/main/references/OpenApi/Model/License">ApiPlatform\OpenApi\Model\License $license, null|string $summary)
    public getTitle(): string
    public getDescription(): string
    public getTermsOfService(): string
    public getContact(): ApiPlatform\OpenApi\Model\Contact
    public getLicense(): ApiPlatform\OpenApi\Model\License
    public getVersion(): string
    public getSummary(): string
    public withTitle(string $title): ApiPlatform\OpenApi\Model\Info
    public withDescription(string $description): ApiPlatform\OpenApi\Model\Info
    public withTermsOfService(string $termsOfService): ApiPlatform\OpenApi\Model\Info
    public withContact($contact): `<a href="/docs/main/references/OpenApi/Model/Info">ApiPlatform\OpenApi\Model\Info
    public withLicense($license): `<a href="/docs/main/references/OpenApi/Model/Info">ApiPlatform\OpenApi\Model\Info
    public withVersion(string $version): ApiPlatform\OpenApi\Model\Info
    public withSummary(string $summary): ApiPlatform\OpenApi\Model\Info
    public withExtensionProperty(string $key, $value)
    public getExtensionProperties(): array
}

Methods

__construct

public __construct(string $title, string $version, string $description, null|string $termsOfService, null|$contact, null|`<a href="/docs/main/references/OpenApi/Model/License">ApiPlatform\OpenApi\Model\License $license, null|string $summary)

Parameters

titlestring
versionstring
descriptionstring
termsOfServicestring
contact`ApiPlatform\OpenApi\Model\Contact`
license`ApiPlatform\OpenApi\Model\License`
summarystring

getTitle

public getTitle(): string

Returns

string

getDescription

public getDescription(): string

Returns

string

getTermsOfService

public getTermsOfService(): string

Returns

string

getContact

Returns

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

getLicense

Returns

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

getVersion

public getVersion(): string

Returns

string

getSummary

public getSummary(): string

Returns

string

withTitle

public withTitle(string $title): ApiPlatform\OpenApi\Model\Info

Parameters

titlestring

Returns

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

withDescription

public withDescription(string $description): ApiPlatform\OpenApi\Model\Info

Parameters

descriptionstring

Returns

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

withTermsOfService

public withTermsOfService(string $termsOfService): ApiPlatform\OpenApi\Model\Info

Parameters

termsOfServicestring

Returns

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

withContact

Parameters

contact`ApiPlatform\OpenApi\Model\Contact`

Returns

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

withLicense

Parameters

license`ApiPlatform\OpenApi\Model\License`

Returns

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

withVersion

public withVersion(string $version): ApiPlatform\OpenApi\Model\Info

Parameters

versionstring

Returns

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

withSummary

public withSummary(string $summary): ApiPlatform\OpenApi\Model\Info

Parameters

summarystring

Returns

<a href="/docs/main/references/OpenApi/Model/Info">ApiPlatform\OpenApi\Model\Info</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