PutRoute extends MethodRoute

Represents a route definition and handles route creation and execution.

Table of Contents

Constants

CLAZZ  = 'clazz'

Array keys for route initialization

CONTROLLER_ID  = 'controllerID'

DEFAULT_OWNER_PATTERN  = '{owner:[0-9]+}'

Default owner pattern for numeric owner IDs

DEFAULT_PREFIX  = 'api'

Default API prefix for route names

DEFAULT_ROUTE_PATTERN  = '{id:[0-9]+}'

Default route pattern for numeric IDs

INTERNAL_METHOD  = \oihana\enums\http\HttpMethod::put

The default internal method name of the controller to invoke with this route.

METHOD  = 'method'

NAME  = 'name'

OWNER_PATTERN  = 'ownerPattern'

PATCH_PATTERN  = 'patchPattern'

PREFIX  = 'prefix'

PROPERTY  = 'property'

ROUTE  = 'route'

ROUTE_PATTERN  = 'routePattern'

ROUTES  = 'routes'

SUFFIX  = 'suffix'

VERBOSE  = 'verbose'

Properties

$container  : Container

The DI container reference.

$controllerID  : string|null

$logger  : LoggerInterface

$method  : string|mixed

The name of the method to call in the controller to invoke with this route.

$name  : string|null

$ownerPattern  : string|null

$prefix  : string

$property  : string

$route  : string|null

$routePattern  : string

$routes  : array<string|int, mixed>|null

$settings  : array<string|int, mixed>

$suffix  : string

$verbose  : bool

$app  : App

Methods

__construct()  : mixed

Creates a new MethodRoute instance.

__invoke()  : void

Called when a script tries to call the instance as a function.

__toString()  : string

Returns a String representation of the object.

cleanParams()  : array<string|int, mixed>

Removes null or empty string values from an array of parameters.

create()  : Route|null

Creates a new Route instance from a definition array or Route object.

dotify()  : string

Converts a route path from 'foo/bar' to 'foo.bar'.

execute()  : void

Executes a callable or an array of callables.

getName()  : string

Returns the fully qualified route name, including prefix and suffix.

getRoute()  : string

Returns the safe main route representation starting with '/'.