Checking what action would be called by a given url string - laravel

Question

In Laravel (5.6) I want to see what route would be called by a given url string. Say the url was "report/sales" I would like to check what function from what controller would be called, eg could be "ReportController#salesreport". It's sort of the opposite of the action() function but I can't find anything like it.
Would be wonderful if anyone has a solution.

Answer 1

Laravel doesn't provide a direct means of checking for a Route matching a URI, likely because it performs multiple assertions for host, method, etc. during matching. Almost all matching uses a Request object for comparison.
The quickest way to use existing functionality is to manually create a Request object with the details you wish to match against (HTTP method, URI, etc.). Once you've done that, you can grab the Router and look:
$request = \Illuminate\Http\Request::create('/report/sales');
$routes = Route::getRoutes(); // Or, you can get the Router directly, through app(), etc.
try {
$route = $routes->match($request);
$action = $route->getActionName();
} catch (\Symfony\Component\HttpKernel\Exception\NotFoundHttpException $e) {
// No matching route was found.
} catch (\Symfony\Component\Routing\Exception\MethodNotAllowedException $e) {
// The URI matches a route for a different HTTP method
}

Answer 2

You could retrive the Router instance through the Container and retrive all routes, then filter the retrived routes to match only the ones that has url attribute equal to the given url string. Finally, pluck the matching controller action for each route.
$routes = app('router')->getRoutes()->getRoutes();
$target = 'report/sales';
$actions = collect($routes)->filter(function($route) use ($target) {
return $route->uri == $target;
})->pluck('action.controller');
dd($actions);
If you only need to get one route only (eg: no routes with the same URL but different verbs), just replace filter with first to stop at the first matching occurence. As a result you will no longer need pluck, as you will be given a Route instance, not a collection:
$routes = app('router')->getRoutes()->getRoutes();
$target = 'report/sales';
$action = collect($routes)->first(function($route) use ($target) {
return $route->uri == $target;
})->action['controller'];
dd($action);