A reference index of public classes and interfaces, grouped by namespace. Refer to the source files for the authoritative signatures.
| Class | Description |
|---|---|
BatchProcessing |
Static facade with inMemory(), pdo(), async() |
| Class / Enum | Description |
|---|---|
BatchStatus (enum) |
Execution state |
ExitStatus |
Exit code value object (static instances) |
JobInstance |
Logical job identity (name + key hash) |
JobExecution |
Single execution attempt |
StepExecution |
Step execution with counters |
JobParameters |
Immutable parameter collection |
JobParameter |
Single typed parameter |
JobParametersBuilder |
Fluent builder for JobParameters |
ExecutionContext |
Persistent key-value map |
StepContribution |
Per-chunk metric accumulator |
DefaultJobParametersConverter |
Convert between formats (key:value strings) |
| Class / Interface | Description |
|---|---|
JobInterface |
Job contract |
AbstractJob |
Base implementation |
SimpleJob |
Sequential execution |
FlowJob |
Conditional transitions |
JobBuilder |
Fluent job builder |
JobBuilderFactory |
Factory for JobBuilder |
FlowDeciderInterface |
Custom flow routing |
JobInterruptionPolicyInterface |
Decide if a job should stop |
SignalJobInterruptionPolicy |
pcntl signal handling |
JobParametersIncrementerInterface |
Auto-increment identifying parameters |
RunIdIncrementer, DateIncrementer, CompositeIncrementer |
Built-in incrementers |
JobParametersValidatorInterface |
Validate parameters |
DefaultJobParametersValidator |
Required/optional key validation |
IdentifyingJobParametersValidator |
Ensure specific keys are identifying |
CompositeJobParametersValidator |
Combine validators |
JobParametersExtractorInterface |
Extract parameters (used by JobStep) |
DefaultJobParametersExtractor |
Default extractor |
Job\Flow\FlowInterface |
Flow contract |
Job\Flow\SimpleFlow, FlowBuilder, SimpleFlowFactory, Transition, FlowExecutionStatus |
Flow internals |
SplitFlow |
Parallel sub-flow execution |
| Class / Interface | Description |
|---|---|
StepInterface |
Step contract |
AbstractStep |
Base with listener/event dispatch |
ChunkOrientedStep |
Read-process-write step |
TaskletStep |
Wraps a TaskletInterface |
TaskletInterface |
Arbitrary unit-of-work |
SystemCommandTasklet |
Execute shell commands |
FlowStep |
Wraps a Flow as a step |
JobStep |
Wraps another Job as a step |
RepeatStatus (enum) |
FINISHED / CONTINUABLE |
StepBuilder, StepBuilderFactory |
Fluent builder + factory |
Step\Builder\AbstractStepBuilder, FaultTolerantStepBuilder, FlowStepBuilder |
Internal builder helpers |
Top-level interfaces:
ItemReaderInterface, ItemProcessorInterface, ItemWriterInterface,
ItemStreamInterface, CompositeItemStream,
ResourceAwareItemReaderItemStreamInterface,
ResourceAwareItemWriterItemStreamInterface.
AbstractItemReader, IteratorItemReader, ListItemReader,
CallbackItemReader, PdoItemReader, PaginatedPdoItemReader,
PdoPagingItemReader, CsvItemReader (+ CsvFieldSetMapperInterface),
JsonItemReader, JsonLinesItemReader, MultiResourceItemReader,
TransformingItemReader, RedisItemReader (+ RedisDataStructure),
ScriptItemReader, SynchronizedItemStreamReader, ItemReaderAdapter,
Item\Reader\Paging\SqlPagingQueryProviderInterface,
Item\Reader\Paging\LimitOffsetPagingQueryProvider.
PassThroughItemProcessor, FilteringItemProcessor, CompositeItemProcessor,
ChainItemProcessor, ValidatingItemProcessor, BeanValidatingItemProcessor,
AsyncItemProcessor, ScriptItemProcessor, ItemProcessorAdapter.
AbstractItemWriter, PdoItemWriter, PdoBatchItemWriter,
CallbackItemWriter, CompositeItemWriter, ClassifierCompositeItemWriter,
FlatFileItemWriter, JsonFileItemWriter, RedisItemWriter,
MultiResourceItemWriter, AsyncItemWriter, ListItemWriter,
ItemWriterAdapter.
LineAggregatorInterface, LineMapperInterface, LineTokenizerInterface,
FieldExtractorInterface, FieldSetMapperInterface, FieldSetFactory,
DefaultFieldSet, FieldSet, DelimitedLineAggregator,
DelimitedLineTokenizer, FixedLengthTokenizer, FormatterLineAggregator,
PassThroughLineAggregator, PassThroughFieldExtractor,
PatternMatchingCompositeLineTokenizer, BeanWrapperFieldExtractor,
DefaultLineMapper.
Chunk, ChunkContext, ChunkProviderInterface, ChunkProcessorInterface,
SimpleChunkProvider, SimpleChunkProcessor, FaultTolerantChunkProvider,
FaultTolerantChunkProcessor, CompletionPolicyInterface,
SimpleCompletionPolicy, CountingCompletionPolicy,
TimeoutTerminationPolicy, CompositeCompletionPolicy, ChunkListener.
| Class / Interface | Description |
|---|---|
JobRepositoryInterface |
Persistence contract |
AbstractJobRepository |
Common logic |
InMemoryJobRepository |
In-memory implementation |
PdoJobRepository |
PDO implementation |
PdoJobRepositorySchema |
DDL generator |
IsolationLevel (enum) |
Transaction isolation |
BatchConfigurerInterface |
Configuration contract |
DefaultBatchConfigurer |
Default wiring |
Repository\Dao\*DaoInterface |
Internal DAOs (used by PdoJobRepository) |
Repository\Dao\Pdo\* |
PDO DAO implementations |
Repository\Incrementer\* |
Sequence id incrementers (MySQL/Postgres/SQLite) |
JobLauncherInterface, AbstractJobLauncher, SimpleJobLauncher,
AsyncJobLauncher, TaskExecutorJobLauncher, SignalHandler.
JobExplorerInterface, SimpleJobExplorer, AbstractCachedJobExplorer,
CachedJobExplorer, SimpleCacheJobExplorer.
JobOperatorInterface, SimpleJobOperator.
JobRegistryInterface, JobLocatorInterface, JobFactoryInterface,
InMemoryJobRegistry, ContainerJobRegistry, ContainerJobLocator,
ReferenceJobFactory, AttributeJobScanner.
| Class / Interface | Description |
|---|---|
RetryOperations |
Retry contract |
RetryTemplate |
Default retry template |
RetryPolicyInterface |
Policy contract |
RetryContext, RetryContextSupport |
Retry context + helpers |
RetryCallback |
Retry callback abstraction |
RecoveryCallbackInterface |
Recovery contract |
RetrySynchronizationManager |
Cross-fiber/thread retry context |
Retry\Interceptor\* |
Retry interceptors (when applicable) |
AbstractRetryPolicy, SimpleRetryPolicy, MaxAttemptsRetryPolicy,
NeverRetryPolicy, AlwaysRetryPolicy, TimeoutRetryPolicy,
CircuitBreakerRetryPolicy, ExceptionClassifierRetryPolicy,
BinaryExceptionClassifierRetryPolicy, CompositeRetryPolicy.
BackOffPolicyInterface, NoBackOffPolicy, FixedBackOffPolicy,
ExponentialBackOffPolicy, ExponentialRandomBackOffPolicy,
UniformRandomBackOffPolicy.
SkipPolicyInterface, LimitCheckingItemSkipPolicy,
AlwaysSkipItemSkipPolicy, NeverSkipItemSkipPolicy,
ExceptionClassifierSkipPolicy, ExceptionHierarchySkipPolicy,
CountingSkipPolicy, CompositeSkipPolicy, SkipCounter.
Listener interfaces:
JobExecutionListenerInterface, StepExecutionListenerInterface,
ChunkListenerInterface, ItemReadListenerInterface,
ItemProcessListenerInterface, ItemWriteListenerInterface,
SkipListenerInterface, RetryListenerInterface.
Implementations & helpers:
CompositeListener, StepListenerFactory,
ExecutionContextPromotionListener, ScopeResetListener.
Listener\Logging\*— PSR-3 logging listeners (LoggingChunkListener,LoggingItemReadListener, …).Listener\Support\*— NOOP base classes implementing each listener interface (StepExecutionListenerSupport,ChunkListenerSupport, …).
AbstractJobEvent, BeforeJobEvent, AfterJobEvent, JobFailedEvent,
AbstractStepEvent, BeforeStepEvent, AfterStepEvent, StepFailedEvent,
AbstractChunkEvent, BeforeChunkEvent, AfterChunkEvent,
ChunkFailedEvent.
TransactionManagerInterface, PdoTransactionManager,
ResourcelessTransactionManager.
PartitionerInterface, SimplePartitioner, ColumnRangePartitioner,
PartitionStep, StepHandlerInterface, TaskExecutorPartitionHandler,
StepExecutionSplitterInterface, SimpleStepExecutionSplitter,
StepExecutionAggregator, StepLocatorInterface, ContainerStepLocator,
PartitionNameProviderInterface, FiberTaskExecutor, ProcessTaskExecutor.
TaskExecutorInterface, SyncTaskExecutor, SimpleAsyncTaskExecutor.
RepeatOperationsInterface, RepeatTemplate, TaskExecutorRepeatTemplate,
RepeatContext, RepeatListenerInterface (+ Repeat\Executor\*,
Repeat\Support\*).
AbstractScope, JobScope, StepScope,
Scope\Container\ScopedContainerInterface,
Scope\Container\InMemoryScopedContainer,
Scope\Expression\LateBindingExpressionResolverInterface,
Scope\Expression\SimpleLateBindingExpressionResolver.
ClassifierInterface, BinaryExceptionClassifier, SubclassClassifier,
BackToBackPatternClassifier.
BatchJob, JobScope, StepScope, plus per-callback markers in
Attribute\Listener\*: BeforeJob, AfterJob, BeforeStep, AfterStep,
BeforeChunk, AfterChunk, BeforeRead, AfterRead, BeforeProcess,
AfterProcess, BeforeWrite, AfterWrite, OnReadError, OnWriteError,
OnSkipInRead, OnSkipInProcess, OnSkipInWrite.
JobLauncherTestUtils, JobRepositoryTestUtils, MetaDataInstanceFactory,
StepRunner, MockItemReader, InMemoryItemWriter,
ExecutionContextTestUtils, RetryContextMockFactory,
SkipContextMockFactory, JobScopeTestExecutionListener,
StepScopeTestExecutionListener, AssertFile.
BatchProcessingBundle, DependencyInjection\BatchProcessingExtension,
DependencyInjection\Configuration,
DependencyInjection\Compiler\BatchJobPass. Console commands in Command/
(launch/list/status/stop/restart/abandon/cleanup/health). Messenger
integration: Messenger\MessengerJobDispatcher, Messenger\RunJobMessage,
Messenger\RunJobMessageHandler. Additional integrations in the namespaces
Item/, Lock/, Migration/, Profiler/ (e.g. BatchDataCollector),
Scope/, Serializer/, Validator/.
BatchProcessingServiceProvider. Artisan commands in Console/
(launch/list/status/stop/restart/abandon/health). Additional integrations in
Cache/, Item/ (EloquentItemReader, EloquentItemWriter), Queue/,
Transaction/, Validator/. Default config/ and database/ migrations
are published via vendor:publish.
See Exception Hierarchy for the complete tree.