QueueServiceProvider
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 |
| 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 |
Methods
Register the service provider.
Register a booting callback to be run before the "boot" method is called.
Merge the given configuration with the existing configuration.
Replace the given configuration with the existing configuration recursively.
Load the given routes file if routes are not already cached.
Register a view file namespace.
Register the given view components with a custom prefix.
Register a translation file namespace.
Register a JSON translation file path.
Register database migration paths.
Setup an after resolving listener, or fire immediately if already resolved.
Register migration paths to be published by the publish command.
Register paths to be published by the publish command.
Ensure the publish array for the service provider is initialized.
Add a publish group / tag to the service provider.
Get the paths to publish.
Get the paths for the provider or group (or both).
Get the paths for the provider and group.
Get the service providers available for publishing.
Get the migration paths available for publishing.
Register the package's custom Artisan commands.
Register commands that should run on "optimize" or "optimize:clear".
Get the services provided by the provider.
Get the default providers for a Laravel application.
Add the given provider to the application's provider bootstrap file.
Get the property value prepared for serialization.
Get the restored property value after deserialization.
Get the query for model restoration.
Configure serializable closures uses.
Register the queue manager.
Register the default queue connection binding.
Register the queue worker.
Register the queue listener.
Register the failed job services.
Create a new database failed job provider.
Create a new database failed job provider that uses UUIDs as IDs.
Create a new DynamoDb failed job provider.
Details
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.
protected void
mergeConfigFrom(string $path, string $key)
Merge the given configuration with the existing configuration.
protected void
replaceConfigRecursivelyFrom(string $path, string $key)
Replace the given configuration with the existing configuration recursively.
protected void
loadRoutesFrom(string $path)
Load the given routes file if routes are not already cached.
protected void
loadViewsFrom(string|array $path, string $namespace)
Register a view file namespace.
protected void
loadViewComponentsAs(string $prefix, array $components)
Register the given view components with a custom prefix.
protected void
loadTranslationsFrom(string $path, string $namespace)
Register a translation file namespace.
protected void
loadJsonTranslationsFrom(string $path)
Register a JSON translation file path.
protected void
loadMigrationsFrom(array|string $paths)
Register database migration paths.
protected void
loadFactoriesFrom(array|string $paths)
deprecated
deprecated
Register Eloquent model factory paths.
protected void
callAfterResolving(string $name, callable $callback)
Setup an after resolving listener, or fire immediately if already resolved.
protected void
publishesMigrations(array $paths, mixed $groups = null)
Register migration paths to be published by the publish command.
protected void
publishes(array $paths, mixed $groups = null)
Register paths to be published by the publish command.
protected void
ensurePublishArrayInitialized(string $class)
Ensure the publish array for the service provider is initialized.
protected 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 protected array
pathsForProviderOrGroup(string|null $provider, string|null $group)
Get the paths for the provider or group (or both).
static protected 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.
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".
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.
static DefaultProviders
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.
protected mixed
getSerializedPropertyValue(mixed $value, bool $withRelations = true)
Get the property value prepared for serialization.
protected mixed
getRestoredPropertyValue(mixed $value)
Get the restored property value after deserialization.
protected Collection
restoreCollection(ModelIdentifier $value)
Restore a queueable collection instance.
Model
restoreModel(ModelIdentifier $value)
Restore the model from the model identifier instance.
protected TModel>
getQueryForModelRestoration(TModel $model, array|int $ids)
Get the query for model restoration.
protected void
configureSerializableClosureUses()
Configure serializable closures uses.
protected void
registerManager()
Register the queue manager.
protected void
registerConnection()
Register the default queue connection binding.
void
registerConnectors(QueueManager $manager)
Register the connectors on the queue manager.
protected void
registerNullConnector(QueueManager $manager)
Register the Null queue connector.
protected void
registerSyncConnector(QueueManager $manager)
Register the Sync queue connector.
protected void
registerDatabaseConnector(QueueManager $manager)
Register the database queue connector.
protected void
registerRedisConnector(QueueManager $manager)
Register the Redis queue connector.
protected void
registerBeanstalkdConnector(QueueManager $manager)
Register the Beanstalkd queue connector.
protected void
registerSqsConnector(QueueManager $manager)
Register the Amazon SQS queue connector.
protected void
registerWorker()
Register the queue worker.
protected void
registerListener()
Register the queue listener.
protected void
registerFailedJobServices()
Register the failed job services.
protected DatabaseFailedJobProvider
databaseFailedJobProvider(array $config)
Create a new database failed job provider.
protected DatabaseUuidFailedJobProvider
databaseUuidFailedJobProvider(array $config)
Create a new database failed job provider that uses UUIDs as IDs.
protected DynamoDbFailedJobProvider
dynamoFailedJobProvider(array $config)
Create a new DynamoDb failed job provider.