Guides
Tutorials
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
}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
}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 __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)| 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 |
public getName(): stringpublic getName(): stringstring
public getIn(): stringpublic getIn(): stringstring
public getDescription(): stringpublic getDescription(): stringstring
public getRequired(): boolpublic getRequired(): boolbool
public getDeprecated(): boolpublic getDeprecated(): boolbool
public canAllowEmptyValue(): boolpublic canAllowEmptyValue(): boolbool
public getAllowEmptyValue(): boolpublic getAllowEmptyValue(): boolbool
public getSchema(): arraypublic getSchema(): arrayarray
public getStyle(): stringpublic getStyle(): stringstring
public canExplode(): boolpublic canExplode(): boolbool
public getExplode(): boolpublic getExplode(): boolbool
public canAllowReserved(): boolpublic canAllowReserved(): boolbool
public getAllowReserved(): boolpublic getAllowReserved(): boolbool
public getExample()public getExample()public getExamples(): ArrayObjectpublic getExamples(): ArrayObjectArrayObject
public getContent(): ArrayObjectpublic getContent(): ArrayObjectArrayObject
public withName(string $name): ApiPlatform\OpenApi\Model\Parameterpublic withName(string $name): ApiPlatform\OpenApi\Model\Parameter| name | string |
ApiPlatform\OpenApi\Model\Parameter
public withIn(string $in): ApiPlatform\OpenApi\Model\Parameterpublic withIn(string $in): ApiPlatform\OpenApi\Model\Parameter| in | string |
ApiPlatform\OpenApi\Model\Parameter
public withDescription(string $description): ApiPlatform\OpenApi\Model\Parameterpublic withDescription(string $description): ApiPlatform\OpenApi\Model\Parameter| description | string |
ApiPlatform\OpenApi\Model\Parameter
public withRequired(bool $required): ApiPlatform\OpenApi\Model\Parameterpublic withRequired(bool $required): ApiPlatform\OpenApi\Model\Parameter| required | bool |
ApiPlatform\OpenApi\Model\Parameter
public withDeprecated(bool $deprecated): ApiPlatform\OpenApi\Model\Parameterpublic withDeprecated(bool $deprecated): ApiPlatform\OpenApi\Model\Parameter| deprecated | bool |
ApiPlatform\OpenApi\Model\Parameter
public withAllowEmptyValue(bool $allowEmptyValue): ApiPlatform\OpenApi\Model\Parameterpublic withAllowEmptyValue(bool $allowEmptyValue): ApiPlatform\OpenApi\Model\Parameter| allowEmptyValue | bool |
ApiPlatform\OpenApi\Model\Parameter
public withSchema(array $schema): ApiPlatform\OpenApi\Model\Parameterpublic withSchema(array $schema): ApiPlatform\OpenApi\Model\Parameter| schema | array |
ApiPlatform\OpenApi\Model\Parameter
public withStyle(string $style): ApiPlatform\OpenApi\Model\Parameterpublic withStyle(string $style): ApiPlatform\OpenApi\Model\Parameter| style | string |
ApiPlatform\OpenApi\Model\Parameter
public withExplode(bool $explode): ApiPlatform\OpenApi\Model\Parameterpublic withExplode(bool $explode): ApiPlatform\OpenApi\Model\Parameter| explode | bool |
ApiPlatform\OpenApi\Model\Parameter
public withAllowReserved(bool $allowReserved): ApiPlatform\OpenApi\Model\Parameterpublic withAllowReserved(bool $allowReserved): ApiPlatform\OpenApi\Model\Parameter| allowReserved | bool |
ApiPlatform\OpenApi\Model\Parameter
public withExample($example): ApiPlatform\OpenApi\Model\Parameterpublic withExample($example): ApiPlatform\OpenApi\Model\Parameter| example |
ApiPlatform\OpenApi\Model\Parameter
public withExamples(ArrayObject $examples): ApiPlatform\OpenApi\Model\Parameterpublic withExamples(ArrayObject $examples): ApiPlatform\OpenApi\Model\Parameter| examples | ArrayObject |
ApiPlatform\OpenApi\Model\Parameter
public withContent(ArrayObject $content): ApiPlatform\OpenApi\Model\Parameterpublic withContent(ArrayObject $content): ApiPlatform\OpenApi\Model\Parameter| content | ArrayObject |
ApiPlatform\OpenApi\Model\Parameter
public withExtensionProperty(string $key, $value)public withExtensionProperty(string $key, $value)| key | string | |
| value |
public getExtensionProperties(): arraypublic getExtensionProperties(): arrayarray
