RouteServiceProvider
class RouteServiceProvider extends ServiceProvider mixin Router (View source)
Traits
Properties
| protected Application | $app | The application instance. |
from ServiceProvider |
| protected array | $bootingCallbacks | All of the registered booting callbacks. |
from ServiceProvider |
| protected array | $bootedCallbacks | All of the registered booted callbacks. |
from ServiceProvider |
| static array | $publishes | The paths that should be published. |
from ServiceProvider |
| static array | $publishGroups | The paths that should be published by group. |
from ServiceProvider |
| static protected array | $publishableMigrationPaths | The migration paths available for publishing. |
from ServiceProvider |
| static array<string,string> | $optimizeCommands | Commands that should be run during the "optimize" command. |
from ServiceProvider |
| static array<string,string> | $optimizeClearCommands | Commands that should be run during the "optimize:clear" command. |
from ServiceProvider |
| array<string,string> | $bindings | All of the container bindings that should be registered. |
from ServiceProvider |
| array<array-key,string> | $singletons | All of the singletons that should be registered. |
from ServiceProvider |
| protected string|null | $namespace | The controller namespace for the application. |
|
| protected Closure|null | $loadRoutesUsing | The callback that should be used to load the application's routes. |
|
| static protected Closure|null | $alwaysLoadRoutesUsing | The global callback that should be used to load the application's routes. |
|
| static protected Closure|null | $alwaysLoadCachedRoutesUsing | The callback that should be used to load the application's cached routes. |
Methods
Register any application services.
Register a booting callback to be run before the "boot" method is called.
Merge the given configuration with the existing configuration.
Replace the given configuration with the existing configuration recursively.
Load the given routes file if routes are not already cached.
Register a view file namespace.
Register the given view components with a custom prefix.
Register a translation file namespace.
Register a JSON translation file path.
Register database migration paths.
Setup an after resolving listener, or fire immediately if already resolved.
Register migration paths to be published by the publish command.
Register paths to be published by the publish command.
Ensure the publish array for the service provider is initialized.
Add a publish group / tag to the service provider.
Get the paths to publish.
Get the paths for the provider or group (or both).
Get the paths for the provider and group.
Get the service providers available for publishing.
Get the migration paths available for publishing.
Register the package's custom Artisan commands.
Register commands that should run on "optimize" or "optimize:clear".
Get the default providers for a Laravel application.
Add the given provider to the application's provider bootstrap file.
Forward a method call to the given object.
Forward a method call to the given object, returning $this if the forwarded call returned itself.
Throw a bad method call exception for the given method.
Bootstrap any application services.
Register the callback that will be used to load the application's routes.
Register the callback that will be used to load the application's cached routes.
Set the root controller namespace for the application.
Determine if the application routes are cached.
Load the cached routes for the application.
Load the application routes.
Pass dynamic methods onto the router instance.
Details
void
__construct(Application $app)
Create a new service provider instance.
void
register()
Register any application services.
void
booting(Closure $callback)
Register a booting callback to be run before the "boot" method is called.
void
booted(Closure $callback)
Register a booted callback to be run after the "boot" method is called.
void
callBootingCallbacks()
Call the registered booting callbacks.
void
callBootedCallbacks()
Call the registered booted callbacks.
protected void
mergeConfigFrom(string $path, string $key)
Merge the given configuration with the existing configuration.
protected void
replaceConfigRecursivelyFrom(string $path, string $key)
Replace the given configuration with the existing configuration recursively.
protected void
loadRoutesFrom(string $path)
Load the given routes file if routes are not already cached.
protected void
loadViewsFrom(string|array $path, string $namespace)
Register a view file namespace.
protected void
loadViewComponentsAs(string $prefix, array $components)
Register the given view components with a custom prefix.
protected void
loadTranslationsFrom(string $path, string $namespace)
Register a translation file namespace.
protected void
loadJsonTranslationsFrom(string $path)
Register a JSON translation file path.
protected void
loadMigrationsFrom(array|string $paths)
Register database migration paths.
protected void
loadFactoriesFrom(array|string $paths)
deprecated
deprecated
Register Eloquent model factory paths.
protected void
callAfterResolving(string $name, callable $callback)
Setup an after resolving listener, or fire immediately if already resolved.
protected void
publishesMigrations(array $paths, mixed $groups = null)
Register migration paths to be published by the publish command.
protected void
publishes(array $paths, mixed $groups = null)
Register paths to be published by the publish command.
protected void
ensurePublishArrayInitialized(string $class)
Ensure the publish array for the service provider is initialized.
protected void
addPublishGroup(string $group, array $paths)
Add a publish group / tag to the service provider.
static array
pathsToPublish(string|null $provider = null, string|null $group = null)
Get the paths to publish.
static protected array
pathsForProviderOrGroup(string|null $provider, string|null $group)
Get the paths for the provider or group (or both).
static protected array
pathsForProviderAndGroup(string $provider, string $group)
Get the paths for the provider and group.
static array
publishableProviders()
Get the service providers available for publishing.
static array
publishableMigrationPaths()
Get the migration paths available for publishing.
static array
publishableGroups()
Get the groups available for publishing.
void
commands(array|mixed $commands)
Register the package's custom Artisan commands.
protected void
optimizes(string|null $optimize = null, string|null $clear = null, string|null $key = null)
Register commands that should run on "optimize" or "optimize:clear".
array
provides()
Get the services provided by the provider.
array
when()
Get the events that trigger this service provider to register.
bool
isDeferred()
Determine if the provider is deferred.
static DefaultProviders
defaultProviders()
Get the default providers for a Laravel application.
static bool
addProviderToBootstrapFile(string $provider, string|null $path = null)
Add the given provider to the application's provider bootstrap file.
protected mixed
forwardCallTo(mixed $object, string $method, array $parameters)
Forward a method call to the given object.
protected mixed
forwardDecoratedCallTo(mixed $object, string $method, array $parameters)
Forward a method call to the given object, returning $this if the forwarded call returned itself.
static protected void
throwBadMethodCallException(string $method)
Throw a bad method call exception for the given method.
void
boot()
Bootstrap any application services.
protected $this
routes(Closure $routesCallback)
Register the callback that will be used to load the application's routes.
static void
loadRoutesUsing(Closure|null $routesCallback)
Register the callback that will be used to load the application's routes.
static void
loadCachedRoutesUsing(Closure|null $routesCallback)
Register the callback that will be used to load the application's cached routes.
protected void
setRootControllerNamespace()
Set the root controller namespace for the application.
protected bool
routesAreCached()
Determine if the application routes are cached.
protected void
loadCachedRoutes()
Load the cached routes for the application.
protected void
loadRoutes()
Load the application routes.
mixed
__call(string $method, array $parameters)
Pass dynamic methods onto the router instance.