ResourceRegistrar
class ResourceRegistrar (View source)
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 | $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
Route a resource to a controller.
Route a singleton resource to a controller.
Build a set of prefixed resource routes.
Build a set of prefixed singleton routes.
Extract the resource and prefix from a resource name.
Get the applicable resource methods.
Add the index method for a resourceful route.
Add the create method for a resourceful route.
Add the store method for a resourceful route.
Add the show method for a resourceful route.
Add the edit method for a resourceful route.
Add the update method for a resourceful route.
Add the destroy method for a resourceful route.
Add the create method for a singleton route.
Add the store method for a singleton route.
Add the show method for a singleton route.
Add the edit method for a singleton route.
Add the update method for a singleton route.
Add the destroy method for a singleton route.
Get the name for a given resource with shallowness applied when applicable.
Set the route's binding fields if the resource is scoped.
Get the base resource URI for a given resource.
Get the URI for a nested resource segment array.
Format a resource parameter for usage.
Get the action array for a resource route.
Get the name for a given resource.
Set or unset the unmapped global parameters to singular.
Get the global parameter map.
Set the global parameter mapping.
Get or set the action verbs used in the resource URIs.
Details
void
__construct(Router $router)
Create a new resource registrar instance.
RouteCollection
register(string $name, string $controller, array $options = [])
Route a resource to a controller.
RouteCollection
singleton(string $name, string $controller, array $options = [])
Route a singleton resource to a controller.
protected Router
prefixedResource(string $name, string $controller, array $options)
Build a set of prefixed resource routes.
protected Router
prefixedSingleton(string $name, string $controller, array $options)
Build a set of prefixed singleton routes.
protected array
getResourcePrefix(string $name)
Extract the resource and prefix from a resource name.
protected array
getResourceMethods(array $defaults, array $options)
Get the applicable resource methods.
protected Route
addResourceIndex(string $name, string $base, string $controller, array $options)
Add the index method for a resourceful route.
protected Route
addResourceCreate(string $name, string $base, string $controller, array $options)
Add the create method for a resourceful route.
protected Route
addResourceStore(string $name, string $base, string $controller, array $options)
Add the store method for a resourceful route.
protected Route
addResourceShow(string $name, string $base, string $controller, array $options)
Add the show method for a resourceful route.
protected Route
addResourceEdit(string $name, string $base, string $controller, array $options)
Add the edit method for a resourceful route.
protected Route
addResourceUpdate(string $name, string $base, string $controller, array $options)
Add the update method for a resourceful route.
protected Route
addResourceDestroy(string $name, string $base, string $controller, array $options)
Add the destroy method for a resourceful route.
protected Route
addSingletonCreate(string $name, string $controller, array $options)
Add the create method for a singleton route.
protected Route
addSingletonStore(string $name, string $controller, array $options)
Add the store method for a singleton route.
protected Route
addSingletonShow(string $name, string $controller, array $options)
Add the show method for a singleton route.
protected Route
addSingletonEdit(string $name, string $controller, array $options)
Add the edit method for a singleton route.
protected Route
addSingletonUpdate(string $name, string $controller, array $options)
Add the update method for a singleton route.
protected Route
addSingletonDestroy(string $name, string $controller, array $options)
Add the destroy method for a singleton route.
protected string
getShallowName(string $name, array $options)
Get the name for a given resource with shallowness applied when applicable.
protected 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.
protected string
getNestedResourceUri(array $segments)
Get the URI for a nested resource segment array.
string
getResourceWildcard(string $value)
Format a resource parameter for usage.
protected array
getResourceAction(string $resource, string $controller, string $method, array $options)
Get the action array for a resource route.
protected 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
verbs(array $verbs = [])
Get or set the action verbs used in the resource URIs.