1. Documentation
  2. API
  3. Library
  4. Router
  5. CoreRouter

October\Rain\Router\CoreRouter

Source: ~/vendor/october/rain/src/Router/CoreRouter.php

Extends:

  • Illuminate\Routing\Router

Implements:

  • Illuminate\Contracts\Routing\BindingRegistrar
  • Illuminate\Contracts\Routing\Registrar

Public properties

There are no public properties in the class.

Show inherited public properties

Inherited public properties

  • public array $middlewarePriority - defined in Illuminate\Routing\Router. The priority-sorted list of middleware.
  • public static array $verbs - defined in Illuminate\Routing\Router. All of the verbs supported by the router.

Protected properties

There are no protected properties in the class.

Show inherited protected properties

Inherited protected properties

  • protected Illuminate\Contracts\Events\Dispatcher $events - defined in Illuminate\Routing\Router. The event dispatcher instance.
  • protected Illuminate\Container\Container $container - defined in Illuminate\Routing\Router. The IoC container instance.
  • protected Illuminate\Routing\RouteCollection $routes - defined in Illuminate\Routing\Router. The route collection instance.
  • protected Illuminate\Routing\Route $current - defined in Illuminate\Routing\Router. The currently dispatched route instance.
  • protected Illuminate\Http\Request $currentRequest - defined in Illuminate\Routing\Router. The request currently being dispatched.
  • protected array $middleware - defined in Illuminate\Routing\Router. All of the short-hand keys for middlewares.
  • protected array $middlewareGroups - defined in Illuminate\Routing\Router. All of the middleware groups.
  • protected array $binders - defined in Illuminate\Routing\Router. The registered route value binders.
  • protected array $patterns - defined in Illuminate\Routing\Router. The globally available parameter patterns.
  • protected array $groupStack - defined in Illuminate\Routing\Router. The route group attribute stack.
  • protected static array $macros - defined in Illuminate\Routing\Router. The registered string macros.

Public methods

public void after(string|callable $callback)

Register a new "after" filter with the router.

Parameters
  • string|callable $callback

public void before(string|callable $callback)

Register a new "before" filter with the router.

Parameters
  • string|callable $callback

public Illuminate\Http\Response|\Illuminate\Http\JsonResponse dispatch(Illuminate\Http\Request $request)

Dispatch the request to the application.

Parameters
  • Illuminate\Http\Request $request

Show inherited public methods

Inherited public methods

  • public mixed __call(string $method, array $parameters) - defined in Illuminate\Routing\Router. Dynamically handle calls into the router instance.
  • public static mixed __callStatic(string $method, array $parameters) - defined in Illuminate\Routing\Router. Dynamically handle calls to the class.
  • public void __construct(Illuminate\Contracts\Events\Dispatcher $events, Illuminate\Container\Container $container=NULL) - defined in Illuminate\Routing\Router. Create a new Router instance.
  • public $this aliasMiddleware(string $name, string $class) - defined in Illuminate\Routing\Router. Register a short-hand name for a middleware.
  • public Illuminate\Routing\Route any(string $uri, Closure|array|string|null $action=NULL) - defined in Illuminate\Routing\Router. Register a new route responding to all verbs.
  • public Illuminate\Routing\PendingResourceRegistration apiResource(string $name, string $controller, array $options=array()) - defined in Illuminate\Routing\Router. Route an API resource to a controller.
  • public void apiResources(array $resources) - defined in Illuminate\Routing\Router. Register an array of API resource controllers.
  • public void auth() - defined in Illuminate\Routing\Router. Register the typical authentication routes for an application.
  • public void bind(string $key, string|callable $binder) - defined in Illuminate\Routing\Router. Add a new route parameter binder.
  • public Illuminate\Routing\Route current() - defined in Illuminate\Routing\Router. Get the currently dispatched route instance.
  • public string|null currentRouteAction() - defined in Illuminate\Routing\Router. Get the current route action.
  • public string|null currentRouteName() - defined in Illuminate\Routing\Router. Get the current route name.
  • public bool currentRouteNamed(dynamic $patterns=NULL) - defined in Illuminate\Routing\Router. Determine if the current route matches a pattern.
  • public bool currentRouteUses(string $action) - defined in Illuminate\Routing\Router. Determine if the current route action matches a given action.
  • public Illuminate\Routing\Route delete(string $uri, Closure|array|string|null $action=NULL) - defined in Illuminate\Routing\Router. Register a new DELETE route with the router.
  • public mixed dispatchToRoute(Illuminate\Http\Request $request) - defined in Illuminate\Routing\Router. Dispatch the request to a route and return the response.
  • public Illuminate\Routing\Route fallback(Closure|array|string|null $action) - defined in Illuminate\Routing\Router. Register a new Fallback route with the router.
  • public array gatherRouteMiddleware(Illuminate\Routing\Route $route) - defined in Illuminate\Routing\Router. Gather the middleware for the given route with resolved class names.
  • public Illuminate\Routing\Route get(string $uri, Closure|array|string|null $action=NULL) - defined in Illuminate\Routing\Router. Register a new GET route with the router.
  • public Closure|null getBindingCallback(string $key) - defined in Illuminate\Routing\Router. Get the binding callback for a given binding.
  • public Illuminate\Http\Request getCurrentRequest() - defined in Illuminate\Routing\Router. Get the request currently being dispatched.
  • public Illuminate\Routing\Route getCurrentRoute() - defined in Illuminate\Routing\Router. Get the currently dispatched route instance.
  • public array getGroupStack() - defined in Illuminate\Routing\Router. Get the current group stack for the router.
  • public string getLastGroupPrefix() - defined in Illuminate\Routing\Router. Get the prefix from the last group on the stack.
  • public array getMiddleware() - defined in Illuminate\Routing\Router. Get all of the defined middleware short-hand names.
  • public array getMiddlewareGroups() - defined in Illuminate\Routing\Router. Get all of the defined middleware groups.
  • public array getPatterns() - defined in Illuminate\Routing\Router. Get the global "where" patterns.
  • public Illuminate\Routing\RouteCollection getRoutes() - defined in Illuminate\Routing\Router. Get the underlying route collection.
  • public void group(array $attributes, Closure|string $routes) - defined in Illuminate\Routing\Router. Create a route group with shared attributes.
  • public bool has(string $name) - defined in Illuminate\Routing\Router. Check if a route with the given name exists.
  • public bool hasGroupStack() - defined in Illuminate\Routing\Router. Determine if the router currently has a group stack.
  • public static bool hasMacro(string $name) - defined in Illuminate\Routing\Router. Checks if macro is registered.
  • public bool hasMiddlewareGroup(string $name) - defined in Illuminate\Routing\Router. Check if a middlewareGroup with the given name exists.
  • public mixed input(string $key, string $default=NULL) - defined in Illuminate\Routing\Router. Get a route parameter for the current route.
  • public bool is(dynamic $patterns=NULL) - defined in Illuminate\Routing\Router. Alias for the "currentRouteNamed" method.
  • public static void macro(string $name, object|callable $macro) - defined in Illuminate\Routing\Router. Register a custom macro.
  • public mixed macroCall(string $method, array $parameters) - defined in Illuminate\Routing\Router. Dynamically handle calls to the class.
  • public Illuminate\Routing\Route match(array|string $methods, string $uri, Closure|array|string|null $action=NULL) - defined in Illuminate\Routing\Router. Register a new route with the given verbs.
  • public void matched(string|callable $callback) - defined in Illuminate\Routing\Router. Register a route matched event listener.
  • public array mergeWithLastGroup(array $new) - defined in Illuminate\Routing\Router. Merge the given array with the last group stack.
  • public $this middlewareGroup(string $name, array $middleware) - defined in Illuminate\Routing\Router. Register a group of middleware.
  • public static void mixin(object $mixin) - defined in Illuminate\Routing\Router. Mix another object into the class.
  • public void model(string $key, string $class, Closure|null $callback=NULL) - defined in Illuminate\Routing\Router. Register a model binder for a wildcard.
  • public Illuminate\Routing\Route options(string $uri, Closure|array|string|null $action=NULL) - defined in Illuminate\Routing\Router. Register a new OPTIONS route with the router.
  • public Illuminate\Routing\Route patch(string $uri, Closure|array|string|null $action=NULL) - defined in Illuminate\Routing\Router. Register a new PATCH route with the router.
  • public void pattern(string $key, string $pattern) - defined in Illuminate\Routing\Router. Set a global where pattern on all routes.
  • public void patterns(array $patterns) - defined in Illuminate\Routing\Router. Set a group of global where patterns on all routes.
  • public Illuminate\Routing\Route post(string $uri, Closure|array|string|null $action=NULL) - defined in Illuminate\Routing\Router. Register a new POST route with the router.
  • public Illuminate\Http\Response|\Illuminate\Http\JsonResponse prepareResponse(Symfony\Component\HttpFoundation\Request $request, mixed $response) - defined in Illuminate\Routing\Router. Create a response instance from the given value.
  • public $this prependMiddlewareToGroup(string $group, string $middleware) - defined in Illuminate\Routing\Router. Add a middleware to the beginning of a middleware group.
  • public $this pushMiddlewareToGroup(string $group, string $middleware) - defined in Illuminate\Routing\Router. Add a middleware to the end of a middleware group.
  • public Illuminate\Routing\Route put(string $uri, Closure|array|string|null $action=NULL) - defined in Illuminate\Routing\Router. Register a new PUT route with the router.
  • public Illuminate\Routing\Route redirect(string $uri, string $destination, int $status=301) - defined in Illuminate\Routing\Router. Create a redirect from one URI to another.
  • public Illuminate\Routing\PendingResourceRegistration resource(string $name, string $controller, array $options=array()) - defined in Illuminate\Routing\Router. Route a resource to a controller.
  • public void resourceParameters(array $parameters=array()) - defined in Illuminate\Routing\Router. Set the global resource parameter mapping.
  • public array|null resourceVerbs(array $verbs=array()) - defined in Illuminate\Routing\Router. Get or set the verbs used in the resource URIs.
  • public void resources(array $resources) - defined in Illuminate\Routing\Router. Register an array of resource controllers.
  • public mixed respondWithRoute(string $name) - defined in Illuminate\Routing\Router. Return the response returned by the given route.
  • public void setRoutes(Illuminate\Routing\RouteCollection $routes) - defined in Illuminate\Routing\Router. Set the route collection instance.
  • public void singularResourceParameters(bool $singular=true) - defined in Illuminate\Routing\Router. Set the unmapped global resource parameters to singular.
  • public Illuminate\Routing\Route substituteBindings(Illuminate\Routing\Route $route) - defined in Illuminate\Routing\Router. Substitute the route bindings onto the route.
  • public void substituteImplicitBindings(Illuminate\Routing\Route $route) - defined in Illuminate\Routing\Router. Substitute the implicit Eloquent model bindings for the route.
  • public static Illuminate\Http\Response|\Illuminate\Http\JsonResponse toResponse(Symfony\Component\HttpFoundation\Request $request, mixed $response) - defined in Illuminate\Routing\Router. Static version of prepareResponse.
  • public bool uses(array $patterns=NULL) - defined in Illuminate\Routing\Router. Alias for the "currentRouteUses" method.
  • public Illuminate\Routing\Route view(string $uri, string $view, array $data=array()) - defined in Illuminate\Routing\Router. Register a new route that returns a view.

Protected methods

Show inherited protected methods

Inherited protected methods

  • protected bool actionReferencesController(array $action) - defined in Illuminate\Routing\Router. Determine if the action is routing to a controller.
  • protected Illuminate\Routing\Route addRoute(array|string $methods, string $uri, Closure|array|string|null $action) - defined in Illuminate\Routing\Router. Add a route to the underlying route collection.
  • protected Illuminate\Routing\Route addWhereClausesToRoute(Illuminate\Routing\Route $route) - defined in Illuminate\Routing\Router. Add the necessary where clauses to the route based on its initial registration.
  • protected array convertToControllerAction(array|string $action) - defined in Illuminate\Routing\Router. Add a controller based route action to the action array.
  • protected Illuminate\Routing\Route createRoute(array|string $methods, string $uri, mixed $action) - defined in Illuminate\Routing\Router. Create a new route instance.
  • protected Illuminate\Routing\Route findRoute(Illuminate\Http\Request $request) - defined in Illuminate\Routing\Router. Find the route matching a given request.
  • protected void loadRoutes(Closure|string $routes) - defined in Illuminate\Routing\Router. Load the provided routes.
  • protected void mergeGroupAttributesIntoRoute(Illuminate\Routing\Route $route) - defined in Illuminate\Routing\Router. Merge the group stack with the controller action.
  • protected Illuminate\Routing\Route newRoute(array|string $methods, string $uri, mixed $action) - defined in Illuminate\Routing\Router. Create a new Route object.
  • protected mixed performBinding(string $key, string $value, Illuminate\Routing\Route $route) - defined in Illuminate\Routing\Router. Call the binding callback for the given key.
  • protected string prefix(string $uri) - defined in Illuminate\Routing\Router. Prefix the given URI with the last prefix.
  • protected string prependGroupNamespace(string $class) - defined in Illuminate\Routing\Router. Prepend the last group namespace onto the use clause.
  • protected mixed runRoute(Route $route, Request $request) - defined in Illuminate\Routing\Router. Return the response for the given route.
  • protected mixed runRouteWithinStack(Illuminate\Routing\Route $route, Illuminate\Http\Request $request) - defined in Illuminate\Routing\Router. Run the given route within a Stack "onion" instance.
  • protected array sortMiddleware(Illuminate\Support\Collection $middlewares) - defined in Illuminate\Routing\Router. Sort the given middleware by priority.
  • protected void updateGroupStack(array $attributes) - defined in Illuminate\Routing\Router. Update the group stack with the given attributes.