ServiceProvider

abstract class ServiceProvider (View source)

Properties

protected Application $app The application instance.
protected bool $defer Indicates if loading of the provider is deferred.
static array $publishes The paths that should be published.
static array $publishGroups The paths that should be published by group.

Methods

void __construct(Application $app)

Create a new service provider instance.
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, string $group = 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.

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

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