class RouteServiceProvider extends ServiceProvider (View source)

Traits

Properties

protected Application $app The application instance. 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
protected string|null $namespace The controller namespace for the application.

Methods

void
__construct(Application $app)

Create a new service provider instance.

void
register()

Register any application services.

void
mergeConfigFrom(string $path, string $key)

Merge the given configuration with the existing configuration.

void
loadRoutesFrom(string $path)

Load the given routes file if routes are not already cached.

void
loadViewsFrom(string|array $path, string $namespace)

Register a view file namespace.

void
loadTranslationsFrom(string $path, string $namespace)

Register a translation file namespace.

void
loadJsonTranslationsFrom(string $path)

Register a JSON translation file path.

void
loadMigrationsFrom(array|string $paths)

Register a database migration path.

void
publishes(array $paths, mixed $groups = null)

Register paths to be published by the publish command.

void
ensurePublishArrayInitialized(string $class)

Ensure the publish array for the service provider is initialized.

void
addPublishGroup(string $group, array $paths)

Add a publish group / tag to the service provider.

static array
pathsToPublish(string $provider = null, string $group = null)

Get the paths to publish.

static array
pathsForProviderOrGroup(string|null $provider, string|null $group)

Get the paths for the provider or group (or both).

static 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
publishableGroups()

Get the groups available for publishing.

void
commands(array|mixed $commands)

Register the package's custom Artisan commands.

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.

mixed
forwardCallTo(mixed $object, string $method, array $parameters)

Forward a method call to the given object.

static void
throwBadMethodCallException(string $method)

Throw a bad method call exception for the given method.

void
boot()

Bootstrap any application services.

void
setRootControllerNamespace()

Set the root controller namespace for the application.

bool
routesAreCached()

Determine if the application routes are cached.

void
loadCachedRoutes()

Load the cached routes for the application.

void
loadRoutes()

Load the application routes.

mixed
__call(string $method, array $parameters)

Pass dynamic methods onto the router instance.

Details

void __construct(Application $app)

Create a new service provider instance.

Parameters

Application $app

Return Value

void

void register()

Register any application services.

Return Value

void

protected void mergeConfigFrom(string $path, string $key)

Merge the given configuration with the existing configuration.

Parameters

string $path
string $key

Return Value

void

protected void loadRoutesFrom(string $path)

Load the given routes file if routes are not already cached.

Parameters

string $path

Return Value

void

protected void loadViewsFrom(string|array $path, string $namespace)

Register a view file namespace.

Parameters

string|array $path
string $namespace

Return Value

void

protected void loadTranslationsFrom(string $path, string $namespace)

Register a translation file namespace.

Parameters

string $path
string $namespace

Return Value

void

protected void loadJsonTranslationsFrom(string $path)

Register a JSON translation file path.

Parameters

string $path

Return Value

void

protected void loadMigrationsFrom(array|string $paths)

Register a database migration path.

Parameters

array|string $paths

Return Value

void

protected void publishes(array $paths, mixed $groups = null)

Register paths to be published by the publish command.

Parameters

array $paths
mixed $groups

Return Value

void

protected void ensurePublishArrayInitialized(string $class)

Ensure the publish array for the service provider is initialized.

Parameters

string $class

Return Value

void

protected void addPublishGroup(string $group, array $paths)

Add a publish group / tag to the service provider.

Parameters

string $group
array $paths

Return Value

void

static array pathsToPublish(string $provider = null, string $group = null)

Get the paths to publish.

Parameters

string $provider
string $group

Return Value

array

static protected array pathsForProviderOrGroup(string|null $provider, string|null $group)

Get the paths for the provider or group (or both).

Parameters

string|null $provider
string|null $group

Return Value

array

static protected array pathsForProviderAndGroup(string $provider, string $group)

Get the paths for the provider and group.

Parameters

string $provider
string $group

Return Value

array

static array publishableProviders()

Get the service providers available for publishing.

Return Value

array

static array publishableGroups()

Get the groups available for publishing.

Return Value

array

void commands(array|mixed $commands)

Register the package's custom Artisan commands.

Parameters

array|mixed $commands

Return Value

void

array provides()

Get the services provided by the provider.

Return Value

array

array when()

Get the events that trigger this service provider to register.

Return Value

array

bool isDeferred()

Determine if the provider is deferred.

Return Value

bool

protected mixed forwardCallTo(mixed $object, string $method, array $parameters)

Forward a method call to the given object.

Parameters

mixed $object
string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

static protected void throwBadMethodCallException(string $method)

Throw a bad method call exception for the given method.

Parameters

string $method

Return Value

void

Exceptions

BadMethodCallException

void boot()

Bootstrap any application services.

Return Value

void

protected void setRootControllerNamespace()

Set the root controller namespace for the application.

Return Value

void

protected bool routesAreCached()

Determine if the application routes are cached.

Return Value

bool

protected void loadCachedRoutes()

Load the cached routes for the application.

Return Value

void

protected void loadRoutes()

Load the application routes.

Return Value

void

mixed __call(string $method, array $parameters)

Pass dynamic methods onto the router instance.

Parameters

string $method
array $parameters

Return Value

mixed