1. class
  2. Lemonade
  3. \
  4. Framework
  5. \
  6. Api
  7. \
  8. Endpoint
  9. \
  10. ApiEndpointRegistry

ApiEndpointRegistry

final class ApiEndpointRegistry (View source)

Methods

ApiEndpoint
add(string $method, string $path, string $handler, string $name, string $summary, string $description, ApiAccess $access = ApiAccess::Protected, ApiEndpointMetadata|null $metadata = null)
ApiEndpoint
ApiEndpoint
get(string $path, string $handler, string $name, string $summary, string $description, ApiAccess $access = ApiAccess::Protected, ApiEndpointMetadata|null $metadata = null)
ApiEndpoint
ApiEndpoint
post(string $path, string $handler, string $name, string $summary, string $description, ApiAccess $access = ApiAccess::Protected, ApiEndpointMetadata|null $metadata = null)
ApiEndpoint
ApiEndpoint
put(string $path, string $handler, string $name, string $summary, string $description, ApiAccess $access = ApiAccess::Protected, ApiEndpointMetadata|null $metadata = null)
ApiEndpoint
ApiEndpoint
patch(string $path, string $handler, string $name, string $summary, string $description, ApiAccess $access = ApiAccess::Protected, ApiEndpointMetadata|null $metadata = null)
ApiEndpoint
ApiEndpoint
delete(string $path, string $handler, string $name, string $summary, string $description, ApiAccess $access = ApiAccess::Protected, ApiEndpointMetadata|null $metadata = null)
ApiEndpoint
ApiEndpoint|null
findByName(string $name)
ApiEndpoint|null
ApiEndpoint|null
findByRequest(string $method, string $path)
ApiEndpoint|null
array
all()
array

Details

add

ApiEndpoint add(string $method, string $path, string $handler, string $name, string $summary, string $description, ApiAccess $access = ApiAccess::Protected, ApiEndpointMetadata|null $metadata = null)
at line 26

No description

Parameters

string $method
string $path
string $handler
string $name
string $summary
string $description
ApiAccess $access
ApiEndpointMetadata|null $metadata

Return Value

ApiEndpoint

get

ApiEndpoint get(string $path, string $handler, string $name, string $summary, string $description, ApiAccess $access = ApiAccess::Protected, ApiEndpointMetadata|null $metadata = null)
at line 61

No description

Parameters

string $path
string $handler
string $name
string $summary
string $description
ApiAccess $access
ApiEndpointMetadata|null $metadata

Return Value

ApiEndpoint

post

ApiEndpoint post(string $path, string $handler, string $name, string $summary, string $description, ApiAccess $access = ApiAccess::Protected, ApiEndpointMetadata|null $metadata = null)
at line 88

No description

Parameters

string $path
string $handler
string $name
string $summary
string $description
ApiAccess $access
ApiEndpointMetadata|null $metadata

Return Value

ApiEndpoint

put

ApiEndpoint put(string $path, string $handler, string $name, string $summary, string $description, ApiAccess $access = ApiAccess::Protected, ApiEndpointMetadata|null $metadata = null)
at line 115

No description

Parameters

string $path
string $handler
string $name
string $summary
string $description
ApiAccess $access
ApiEndpointMetadata|null $metadata

Return Value

ApiEndpoint

patch

ApiEndpoint patch(string $path, string $handler, string $name, string $summary, string $description, ApiAccess $access = ApiAccess::Protected, ApiEndpointMetadata|null $metadata = null)
at line 142

No description

Parameters

string $path
string $handler
string $name
string $summary
string $description
ApiAccess $access
ApiEndpointMetadata|null $metadata

Return Value

ApiEndpoint

delete

ApiEndpoint delete(string $path, string $handler, string $name, string $summary, string $description, ApiAccess $access = ApiAccess::Protected, ApiEndpointMetadata|null $metadata = null)
at line 169

No description

Parameters

string $path
string $handler
string $name
string $summary
string $description
ApiAccess $access
ApiEndpointMetadata|null $metadata

Return Value

ApiEndpoint

findByName

ApiEndpoint|null findByName(string $name)
at line 190

No description

Parameters

string $name

Return Value

ApiEndpoint|null

findByRequest

ApiEndpoint|null findByRequest(string $method, string $path)
at line 195

No description

Parameters

string $method
string $path

Return Value

ApiEndpoint|null

all

array all()
at line 207

No description

Return Value

array