References Schema
Reference
C
Class

ApiPlatform\OpenApi\Model\Schema

class ApiPlatform\OpenApi\Model\Schema extends ArrayObject implements Countable, Serializable, ArrayAccess, Traversable, IteratorAggregate
{
    public __construct($discriminator, bool $readOnly, bool $writeOnly, null|string $xml, $externalDocs, $example, bool $deprecated)
    public setDefinitions(array $definitions): null
    public getArrayCopy(): array
    public getDefinitions(): ArrayObject
    public getDiscriminator()
    public getReadOnly(): bool
    public getWriteOnly(): bool
    public getXml(): string
    public getExternalDocs()
    public getExample()
    public getDeprecated(): bool
    public withDiscriminator($discriminator): ApiPlatform\OpenApi\Model\Schema
    public withReadOnly(bool $readOnly): ApiPlatform\OpenApi\Model\Schema
    public withWriteOnly(bool $writeOnly): ApiPlatform\OpenApi\Model\Schema
    public withXml(string $xml): ApiPlatform\OpenApi\Model\Schema
    public withExternalDocs($externalDocs): ApiPlatform\OpenApi\Model\Schema
    public withExample($example): ApiPlatform\OpenApi\Model\Schema
    public withDeprecated(bool $deprecated): ApiPlatform\OpenApi\Model\Schema
    public offsetExists($key)
    public offsetGet($key)
    public offsetSet($key, $value)
    public offsetUnset($key)
    public append($value)
    public count()
    public getFlags()
    public setFlags(int $flags)
    public asort(int $flags)
    public ksort(int $flags)
    public uasort(callable $callback)
    public uksort(callable $callback)
    public natsort()
    public natcasesort()
    public unserialize(string $data)
    public serialize()
    public __serialize()
    public __unserialize(array $data)
    public getIterator()
    public exchangeArray(object|array $array)
    public setIteratorClass(string $iteratorClass)
    public getIteratorClass()
    public __debugInfo()
    public withExtensionProperty(string $key, $value)
    public getExtensionProperties(): array
}

Methods

__construct

public __construct($discriminator, bool $readOnly, bool $writeOnly, null|string $xml, $externalDocs, $example, bool $deprecated)

Parameters

discriminator
readOnlybool
writeOnlybool
xmlstring
externalDocs
example
deprecatedbool

setDefinitions

public setDefinitions(array $definitions): null

Parameters

definitionsarray

Returns

null

getArrayCopy

public getArrayCopy(): array

Returns

array

getDefinitions

public getDefinitions(): ArrayObject

Returns

ArrayObject

getDiscriminator

public getDiscriminator()

getReadOnly

public getReadOnly(): bool

Returns

bool

getWriteOnly

public getWriteOnly(): bool

Returns

bool

getXml

public getXml(): string

Returns

string

getExternalDocs

public getExternalDocs()

getExample

public getExample()

getDeprecated

public getDeprecated(): bool

Returns

bool

withDiscriminator

public withDiscriminator($discriminator): ApiPlatform\OpenApi\Model\Schema

Parameters

discriminator

Returns

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

withReadOnly

public withReadOnly(bool $readOnly): ApiPlatform\OpenApi\Model\Schema

Parameters

readOnlybool

Returns

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

withWriteOnly

public withWriteOnly(bool $writeOnly): ApiPlatform\OpenApi\Model\Schema

Parameters

writeOnlybool

Returns

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

withXml

public withXml(string $xml): ApiPlatform\OpenApi\Model\Schema

Parameters

xmlstring

Returns

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

withExternalDocs

public withExternalDocs($externalDocs): ApiPlatform\OpenApi\Model\Schema

Parameters

externalDocs

Returns

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

withExample

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

Parameters

example

Returns

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

withDeprecated

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

Parameters

deprecatedbool

Returns

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