RouteServiceProvider

class RouteServiceProvider extends ServiceProvider (View source)

Traits

ForwardsCalls

Properties

protected Application $app The application instance. from ServiceProvider
protected bool $defer Indicates if loading of the provider is deferred. 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.

 from ServiceProvider
void mergeConfigFrom(string $path, string $key)

Merge the given configuration with the existing configuration.

 from ServiceProvider
void loadRoutesFrom(string $path)

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

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

Register a view file namespace.

 from ServiceProvider
void loadTranslationsFrom(string $path, string $namespace)

Register a translation file namespace.

 from ServiceProvider
void loadJsonTranslationsFrom(string $path)

Register a JSON translation file path.

 from ServiceProvider
void loadMigrationsFrom(array|string $paths)

Register a database migration path.

 from ServiceProvider
void publishes(array $paths, string $group = null)

Register paths to be published by the publish command.

 from ServiceProvider
void ensurePublishArrayInitialized(string $class)

Ensure the publish array for the service provider is initialized.

 from ServiceProvider
void addPublishGroup(string $group, array $paths)

Add a publish group / tag to the service provider.

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

Get the paths to publish.

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

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

 from ServiceProvider
static array pathsForProviderAndGroup(string $provider, string $group)

Get the paths for the provider and group.

 from ServiceProvider
static array publishableProviders()

Get the service providers available for publishing.

 from ServiceProvider
static array publishableGroups()

Get the groups available for publishing.

 from ServiceProvider
void commands(array|mixed $commands)

Register the package's custom Artisan commands.

 from ServiceProvider
array provides()

Get the services provided by the provider.

 from ServiceProvider
array when()

Get the events that trigger this service provider to register.

 from ServiceProvider
bool isDeferred()

Determine if the provider is deferred.

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

Forward a method call to the given object.

 from ForwardsCalls
static void throwBadMethodCallException(string $method)

Throw a bad method call exception for the given method.

 from ForwardsCalls
void boot()

Bootstrap any application services.
void setRootControllerNamespace()

Set the root controller namespace for the application.
void loadCachedRoutes()

Load the cached routes for the application.
void loadRoutes()

Load the application routes.
void register()

Register the service provider.
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

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, string $group = null)

Register paths to be published by the publish command.

Parameters

array $paths
string $group

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 void loadCachedRoutes()

Load the cached routes for the application.

Return Value

void

protected void loadRoutes()

Load the application routes.

Return Value

void

void register()

Register the service provider.

Return Value

void

mixed __call(string $method, array $parameters)

Pass dynamic methods onto the router instance.

Parameters

string $method
array $parameters

Return Value

mixed

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.7/Illuminate/Foundation/Support/Providers/RouteServiceProvider.html