class QueueServiceProvider extends ServiceProvider implements DeferrableProvider (View source)

Traits

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

Methods

void
__construct(Application $app)

Create a new service provider instance.

void
register()

Register the service provider.

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

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 $path = null)

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

mixed
getSerializedPropertyValue(mixed $value, bool $withRelations = true)

Get the property value prepared for serialization.

mixed
getRestoredPropertyValue(mixed $value)

Get the restored property value after deserialization.

restoreCollection(ModelIdentifier $value)

Restore a queueable collection instance.

restoreModel(ModelIdentifier $value)

Restore the model from the model identifier instance.

getQueryForModelRestoration(Model $model, array|int $ids)

Get the query for model restoration.

void
configureSerializableClosureUses()

Configure serializable closures uses.

void
registerManager()

Register the queue manager.

void
registerConnection()

Register the default queue connection binding.

void
registerConnectors(QueueManager $manager)

Register the connectors on the queue manager.

void
registerNullConnector(QueueManager $manager)

Register the Null queue connector.

void
registerSyncConnector(QueueManager $manager)

Register the Sync queue connector.

void
registerDatabaseConnector(QueueManager $manager)

Register the database queue connector.

void
registerRedisConnector(QueueManager $manager)

Register the Redis queue connector.

void
registerBeanstalkdConnector(QueueManager $manager)

Register the Beanstalkd queue connector.

void
registerSqsConnector(QueueManager $manager)

Register the Amazon SQS queue connector.

void
registerWorker()

Register the queue worker.

void
registerListener()

Register the queue listener.

void
registerFailedJobServices()

Register the failed job services.

databaseFailedJobProvider(array $config)

Create a new database failed job provider.

databaseUuidFailedJobProvider(array $config)

Create a new database failed job provider that uses UUIDs as IDs.

dynamoFailedJobProvider(array $config)

Create a new DynamoDb failed job provider.

Details

void __construct(Application $app)

Create a new service provider instance.

Parameters

Application $app

Return Value

void

void register()

Register the service provider.

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

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 $path = null)

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

Parameters

string $provider
string $path

Return Value

bool

protected mixed getSerializedPropertyValue(mixed $value, bool $withRelations = true)

Get the property value prepared for serialization.

Parameters

mixed $value
bool $withRelations

Return Value

mixed

protected mixed getRestoredPropertyValue(mixed $value)

Get the restored property value after deserialization.

Parameters

mixed $value

Return Value

mixed

protected Collection restoreCollection(ModelIdentifier $value)

Restore a queueable collection instance.

Parameters

ModelIdentifier $value

Return Value

Collection

Model restoreModel(ModelIdentifier $value)

Restore the model from the model identifier instance.

Parameters

ModelIdentifier $value

Return Value

Model

protected Builder getQueryForModelRestoration(Model $model, array|int $ids)

Get the query for model restoration.

Parameters

Model $model
array|int $ids

Return Value

Builder

protected void configureSerializableClosureUses()

Configure serializable closures uses.

Return Value

void

protected void registerManager()

Register the queue manager.

Return Value

void

protected void registerConnection()

Register the default queue connection binding.

Return Value

void

void registerConnectors(QueueManager $manager)

Register the connectors on the queue manager.

Parameters

QueueManager $manager

Return Value

void

protected void registerNullConnector(QueueManager $manager)

Register the Null queue connector.

Parameters

QueueManager $manager

Return Value

void

protected void registerSyncConnector(QueueManager $manager)

Register the Sync queue connector.

Parameters

QueueManager $manager

Return Value

void

protected void registerDatabaseConnector(QueueManager $manager)

Register the database queue connector.

Parameters

QueueManager $manager

Return Value

void

protected void registerRedisConnector(QueueManager $manager)

Register the Redis queue connector.

Parameters

QueueManager $manager

Return Value

void

protected void registerBeanstalkdConnector(QueueManager $manager)

Register the Beanstalkd queue connector.

Parameters

QueueManager $manager

Return Value

void

protected void registerSqsConnector(QueueManager $manager)

Register the Amazon SQS queue connector.

Parameters

QueueManager $manager

Return Value

void

protected void registerWorker()

Register the queue worker.

Return Value

void

protected void registerListener()

Register the queue listener.

Return Value

void

protected void registerFailedJobServices()

Register the failed job services.

Return Value

void

protected DatabaseFailedJobProvider databaseFailedJobProvider(array $config)

Create a new database failed job provider.

Parameters

array $config

Return Value

DatabaseFailedJobProvider

protected DatabaseUuidFailedJobProvider databaseUuidFailedJobProvider(array $config)

Create a new database failed job provider that uses UUIDs as IDs.

Parameters

array $config

Return Value

DatabaseUuidFailedJobProvider

protected DynamoDbFailedJobProvider dynamoFailedJobProvider(array $config)

Create a new DynamoDb failed job provider.

Parameters

array $config

Return Value

DynamoDbFailedJobProvider