class EventServiceProvider extends ServiceProvider (View source)

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 array<string,array<int,string>> $listen

The event handler mappings for the application.

protected array $subscribe

The subscribers to register.

protected array<string,string|object|array<int,string|object>> $observers

The model observers to register.

static protected bool $shouldDiscoverEvents

Indicates if events should be discovered.

static protected array|null $eventDiscoveryPaths

The configured event discovery paths.

Methods

void
__construct(Application $app)

Create a new service provider instance.

void
register()

Register the application's event listeners.

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.

void
mergeConfigFrom(string $path, string $key)

Merge the given configuration with the existing configuration.

void
replaceConfigRecursivelyFrom(string $path, string $key)

Replace the given configuration with the existing configuration recursively.

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
loadViewComponentsAs(string $prefix, array $components)

Register the given view components with a custom prefix.

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 database migration paths.

void
loadFactoriesFrom(array|string $paths) deprecated

Register Eloquent model factory paths.

void
callAfterResolving(string $name, callable $callback)

Setup an after resolving listener, or fire immediately if already resolved.

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

Register migration paths to be published by the publish command.

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|null $provider = null, string|null $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
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.

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.

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.

void
boot()

Boot any application services.

array
listens()

Get the events and handlers.

array
getEvents()

Get the discovered events and listeners for the application.

array
discoveredEvents()

Get the discovered events for the application.

bool
shouldDiscoverEvents()

Determine if events and listeners should be automatically discovered.

array
discoverEvents()

Discover the events and listeners for the application.

array
discoverEventsWithin()

Get the listener directories that should be used to discover events.

static void
addEventDiscoveryPaths(array|string $paths)

Add the given event discovery paths to the application's event discovery paths.

static void
setEventDiscoveryPaths(array $paths)

Set the globally configured event discovery paths.

string
eventDiscoveryBasePath()

Get the base path to be used during event discovery.

static void
disableEventDiscovery()

Disable event discovery for the application.

void
configureEmailVerification()

Configure the proper event listeners for email verification.

Details

void __construct(Application $app)

Create a new service provider instance.

Parameters

Application $app

Return Value

void

void register()

Register the application's event listeners.

Return Value

void

void booting(Closure $callback)

Register a booting callback to be run before the "boot" method is called.

Parameters

Closure $callback

Return Value

void

void booted(Closure $callback)

Register a booted callback to be run after the "boot" method is called.

Parameters

Closure $callback

Return Value

void

void callBootingCallbacks()

Call the registered booting callbacks.

Return Value

void

void callBootedCallbacks()

Call the registered booted callbacks.

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 replaceConfigRecursivelyFrom(string $path, string $key)

Replace the given configuration with the existing configuration recursively.

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 loadViewComponentsAs(string $prefix, array $components)

Register the given view components with a custom prefix.

Parameters

string $prefix
array $components

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 database migration paths.

Parameters

array|string $paths

Return Value

void

protected void loadFactoriesFrom(array|string $paths) deprecated

deprecated Will be removed in a future Laravel version.

Register Eloquent model factory paths.

Parameters

array|string $paths

Return Value

void

protected void callAfterResolving(string $name, callable $callback)

Setup an after resolving listener, or fire immediately if already resolved.

Parameters

string $name
callable $callback

Return Value

void

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

Register migration paths to be published by the publish command.

Parameters

array $paths
mixed $groups

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

Get the paths to publish.

Parameters

string|null $provider
string|null $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 publishableMigrationPaths()

Get the migration paths 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

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".

Parameters

string|null $optimize
string|null $clear
string|null $key

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

static DefaultProviders defaultProviders()

Get the default providers for a Laravel application.

Return Value

DefaultProviders

static bool addProviderToBootstrapFile(string $provider, string|null $path = null)

Add the given provider to the application's provider bootstrap file.

Parameters

string $provider
string|null $path

Return Value

bool

void boot()

Boot any application services.

Return Value

void

array listens()

Get the events and handlers.

Return Value

array

array getEvents()

Get the discovered events and listeners for the application.

Return Value

array

protected array discoveredEvents()

Get the discovered events for the application.

Return Value

array

bool shouldDiscoverEvents()

Determine if events and listeners should be automatically discovered.

Return Value

bool

array discoverEvents()

Discover the events and listeners for the application.

Return Value

array

protected array discoverEventsWithin()

Get the listener directories that should be used to discover events.

Return Value

array

static void addEventDiscoveryPaths(array|string $paths)

Add the given event discovery paths to the application's event discovery paths.

Parameters

array|string $paths

Return Value

void

static void setEventDiscoveryPaths(array $paths)

Set the globally configured event discovery paths.

Parameters

array $paths

Return Value

void

protected string eventDiscoveryBasePath()

Get the base path to be used during event discovery.

Return Value

string

static void disableEventDiscovery()

Disable event discovery for the application.

Return Value

void

protected void configureEmailVerification()

Configure the proper event listeners for email verification.

Return Value

void