Reference
C
Class

ApiPlatform\OpenApi\Model\SecurityScheme

class ApiPlatform\OpenApi\Model\SecurityScheme
{
    public __construct(null|string $type, string $description, null|string $name, null|string $in, null|string $scheme, null|string $bearerFormat, null|ApiPlatform\OpenApi\Model\OAuthFlows $flows, null|string $openIdConnectUrl)
    public getType(): string
    public getDescription(): string
    public getName(): string
    public getIn(): string
    public getScheme(): string
    public getBearerFormat(): string
    public getFlows(): ApiPlatform\OpenApi\Model\OAuthFlows
    public getOpenIdConnectUrl(): string
    public withType(string $type): ApiPlatform\OpenApi\Model\SecurityScheme
    public withDescription(string $description): ApiPlatform\OpenApi\Model\SecurityScheme
    public withName(string $name): ApiPlatform\OpenApi\Model\SecurityScheme
    public withIn(string $in): ApiPlatform\OpenApi\Model\SecurityScheme
    public withScheme(string $scheme): ApiPlatform\OpenApi\Model\SecurityScheme
    public withBearerFormat(string $bearerFormat): ApiPlatform\OpenApi\Model\SecurityScheme
    public withFlows(ApiPlatform\OpenApi\Model\OAuthFlows $flows): ApiPlatform\OpenApi\Model\SecurityScheme
    public withOpenIdConnectUrl(string $openIdConnectUrl): ApiPlatform\OpenApi\Model\SecurityScheme
    public withExtensionProperty(string $key, $value)
    public getExtensionProperties(): array
}
class ApiPlatform\OpenApi\Model\SecurityScheme
{
    public __construct(null|string $type, string $description, null|string $name, null|string $in, null|string $scheme, null|string $bearerFormat, null|ApiPlatform\OpenApi\Model\OAuthFlows $flows, null|string $openIdConnectUrl)
    public getType(): string
    public getDescription(): string
    public getName(): string
    public getIn(): string
    public getScheme(): string
    public getBearerFormat(): string
    public getFlows(): ApiPlatform\OpenApi\Model\OAuthFlows
    public getOpenIdConnectUrl(): string
    public withType(string $type): ApiPlatform\OpenApi\Model\SecurityScheme
    public withDescription(string $description): ApiPlatform\OpenApi\Model\SecurityScheme
    public withName(string $name): ApiPlatform\OpenApi\Model\SecurityScheme
    public withIn(string $in): ApiPlatform\OpenApi\Model\SecurityScheme
    public withScheme(string $scheme): ApiPlatform\OpenApi\Model\SecurityScheme
    public withBearerFormat(string $bearerFormat): ApiPlatform\OpenApi\Model\SecurityScheme
    public withFlows(ApiPlatform\OpenApi\Model\OAuthFlows $flows): ApiPlatform\OpenApi\Model\SecurityScheme
    public withOpenIdConnectUrl(string $openIdConnectUrl): ApiPlatform\OpenApi\Model\SecurityScheme
    public withExtensionProperty(string $key, $value)
    public getExtensionProperties(): array
}

Methods

__construct

public __construct(null|string $type, string $description, null|string $name, null|string $in, null|string $scheme, null|string $bearerFormat, null|ApiPlatform\OpenApi\Model\OAuthFlows $flows, null|string $openIdConnectUrl)
public __construct(null|string $type, string $description, null|string $name, null|string $in, null|string $scheme, null|string $bearerFormat, null|ApiPlatform\OpenApi\Model\OAuthFlows $flows, null|string $openIdConnectUrl)

Parameters

typestring
descriptionstring
namestring
instring
schemestring
bearerFormatstring
flowsApiPlatform\OpenApi\Model\OAuthFlows
openIdConnectUrlstring

getType

public getType(): string
public getType(): string

Returns

string

getDescription

public getDescription(): string
public getDescription(): string

Returns

string

getName

public getName(): string
public getName(): string

Returns

string

getIn

public getIn(): string
public getIn(): string

Returns

string

getScheme

public getScheme(): string
public getScheme(): string

Returns

string

getBearerFormat

public getBearerFormat(): string
public getBearerFormat(): string

Returns

string

getFlows

Returns

ApiPlatform\OpenApi\Model\OAuthFlows

getOpenIdConnectUrl

public getOpenIdConnectUrl(): string
public getOpenIdConnectUrl(): string

Returns

string

withType

public withType(string $type): ApiPlatform\OpenApi\Model\SecurityScheme
public withType(string $type): ApiPlatform\OpenApi\Model\SecurityScheme

Parameters

typestring

Returns

ApiPlatform\OpenApi\Model\SecurityScheme

withDescription

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

Parameters

descriptionstring

Returns

ApiPlatform\OpenApi\Model\SecurityScheme

withName

public withName(string $name): ApiPlatform\OpenApi\Model\SecurityScheme
public withName(string $name): ApiPlatform\OpenApi\Model\SecurityScheme

Parameters

namestring

Returns

ApiPlatform\OpenApi\Model\SecurityScheme

withIn

public withIn(string $in): ApiPlatform\OpenApi\Model\SecurityScheme
public withIn(string $in): ApiPlatform\OpenApi\Model\SecurityScheme

Parameters

instring

Returns

ApiPlatform\OpenApi\Model\SecurityScheme

withScheme

public withScheme(string $scheme): ApiPlatform\OpenApi\Model\SecurityScheme
public withScheme(string $scheme): ApiPlatform\OpenApi\Model\SecurityScheme

Parameters

schemestring

Returns

ApiPlatform\OpenApi\Model\SecurityScheme

withBearerFormat

public withBearerFormat(string $bearerFormat): ApiPlatform\OpenApi\Model\SecurityScheme
public withBearerFormat(string $bearerFormat): ApiPlatform\OpenApi\Model\SecurityScheme

Parameters

bearerFormatstring

Returns

ApiPlatform\OpenApi\Model\SecurityScheme

withFlows

Parameters

flowsApiPlatform\OpenApi\Model\OAuthFlows

Returns

ApiPlatform\OpenApi\Model\SecurityScheme

withOpenIdConnectUrl

public withOpenIdConnectUrl(string $openIdConnectUrl): ApiPlatform\OpenApi\Model\SecurityScheme
public withOpenIdConnectUrl(string $openIdConnectUrl): ApiPlatform\OpenApi\Model\SecurityScheme

Parameters

openIdConnectUrlstring

Returns

ApiPlatform\OpenApi\Model\SecurityScheme

withExtensionProperty

public withExtensionProperty(string $key, $value)
public withExtensionProperty(string $key, $value)

Parameters

keystring
value

Returns

getExtensionProperties

public getExtensionProperties(): array
public getExtensionProperties(): array

Returns

array

Copyright © 2023 Kévin Dunglas

Sponsored by Les-Tilleuls.coop