Documentation

SwaggerMiddleware
in package

This class exists for the simple reason that swagger-php lacks any solid proper decoration logic So we have to code something so basic it's insane it's not available out of the box

Table of Contents

$dsn  : mixed
$opt  : mixed
$pass  : mixed
$user  : mixed
doDecorations()  : mixed
doDynamicDefinitions()  : mixed
dynamicDefinitions()  : string
Returns JSON object with dynamic definitions applied Sometimes we have properties that are array and which items are long lists and/or dynamically created In the code we set only one enum entry with the name of the function to populate it preceded by a pipe as value We then identify all instances and populate them
fix()  : string
Returns JSON object with proper text decorations in descriptions applied
fixDecorations()  : mixed
fixLineBreaks()  : mixed
dynamic_decades()  : mixed
dynamic_genre()  : mixed
dynamic_songcreators()  : mixed
dynamic_tiers()  : mixed

Properties

Methods

doDecorations()

public static doDecorations(mixed $key, mixed $value) : mixed
Parameters
$key : mixed
$value : mixed
Return values
mixed

doDynamicDefinitions()

public static doDynamicDefinitions(mixed $key, mixed $value) : mixed
Parameters
$key : mixed
$value : mixed
Return values
mixed

dynamicDefinitions()

Returns JSON object with dynamic definitions applied Sometimes we have properties that are array and which items are long lists and/or dynamically created In the code we set only one enum entry with the name of the function to populate it preceded by a pipe as value We then identify all instances and populate them

public static dynamicDefinitions(mixed $object) : string
Parameters
$object : mixed
Return values
string

Returns JSON string

fix()

Returns JSON object with proper text decorations in descriptions applied

public static fix(mixed $object) : string
Parameters
$object : mixed
Return values
string

Returns JSON string

fixDecorations()

public static fixDecorations(mixed $array) : mixed
Parameters
$array : mixed
Return values
mixed

fixLineBreaks()

public static fixLineBreaks(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed

dynamic_decades()

private static dynamic_decades() : mixed
Return values
mixed

dynamic_genre()

private static dynamic_genre() : mixed
Return values
mixed

dynamic_songcreators()

private static dynamic_songcreators() : mixed
Return values
mixed

dynamic_tiers()

private static dynamic_tiers() : mixed
Return values
mixed

Search results