Controllers

Controllers are what we all know and love. Sometimes they are nice and slick. Other times, they get slightly out hand and they increase in size.

With Vivid, your controllers will only be a single line and that's it!

This is because the Controllers are only responsible for serving a Feature and nothing else. There is no logic in them and their difference from a normal Laravel controller in terms of structure is the extension of the Vivid\Foundation\Http\Controller base class which is responsible for implementing the ServesFeaturesTrait.

Generating Controllers

In order to generate a Controller using the Vivid Console, type the following command:

./vendor/bin/vivid make:controller <controller> <device> [<--resource>, <--invokable>]

There are three different types of controllers that you can create through the make:controller command.

If you specify no options, a pain controller will be generated with no methods inside.

You can append the --resource option to the make:controller command and create a controller which will include the index, create, store, show, edit, update, destroy methods.

Lastly, you can use the --invokable option to generate a controller only with an __invoke method.

Dependency Injection

You might feel tempted to use dependency injection and pass a resource instance to the Feature but this is not the correct way to do it.

While you have to add the models as a parameter in the controller method, they will be accessible, automatically, by the request object.

For example, this is not required:

[...]

public function update(User $user) {
    return $this->serve(UpdateUserFeature::class, ['user' => $user]);
}

[...]

A better way would be to not pass the array inside serve() at all, but keep it in the method definition. From within the Feature, you can access the injected object using the Request object.

---

It is up to you to decide how your controller structure will be. When you aren't sure, we recommend watching the "Cruddy by Design" talk by Adam Wathan. In summary, it is a good idea to avoid using any word for the name of a controller other than the standard CRUD names. However, this is up to you. Vivid will not force any coding standard upon you.