MVC with one to many relationship

Questions Components & MVC
,
6

The Getting Started tutorial uses laminas-db but it can be replaced with any other packages you like or with which you have experience.
Like @ALTAMASH80, I do not use laminas-db because it does not support relationships out of the box.

The dropdown list can be handled with a custom element based on Laminas\Form\Select.

namespace ExampleModule\Form;

class ExampleSelectElement extends Laminas\Form\Element\Select
    implements Laminas\Db\Adapter\AdapterAwareInterface
{
    use Laminas\Db\Adapter\AdapterAwareTrait;

    public function init(): void
    {
        if (! $this->adapter) {
            return;
        }

        /** @var Laminas\Db\Adapter\Driver\StatementInterface $statement */
        $statement = $this->adapter->query('SELECT `id`, `name` FROM `artist`');
        $result    = $statement->execute();

        $options = [];
        /** @var array{id: int, name: string} $row */
        foreach ($result as $row) {
            $options[$row['id']] = $row['name'];
        }

        $this->setValueOptions($options);
    }
}

Add a delegator which adds the database adapter to the custom form element:

module/ExampleModule/config/module.config.php:

return [
    'form_elements' => [
        'delegators' => [
            ExampleModule\Form\ExampleSelectElement::class => [
                Laminas\Db\Adapter\AdapterServiceDelegator::class
            ],
        ],
    ],
    // …
];

Use the element in a form:

namespace ExampleModule\Form;

final class ExampleForm extends Laminas\Form\Form
{
    public function init(){
        $this->add([
            'name' => 'artist',
            'type' => ExampleModule\Form\ExampleSelectElement:class,
        ]);
    }
}

In your controller:

namespace ExampleModule\Controller;

use ExampleModule\Form\ExampleForm;
use Laminas\Form\FormElementManager;
use Laminas\Mvc\Controller\AbstractActionController;

final class HelloController extends AbstractActionController
{
    private FormElementManager $formElementManager;

    public function __construct(FormElementManager $formElementManager)
    {
        $this->formElementManager = $formElementManager;
    }

    public function worldAction()
    {
        $form = $this->formElementManager->get(ExampleForm::class);

        // …
    }
}

Register the controller in the configuration:

return [
    'controllers' => [
        'factories' => [
            ExampleModule\Controller\HelloController::class => 
                Laminas\ServiceManager\AbstractFactory\ReflectionBasedAbstractFactory::class,
        ],
    ],
    // …
];

This solution allows an easy reuse of the element, keeps the controller clean and makes it easier to test the form element.
Try to avoid assembling anything in the controller.

More on this topic can be found in the documentation:

1 Like