Feature | Models on Haystacks

[Sammyjo20]

🚀 This PR introduces a handy helper method to define models that should be accessible to every job within the Haystack. Internally, it will serialize the model including its relationships and scopes and you will be able to retrieve the model in your code.

Haystack::build()
    ->addJob(new RecordPodcast)
    ->withModel($user)
    ->dispatch();

Inside your jobs...

$this->getHaystackModel(User::class);

This PR also introduces a beforeSave callback which is useful if you want to modify the Haystack model before it is created and dispatched.

Haystack::build()
    ->addJob(new RecordPodcast)
    ->beforeSave(function (Haystack $haystack) {
             $haystack->options->customOption = true;
     })
    ->dispatch();

This PR also introduces a new ability to set a custom option that you can use across your Haystack.

Haystack::build()
    ->addJob(new RecordPodcast)
    ->setOption('yeeHaw', '🤠')
    ->dispatch();

Inside your jobs...

$this->getHaystackOptions();

$this->getHaystackOption('yeeHaw');

[Sammyjo20]

Self review