# ApiPlatform\OpenApi\Model\Parameter

class ApiPlatform\OpenApi\Model\Parameter
{
    public __construct(string $name, string $in, string $description, bool $required, bool $deprecated, bool $allowEmptyValue, array $schema, null|string $style, bool $explode, bool $allowReserved, $example, null|ArrayObject $examples, null|ArrayObject $content)
    public getName(): string
    public getIn(): string
    public getDescription(): string
    public getRequired(): bool
    public getDeprecated(): bool
    public canAllowEmptyValue(): bool
    public getAllowEmptyValue(): bool
    public getSchema(): array
    public getStyle(): string
    public canExplode(): bool
    public getExplode(): bool
    public canAllowReserved(): bool
    public getAllowReserved(): bool
    public getExample()
    public getExamples(): ArrayObject
    public getContent(): ArrayObject
    public withName(string $name): ApiPlatform\OpenApi\Model\Parameter
    public withIn(string $in): ApiPlatform\OpenApi\Model\Parameter
    public withDescription(string $description): ApiPlatform\OpenApi\Model\Parameter
    public withRequired(bool $required): ApiPlatform\OpenApi\Model\Parameter
    public withDeprecated(bool $deprecated): ApiPlatform\OpenApi\Model\Parameter
    public withAllowEmptyValue(bool $allowEmptyValue): ApiPlatform\OpenApi\Model\Parameter
    public withSchema(array $schema): ApiPlatform\OpenApi\Model\Parameter
    public withStyle(string $style): ApiPlatform\OpenApi\Model\Parameter
    public withExplode(bool $explode): ApiPlatform\OpenApi\Model\Parameter
    public withAllowReserved(bool $allowReserved): ApiPlatform\OpenApi\Model\Parameter
    public withExample($example): ApiPlatform\OpenApi\Model\Parameter
    public withExamples(ArrayObject $examples): ApiPlatform\OpenApi\Model\Parameter
    public withContent(ArrayObject $content): ApiPlatform\OpenApi\Model\Parameter
    public withExtensionProperty(string $key, $value)
    public getExtensionProperties(): array
}

# Methods

# __construct

public __construct(string $name, string $in, string $description, bool $required, bool $deprecated, bool $allowEmptyValue, array $schema, null|string $style, bool $explode, bool $allowReserved, $example, null|ArrayObject $examples, null|ArrayObject $content)

# Parameters

name	string
in	string
description	string
required	bool
deprecated	bool
allowEmptyValue	bool
schema	array
style	string
explode	bool
allowReserved	bool
example
examples	ArrayObject
content	ArrayObject

# getName

public getName(): string

# Returns

string

# getIn

public getIn(): string

# Returns

string

# getDescription

public getDescription(): string

# Returns

string

# getRequired

public getRequired(): bool

# Returns

bool

# getDeprecated

public getDeprecated(): bool

# Returns

bool

# canAllowEmptyValue

public canAllowEmptyValue(): bool

# Returns

bool

# getAllowEmptyValue

public getAllowEmptyValue(): bool

# Returns

bool

# getSchema

public getSchema(): array

# Returns

array

# getStyle

public getStyle(): string

# Returns

string

# canExplode

public canExplode(): bool

# Returns

bool

# getExplode

public getExplode(): bool

# Returns

bool

# canAllowReserved

public canAllowReserved(): bool

# Returns

bool

# getAllowReserved

public getAllowReserved(): bool

# Returns

bool

# getExample

public getExample()

# getExamples

public getExamples(): ArrayObject

# Returns

ArrayObject

# getContent

public getContent(): ArrayObject

# Returns

ArrayObject

# withName

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

# Parameters

name

string

# Returns

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

# withIn

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

# Parameters

string

# Returns

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

# withDescription

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

# Parameters

description

string

# Returns

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

# withRequired

public withRequired(bool $required): ApiPlatform\OpenApi\Model\Parameter

# Parameters

required

bool

# Returns

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

# withDeprecated

public withDeprecated(bool $deprecated): ApiPlatform\OpenApi\Model\Parameter

# Parameters

deprecated

bool

# Returns

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

# withAllowEmptyValue

public withAllowEmptyValue(bool $allowEmptyValue): ApiPlatform\OpenApi\Model\Parameter

# Parameters

allowEmptyValue

bool

# Returns

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

# withSchema

public withSchema(array $schema): ApiPlatform\OpenApi\Model\Parameter

# Parameters

schema

array

# Returns

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

# withStyle

public withStyle(string $style): ApiPlatform\OpenApi\Model\Parameter

# Parameters

style

string

# Returns

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

# withExplode

public withExplode(bool $explode): ApiPlatform\OpenApi\Model\Parameter

# Parameters

explode

bool

# Returns

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

# withAllowReserved

public withAllowReserved(bool $allowReserved): ApiPlatform\OpenApi\Model\Parameter

# Parameters

allowReserved

bool

# Returns

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

# withExample

public withExample($example): ApiPlatform\OpenApi\Model\Parameter

# Parameters

example

# Returns

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

# withExamples

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

# Parameters

examples

ArrayObject

# Returns

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

# withContent

public withContent(ArrayObject $content): ApiPlatform\OpenApi\Model\Parameter

# Parameters

content

ArrayObject

# Returns

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

# withExtensionProperty

public withExtensionProperty(string $key, $value)

# Parameters

key	string
value

# Returns

# getExtensionProperties

public getExtensionProperties(): array

# Returns

array

Get ready for game-changing announcements for the PHP community!

# ApiPlatform\OpenApi\Model\Parameter

# Methods

# __construct

# Parameters

# getName

# Returns

# getIn

# Returns

# getDescription

# Returns

# getRequired

# Returns

# getDeprecated

# Returns

# canAllowEmptyValue

# Returns

# getAllowEmptyValue

# Returns

# getSchema

# Returns

# getStyle

# Returns

# canExplode

# Returns

# getExplode

# Returns

# canAllowReserved

# Returns

# getAllowReserved

# Returns

# getExample

# getExamples

# Returns

# getContent

# Returns

# withName

# Parameters

# Returns

# withIn

# Parameters

# Returns

# withDescription

# Parameters

# Returns

# withRequired

# Parameters

# Returns

# withDeprecated

# Parameters

# Returns

# withAllowEmptyValue

# Parameters

# Returns

# withSchema

# Parameters

# Returns

# withStyle

# Parameters

# Returns

# withExplode

# Parameters

# Returns

# withAllowReserved

# Parameters

# Returns

# withExample

# Parameters

# Returns

# withExamples

# Parameters

# Returns

# withContent

# Parameters

# Returns

# withExtensionProperty

# Parameters

# Returns

# getExtensionProperties

# Returns