1. class
  2. Hypervel
  3. \
  4. Routing
  5. \
  6. ResourceRegistrar

ResourceRegistrar

class ResourceRegistrar

Constants

protected DEFAULT_VERBS

The default verbs used in resource URIs.

Properties

protected Router $router

The router instance.
protected string[] $resourceDefaults

The default actions for a resourceful controller.
protected string[] $singletonResourceDefaults

The default actions for a singleton resource controller.
protected array|string|null $parameters

The parameters set for this resource instance.
static protected array $parameterMap

The global parameter mapping.
static protected bool $singularParameters

Singular global parameters.
static protected array $verbs

The verbs used in the resource URIs.

Methods

__construct(Router $router)

Create a new resource registrar instance.

RouteCollection|null
register(string $name, string $controller, array $options = [])

Route a resource to a controller.

RouteCollection|null
singleton(string $name, string $controller, array $options = [])

Route a singleton resource to a controller.

Router
prefixedResource(string $name, string $controller, array $options)

Build a set of prefixed resource routes.

Router
prefixedSingleton(string $name, string $controller, array $options)

Build a set of prefixed singleton routes.

array
getResourcePrefix(string $name)

Extract the resource and prefix from a resource name.

array
getResourceMethods(array $defaults, array $options)

Get the applicable resource methods.

Route
addResourceIndex(string $name, string $base, string $controller, array $options)

Add the index method for a resourceful route.

Route
addResourceCreate(string $name, string $base, string $controller, array $options)

Add the create method for a resourceful route.

Route
addResourceStore(string $name, string $base, string $controller, array $options)

Add the store method for a resourceful route.

Route
addResourceShow(string $name, string $base, string $controller, array $options)

Add the show method for a resourceful route.

Route
addResourceEdit(string $name, string $base, string $controller, array $options)

Add the edit method for a resourceful route.

Route
addResourceUpdate(string $name, string $base, string $controller, array $options)

Add the update method for a resourceful route.

Route
addResourceDestroy(string $name, string $base, string $controller, array $options)

Add the destroy method for a resourceful route.

Route
addSingletonCreate(string $name, string $controller, array $options)

Add the create method for a singleton route.

Route
addSingletonStore(string $name, string $controller, array $options)

Add the store method for a singleton route.

Route
addSingletonShow(string $name, string $controller, array $options)

Add the show method for a singleton route.

Route
addSingletonEdit(string $name, string $controller, array $options)

Add the edit method for a singleton route.

Route
addSingletonUpdate(string $name, string $controller, array $options)

Add the update method for a singleton route.

Route
addSingletonDestroy(string $name, string $controller, array $options)

Add the destroy method for a singleton route.

string
getShallowName(string $name, array $options)

Get the name for a given resource with shallowness applied when applicable.

void
setResourceBindingFields(Route $route, array $bindingFields)

Set the route's binding fields if the resource is scoped.

string
getResourceUri(string $resource)

Get the base resource URI for a given resource.

string
getNestedResourceUri(array $segments)

Get the URI for a nested resource segment array.

string
getResourceWildcard(string $value)

Format a resource parameter for usage.

array
getResourceAction(string $resource, string $controller, string $method, array $options)

Get the action array for a resource route.

string
getResourceRouteName(string $resource, string $method, array $options)

Get the name for a given resource.

static void
singularParameters(bool $singular = true)

Set or unset the unmapped global parameters to singular.

static array
getParameters()

Get the global parameter map.

static void
setParameters(array $parameters = [])

Set the global parameter mapping.

static array|null
verbs(array $verbs = [])

Get or set the action verbs used in the resource URIs.

static void
flushState()

Flush all static state.

Details

at line 62
__construct(Router $router)

Create a new resource registrar instance.

Parameters

Router $router

at line 70
RouteCollection|null register(string $name, string $controller, array $options = [])

Route a resource to a controller.

Parameters

string $name
string $controller
array $options

Return Value

RouteCollection|null

at line 135
RouteCollection|null singleton(string $name, string $controller, array $options = [])

Route a singleton resource to a controller.

Parameters

string $name
string $controller
array $options

Return Value

RouteCollection|null

at line 195
protected Router prefixedResource(string $name, string $controller, array $options)

Build a set of prefixed resource routes.

Parameters

string $name
string $controller
array $options

Return Value

Router

at line 212
protected Router prefixedSingleton(string $name, string $controller, array $options)

Build a set of prefixed singleton routes.

Parameters

string $name
string $controller
array $options

Return Value

Router

at line 229
protected array getResourcePrefix(string $name)

Extract the resource and prefix from a resource name.

Parameters

string $name

Return Value

array

at line 244
protected array getResourceMethods(array $defaults, array $options)

Get the applicable resource methods.

Parameters

array $defaults
array $options

Return Value

array

at line 262
protected Route addResourceIndex(string $name, string $base, string $controller, array $options)

Add the index method for a resourceful route.

Parameters

string $name
string $base
string $controller
array $options

Return Value

Route

at line 276
protected Route addResourceCreate(string $name, string $base, string $controller, array $options)

Add the create method for a resourceful route.

Parameters

string $name
string $base
string $controller
array $options

Return Value

Route

at line 290
protected Route addResourceStore(string $name, string $base, string $controller, array $options)

Add the store method for a resourceful route.

Parameters

string $name
string $base
string $controller
array $options

Return Value

Route

at line 304
protected Route addResourceShow(string $name, string $base, string $controller, array $options)

Add the show method for a resourceful route.

Parameters

string $name
string $base
string $controller
array $options

Return Value

Route

at line 318
protected Route addResourceEdit(string $name, string $base, string $controller, array $options)

Add the edit method for a resourceful route.

Parameters

string $name
string $base
string $controller
array $options

Return Value

Route

at line 332
protected Route addResourceUpdate(string $name, string $base, string $controller, array $options)

Add the update method for a resourceful route.

Parameters

string $name
string $base
string $controller
array $options

Return Value

Route

at line 346
protected Route addResourceDestroy(string $name, string $base, string $controller, array $options)

Add the destroy method for a resourceful route.

Parameters

string $name
string $base
string $controller
array $options

Return Value

Route

at line 360
protected Route addSingletonCreate(string $name, string $controller, array $options)

Add the create method for a singleton route.

Parameters

string $name
string $controller
array $options

Return Value

Route

at line 374
protected Route addSingletonStore(string $name, string $controller, array $options)

Add the store method for a singleton route.

Parameters

string $name
string $controller
array $options

Return Value

Route

at line 388
protected Route addSingletonShow(string $name, string $controller, array $options)

Add the show method for a singleton route.

Parameters

string $name
string $controller
array $options

Return Value

Route

at line 402
protected Route addSingletonEdit(string $name, string $controller, array $options)

Add the edit method for a singleton route.

Parameters

string $name
string $controller
array $options

Return Value

Route

at line 416
protected Route addSingletonUpdate(string $name, string $controller, array $options)

Add the update method for a singleton route.

Parameters

string $name
string $controller
array $options

Return Value

Route

at line 430
protected Route addSingletonDestroy(string $name, string $controller, array $options)

Add the destroy method for a singleton route.

Parameters

string $name
string $controller
array $options

Return Value

Route

at line 444
protected string getShallowName(string $name, array $options)

Get the name for a given resource with shallowness applied when applicable.

Parameters

string $name
array $options

Return Value

string

at line 454
protected void setResourceBindingFields(Route $route, array $bindingFields)

Set the route's binding fields if the resource is scoped.

Parameters

Route $route
array $bindingFields

Return Value

void

at line 469
string getResourceUri(string $resource)

Get the base resource URI for a given resource.

Parameters

string $resource

Return Value

string

at line 488
protected string getNestedResourceUri(array $segments)

Get the URI for a nested resource segment array.

Parameters

array $segments

Return Value

string

at line 501
string getResourceWildcard(string $value)

Format a resource parameter for usage.

Parameters

string $value

Return Value

string

at line 517
protected array getResourceAction(string $resource, string $controller, string $method, array $options)

Get the action array for a resource route.

Parameters

string $resource
string $controller
string $method
array $options

Return Value

array

at line 554
protected string getResourceRouteName(string $resource, string $method, array $options)

Get the name for a given resource.

Parameters

string $resource
string $method
array $options

Return Value

string

at line 583
static void singularParameters(bool $singular = true)

Set or unset the unmapped global parameters to singular.

The flag persists in a static property for the worker lifetime and applies to every subsequent resource-route registration.

Parameters

bool $singular

Return Value

void

at line 592
static array getParameters()

Get the global parameter map.

Return Value

array

at line 603
static void setParameters(array $parameters = [])

Set the global parameter mapping.

The map persists in a static property for the worker lifetime and applies to every subsequent resource-route registration.

Parameters

array $parameters

Return Value

void

at line 615
static array|null verbs(array $verbs = [])

Get or set the action verbs used in the resource URIs.

Given verbs persist in a static property for the worker lifetime and apply to every subsequent resource-route URI.

Parameters

array $verbs

Return Value

array|null

at line 630
static void flushState()

Flush all static state.

Return Value

void