WorkflowInterface defines the contract for workflow objects that orchestrate collections of jobs. It extends Countable to provide job counting functionality.
Namespace
Methods
jobs()
Provides access to the jobs collection.The jobs collection for this workflow
referenced()
Provides a map of response identifiers referenced from each producer job.- key:
string— producer job name (e.g."job1") - value:
string[]— ordered list of identifiers other jobs reference from that producer
- A response key when a consumer references
response('job', 'key') - The producer job name itself when a consumer references
response('job')(meaning the whole response)
- Entries are appended in processing order and duplicates are possible
- This map answers “which response identifiers are referenced from job X?”
- To find “which jobs reference job X?”, inspect
jobs()->get($name)->dependencies()or build a reverse mapping from job dependencies
Map of producer job names to arrays of referenced identifiers
dependencies()
Provides access to the workflow dependencies.The dependencies for this workflow
withAddedJob()
Returns an instance with the specified jobs added.One or more job instances to add to the workflow
New instance with the added jobs
OverflowException— If adding the job would cause an overflow
parameters()
Provides access to the workflow parameters.The parameters interface for this workflow