Documentation

QueueServiceProvider extends ServiceProvider
in package

Table of Contents

$publishes  : array<string|int, mixed>
The paths that should be published.
$publishGroups  : array<string|int, mixed>
The paths that should be published by group.
$app  : Application
The application instance.
$defer  : bool
Indicates if loading of the provider is deferred.
__construct()  : void
Create a new service provider instance.
commands()  : void
Register the package's custom Artisan commands.
isDeferred()  : bool
Determine if the provider is deferred.
pathsToPublish()  : array<string|int, mixed>
Get the paths to publish.
provides()  : array<string|int, mixed>
Get the services provided by the provider.
publishableGroups()  : array<string|int, mixed>
Get the groups available for publishing.
publishableProviders()  : array<string|int, mixed>
Get the service providers available for publishing.
register()  : void
Register the service provider.
registerConnectors()  : void
Register the connectors on the queue manager.
when()  : array<string|int, mixed>
Get the events that trigger this service provider to register.
addPublishGroup()  : void
Add a publish group / tag to the service provider.
databaseFailedJobProvider()  : DatabaseFailedJobProvider
Create a new database failed job provider.
ensurePublishArrayInitialized()  : void
Ensure the publish array for the service provider is initialized.
loadJsonTranslationsFrom()  : void
Register a JSON translation file path.
loadMigrationsFrom()  : void
Register a database migration path.
loadRoutesFrom()  : void
Load the given routes file if routes are not already cached.
loadTranslationsFrom()  : void
Register a translation file namespace.
loadViewsFrom()  : void
Register a view file namespace.
mergeConfigFrom()  : void
Merge the given configuration with the existing configuration.
pathsForProviderAndGroup()  : array<string|int, mixed>
Get the paths for the provider and group.
pathsForProviderOrGroup()  : array<string|int, mixed>
Get the paths for the provider or group (or both).
publishes()  : void
Register paths to be published by the publish command.
registerBeanstalkdConnector()  : void
Register the Beanstalkd queue connector.
registerConnection()  : void
Register the default queue connection binding.
registerDatabaseConnector()  : void
Register the database queue connector.
registerFailedJobServices()  : void
Register the failed job services.
registerListener()  : void
Register the queue listener.
registerManager()  : void
Register the queue manager.
registerNullConnector()  : void
Register the Null queue connector.
registerRedisConnector()  : void
Register the Redis queue connector.
registerSqsConnector()  : void
Register the Amazon SQS queue connector.
registerSyncConnector()  : void
Register the Sync queue connector.
registerWorker()  : void
Register the queue worker.

Properties

$publishes

The paths that should be published.

public static array<string|int, mixed> $publishes = []

$publishGroups

The paths that should be published by group.

public static array<string|int, mixed> $publishGroups = []

Methods

commands()

Register the package's custom Artisan commands.

public commands(array<string|int, mixed>|mixed $commands) : void
Parameters
$commands : array<string|int, mixed>|mixed
Return values
void —

isDeferred()

Determine if the provider is deferred.

public isDeferred() : bool
Return values
bool —

pathsToPublish()

Get the paths to publish.

public static pathsToPublish([string $provider = null ][, string $group = null ]) : array<string|int, mixed>
Parameters
$provider : string = null
$group : string = null
Return values
array<string|int, mixed> —

provides()

Get the services provided by the provider.

public provides() : array<string|int, mixed>
Return values
array<string|int, mixed> —

publishableGroups()

Get the groups available for publishing.

public static publishableGroups() : array<string|int, mixed>
Return values
array<string|int, mixed> —

publishableProviders()

Get the service providers available for publishing.

public static publishableProviders() : array<string|int, mixed>
Return values
array<string|int, mixed> —

register()

Register the service provider.

public register() : void
Return values
void —

when()

Get the events that trigger this service provider to register.

public when() : array<string|int, mixed>
Return values
array<string|int, mixed> —

addPublishGroup()

Add a publish group / tag to the service provider.

protected addPublishGroup(string $group, array<string|int, mixed> $paths) : void
Parameters
$group : string
$paths : array<string|int, mixed>
Return values
void —

ensurePublishArrayInitialized()

Ensure the publish array for the service provider is initialized.

protected ensurePublishArrayInitialized(string $class) : void
Parameters
$class : string
Return values
void —

loadJsonTranslationsFrom()

Register a JSON translation file path.

protected loadJsonTranslationsFrom(string $path) : void
Parameters
$path : string
Return values
void —

loadMigrationsFrom()

Register a database migration path.

protected loadMigrationsFrom(array<string|int, mixed>|string $paths) : void
Parameters
$paths : array<string|int, mixed>|string
Return values
void —

loadRoutesFrom()

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

protected loadRoutesFrom(string $path) : void
Parameters
$path : string
Return values
void —

loadTranslationsFrom()

Register a translation file namespace.

protected loadTranslationsFrom(string $path, string $namespace) : void
Parameters
$path : string
$namespace : string
Return values
void —

loadViewsFrom()

Register a view file namespace.

protected loadViewsFrom(string|array<string|int, mixed> $path, string $namespace) : void
Parameters
$path : string|array<string|int, mixed>
$namespace : string
Return values
void —

mergeConfigFrom()

Merge the given configuration with the existing configuration.

protected mergeConfigFrom(string $path, string $key) : void
Parameters
$path : string
$key : string
Return values
void —

pathsForProviderAndGroup()

Get the paths for the provider and group.

protected static pathsForProviderAndGroup(string $provider, string $group) : array<string|int, mixed>
Parameters
$provider : string
$group : string
Return values
array<string|int, mixed> —

pathsForProviderOrGroup()

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

protected static pathsForProviderOrGroup(string|null $provider, string|null $group) : array<string|int, mixed>
Parameters
$provider : string|null
$group : string|null
Return values
array<string|int, mixed> —

publishes()

Register paths to be published by the publish command.

protected publishes(array<string|int, mixed> $paths[, string $group = null ]) : void
Parameters
$paths : array<string|int, mixed>
$group : string = null
Return values
void —

registerConnection()

Register the default queue connection binding.

protected registerConnection() : void
Return values
void —

registerFailedJobServices()

Register the failed job services.

protected registerFailedJobServices() : void
Return values
void —

registerListener()

Register the queue listener.

protected registerListener() : void
Return values
void —

registerManager()

Register the queue manager.

protected registerManager() : void
Return values
void —

registerWorker()

Register the queue worker.

protected registerWorker() : void
Return values
void —

Search results