final class ApiConfigDefinition extends AbstractConfigDefinition (View source)

Properties

protected mixed[] $data from  AbstractConfigDefinition

Methods

static string
string
staticBearer(mixed $token, array $scopes = [])

Details

toArray

No description

Return Value

array

fromArrayData

final static AbstractConfigDefinition fromArrayData(array $data)

No description

Parameters

array $data

Return Value

AbstractConfigDefinition

set

protected AbstractConfigDefinition set(string $path, mixed $value)

No description

Parameters

string $path
mixed $value

Return Value

AbstractConfigDefinition

append

protected AbstractConfigDefinition append(string $path, mixed $value)

No description

Parameters

string $path
mixed $value

Return Value

AbstractConfigDefinition

create

No description

Return Value

ApiConfigDefinition

moduleKey

static string moduleKey()

No description

Return Value

string

enabled

ApiConfigDefinition enabled(bool $enabled = true)

No description

Parameters

bool $enabled

Return Value

ApiConfigDefinition

disabled

No description

Return Value

ApiConfigDefinition

prefix

ApiConfigDefinition prefix(string $prefix)

No description

Parameters

string $prefix

Return Value

ApiConfigDefinition

endpointProvider

ApiConfigDefinition endpointProvider(string $providerClass)

No description

Parameters

string $providerClass

Return Value

ApiConfigDefinition

endpointProviders

ApiConfigDefinition endpointProviders(array $providerClasses)

No description

Parameters

array $providerClasses

Return Value

ApiConfigDefinition

staticBearer

ApiConfigDefinition staticBearer(mixed $token, array $scopes = [])

No description

Parameters

mixed $token
array $scopes

Return Value

ApiConfigDefinition

staticBearerDisabled

ApiConfigDefinition staticBearerDisabled()

No description

Return Value

ApiConfigDefinition

staticBearerScopes

ApiConfigDefinition staticBearerScopes(array $scopes)

No description

Parameters

array $scopes

Return Value

ApiConfigDefinition

frameworkEnabled

ApiConfigDefinition frameworkEnabled(bool $enabled = true)

No description

Parameters

bool $enabled

Return Value

ApiConfigDefinition

frameworkDisabled

ApiConfigDefinition frameworkDisabled()

No description

Return Value

ApiConfigDefinition

healthEnabled

No description

Return Value

ApiConfigDefinition

healthDisabled

ApiConfigDefinition healthDisabled()

No description

Return Value

ApiConfigDefinition

healthRoute

ApiConfigDefinition healthRoute(string $route)

No description

Parameters

string $route

Return Value

ApiConfigDefinition

healthAccess

ApiConfigDefinition healthAccess(ApiAccess|string $access)

No description

Parameters

ApiAccess|string $access

Return Value

ApiConfigDefinition

openApiEnabled

ApiConfigDefinition openApiEnabled()

No description

Return Value

ApiConfigDefinition

openApiDisabled

ApiConfigDefinition openApiDisabled()

No description

Return Value

ApiConfigDefinition

openApiRoute

ApiConfigDefinition openApiRoute(string $route)

No description

Parameters

string $route

Return Value

ApiConfigDefinition

openApiAccess

ApiConfigDefinition openApiAccess(ApiAccess|string $access)

No description

Parameters

ApiAccess|string $access

Return Value

ApiConfigDefinition

openApiScopes

ApiConfigDefinition openApiScopes(array $scopes)

No description

Parameters

array $scopes

Return Value

ApiConfigDefinition

docsEnabled

No description

Return Value

ApiConfigDefinition

docsDisabled

No description

Return Value

ApiConfigDefinition

docsRoute

ApiConfigDefinition docsRoute(string $route)

No description

Parameters

string $route

Return Value

ApiConfigDefinition

docsAccess

ApiConfigDefinition docsAccess(ApiAccess|string $access)

No description

Parameters

ApiAccess|string $access

Return Value

ApiConfigDefinition

docsScopes

ApiConfigDefinition docsScopes(array $scopes)

No description

Parameters

array $scopes

Return Value

ApiConfigDefinition