OpenApiPathAbstract
in package
Abstract class to generate default path elements for OpenApi.
Table of Contents
- $definition : stdClass
- $processorHelper : ProcessorHelper
- $settings : Config
- __construct() : mixed
- export() : stdClass|string
- Export the definition.
- import() : mixed
- Import an existing definition.
- setDefault() : mixed
- Sets the OpenApi path schema fragment to define the resources in the doc (application).
- update() : mixed
- Update the OpenApi definition fragment for a path.
- defaultGetParameters() : array<string|int, mixed>|stdClass
- Return the default GET parameters OpenApi object.
- defaultPathParameters() : array<string|int, mixed>|stdClass
- Return the default PATH parameters OpenApi object.
- defaultPostParameters() : array<string|int, mixed>|stdClass
- Return the default POST parameters OpenApi object.
- findProcessors() : array<string|int, mixed>
- Return an array of all instances of a processor in metadata.
Properties
$definition
protected
stdClass
$definition
Doc definition.
$processorHelper
protected
ProcessorHelper
$processorHelper
$settings
protected
Config
$settings
Settings object.
Methods
__construct()
public
__construct() : mixed
Return values
mixed —export()
Export the definition.
public
export([bool $encoded = true ]) : stdClass|string
Parameters
- $encoded : bool = true
-
JSON encoded.
Tags
Return values
stdClass|string —import()
Import an existing definition.
public
import(stdClass|string $definition) : mixed
Parameters
- $definition : stdClass|string
Tags
Return values
mixed —setDefault()
Sets the OpenApi path schema fragment to define the resources in the doc (application).
public
abstract setDefault(resource $resource) : mixed
Parameters
- $resource : resource
Tags
Return values
mixed —update()
Update the OpenApi definition fragment for a path.
public
update(resource $resource) : mixed
Parameters
- $resource : resource
Tags
Return values
mixed —defaultGetParameters()
Return the default GET parameters OpenApi object.
protected
abstract defaultGetParameters(stdClass $meta) : array<string|int, mixed>|stdClass
Parameters
- $meta : stdClass
Return values
array<string|int, mixed>|stdClass —defaultPathParameters()
Return the default PATH parameters OpenApi object.
protected
abstract defaultPathParameters(stdClass $meta) : array<string|int, mixed>|stdClass
Parameters
- $meta : stdClass
Return values
array<string|int, mixed>|stdClass —defaultPostParameters()
Return the default POST parameters OpenApi object.
protected
abstract defaultPostParameters(stdClass $meta) : array<string|int, mixed>|stdClass
Parameters
- $meta : stdClass
Return values
array<string|int, mixed>|stdClass —findProcessors()
Return an array of all instances of a processor in metadata.
protected
findProcessors(string $machineName, stdClass $meta) : array<string|int, mixed>
Parameters
- $machineName : string
- $meta : stdClass