Lewanscheck.de

This one took me a while to figure out so I thought I would write it up real quick in case somebody else is trying to figure this out.

TLDR – “Cut the crap and just show me how it’s done” – LINK

I was setting up a Zend Framework 2 project with Doctrine. You can find quite a lot of tutorials for that. For starters you could check out Jason Grimes’ ZF2 Doctrine tutorial.

Setting up the entities and my edit forms was no problem. But making use of DoctrineModule\Form\Element\ObjectSelect took some more work. I wanted to use it for a category select. But the form element needs the Doctrine entityManager. So I wrote up my form like this:

Hand-ish, not very elegant way of injecting Doctrine EntityManager in Zf2 Form

<?php

namespace Application\Form;

use Doctrine\ORM\EntityManager;
use Zend\Filter\FilterChain;
use Zend\Filter\FilterPluginManager;
use Zend\Filter\StringTrim;
use Zend\Filter\StripTags;
use Zend\Form\Element;
use Zend\Form\Form;
use Zend\InputFilter\Input;
use Zend\InputFilter\InputFilter;
use Zend\Validator;
use Zend\Validator\StringLength;

class CategoryForm extends Form
{
    /**
     * @var EntityManager
     */
    protected $em;

    /**
     * @var FilterPluginManager
     */
    protected $fpm;

    public function __construct(EntityManager $em, $name = null, $options = array())
    {       
        $this->em = $em;

        parent::__construct('category', $options);
        $this->addElements();
        $this->setInputFilter($this->createInputFilter());
    }

    public function addElements()
    { 
        $this->add(array(
            'name' => 'id',
            'type' => 'Hidden',
        ));

        $name = new Element\Text('name');
        $name->setOptions( array('label' => 'Kategoriebezeichnung'));
        $this->add($name);

        $this->add(array(
                'name' => 'parent',
                'type' => 'DoctrineModule\Form\Element\ObjectSelect',
                'options' => array(
                        'label' => "übergeordnete Kategorie",
                        'empty_option'    => '',
                        'object_manager' => $this->em,
                        'target_class' => 'Application\Entity\Category',
                        'property' => 'name',                   
                ),
        ));

        $this->add(array(
            'name' => 'submit',
            'type' => 'Submit',
            'attributes' => array(
                'value' => 'Go',
                'id' => 'submitbutton',
            ),
        ));
    }

    public function createInputFilter()
    {
        $inputFilter = new InputFilter();

        $catFilter = new Input('parent');
        $catFilter->setRequired(false);
        $inputFilter->add($catFilter);

        // name Input
        $nameFilter = new Input('name');
        $nameFilter->setRequired(true);
        $nameFilter->getFilterChain()->attach(new StringTrim());
        $nameFilter->getFilterChain()->attach(new StripTags());
        $inputFilter->add($nameFilter);

        return $inputFilter;
    }

}

<?php

namespace Application\Form;

use Doctrine\ORM\EntityManager;

use Zend\Filter\FilterChain;

use Zend\Filter\FilterPluginManager;

use Zend\Filter\StringTrim;

use Zend\Filter\StripTags;

use Zend\Form\Element;

use Zend\Form\Form;

use Zend\InputFilter\Input;

use Zend\InputFilter\InputFilter;

use Zend\Validator;

use Zend\Validator\StringLength;

class CategoryForm extends Form

{

/**

* @var EntityManager

protected $em;

/**

* @var FilterPluginManager

protected $fpm;

public function __construct(EntityManager $em, $name = null, $options = array())

{

$this->em = $em;

parent::__construct('category', $options);

$this->addElements();

$this->setInputFilter($this->createInputFilter());

}

public function addElements()

{

$this->add(array(

'name' => 'id',

'type' => 'Hidden',

));

$name = new Element\Text('name');

$name->setOptions( array('label' => 'Kategoriebezeichnung'));

$this->add($name);

$this->add(array(

'name' => 'parent',

'type' => 'DoctrineModule\Form\Element\ObjectSelect',

'options' => array(

'label' => "übergeordnete Kategorie",

'empty_option' => '',

'object_manager' => $this->em,

'target_class' => 'Application\Entity\Category',

'property' => 'name',

));

$this->add(array(

'name' => 'submit',

'type' => 'Submit',

'attributes' => array(

'value' => 'Go',

'id' => 'submitbutton',

));

}

public function createInputFilter()

{

$inputFilter = new InputFilter();

$catFilter = new Input('parent');

$catFilter->setRequired(false);

$inputFilter->add($catFilter);

// name Input

$nameFilter = new Input('name');

$nameFilter->setRequired(true);

$nameFilter->getFilterChain()->attach(new StringTrim());

$nameFilter->getFilterChain()->attach(new StripTags());

$inputFilter->add($nameFilter);

return $inputFilter;

}

Look at how I inject the entityManager and keep dragging it through the application just so I can use it in the one form field below.

And in my Controller I had to create the form like this:

<?php

namespace Application\Controller;

use Zend\View\Model\ViewModel;
use Application\Form\CategoryForm;

use Application\Entity\Category;
use DoctrineModule\Stdlib\Hydrator\DoctrineObject as DoctrineHydrator;
use Doctrine\ORM;

class CategoryController extends BaseController
{

    public function indexAction()
    {
        // here be code for index action
    }

    // action for both - edit and add
    public function editAction()
    {
        $id = (int) $this->params()->fromRoute('id', 0);
        $mode = "edit";

        $category = $this->getEntityManager()->find('Application\Entity\Category', $id);
        if(!$category instanceof Category) {
            $category = new Category();
            $mode = "add";
        }

        $form = new CategoryForm($this->getEntityManager());
        // assign hydrator
        $hydrator = new DoctrineHydrator($this->getEntityManager(), get_class($category));
        $form->setHydrator($hydrator);

        // bind object to form
        $form->bind($category);
        if($mode == "add") {
            $form->get('submit')->setValue('Add');    
        } else {
            $form->get('submit')->setAttribute('value', 'Save');   
        } 

        $request = $this->getRequest();
        if ($request->isPost()) {

            $form->setData($request->getPost());

            if ($form->isValid()) {

                if($mode == "add") {
                    $this->getEntityManager()->persist($category);
                    $msg = 'Kategorie erfolgreich hinzugefügt.';
                } else {
                    $msg = 'Kategorie gespeichert.';
                }
                $this->getEntityManager()->flush();

                $this->FlashMessenger()->setNamespace(\Zend\Mvc\Controller\Plugin\FlashMessenger::NAMESPACE_INFO)
                        ->addMessage($msg);
                return $this->redirect()->toRoute('category');
            }
        }
        return array(
            'id' => $id,
            'form' => $form,
        );
    }

    public function deleteAction()
    {
        // here be code for delete action
    }
}

<?php

namespace Application\Controller;

use Zend\View\Model\ViewModel;

use Application\Form\CategoryForm;

use Application\Entity\Category;

use DoctrineModule\Stdlib\Hydrator\DoctrineObject as DoctrineHydrator;

use Doctrine\ORM;

class CategoryController extends BaseController

{

public function indexAction()

{

// here be code for index action

}

// action for both - edit and add

public function editAction()

{

$id = (int) $this->params()->fromRoute('id', 0);

$mode = "edit";

$category = $this->getEntityManager()->find('Application\Entity\Category', $id);

if(!$category instanceof Category) {

$category = new Category();

$mode = "add";

}

$form = new CategoryForm($this->getEntityManager());

// assign hydrator

$hydrator = new DoctrineHydrator($this->getEntityManager(), get_class($category));

$form->setHydrator($hydrator);

// bind object to form

$form->bind($category);

if($mode == "add") {

$form->get('submit')->setValue('Add');

} else {

$form->get('submit')->setAttribute('value', 'Save');

}

$request = $this->getRequest();

if ($request->isPost()) {

$form->setData($request->getPost());

if ($form->isValid()) {

if($mode == "add") {

$this->getEntityManager()->persist($category);

$msg = 'Kategorie erfolgreich hinzugefügt.';

} else {

$msg = 'Kategorie gespeichert.';

}

$this->getEntityManager()->flush();

$this->FlashMessenger()->setNamespace(\Zend\Mvc\Controller\Plugin\FlashMessenger::NAMESPACE_INFO)

->addMessage($msg);

return $this->redirect()->toRoute('category');

}

return array(

'id' => $id,

'form' => $form,

);

}

public function deleteAction()

{

// here be code for delete action

}

Note that there is a BaseController which provides the getEntityManager() function. I created it because I need more than one form with the entityManager and providing the function at a central place seemed like the best idea at that point.

The BaseController looks something like that:

<?php
namespace Application\Controller;

use Zend\Mvc\Controller\AbstractActionController;

class BaseController extends AbstractActionController
{

    /**
     * @var Doctrine\ORM\EntityManager
     */
    protected $em;

    /**
     * for managing entities via Doctrine
     * @return Doctrine\ORM\EntityManager
     */
    public function getEntityManager()
    {
        if (null === $this->em) {
            $this->em = $this->getServiceLocator()->get('Doctrine\ORM\EntityManager');
        }
        return $this->em;
    }
}

<?php

namespace Application\Controller;

use Zend\Mvc\Controller\AbstractActionController;

class BaseController extends AbstractActionController

{

/**

* @var Doctrine\ORM\EntityManager

protected $em;

/**

* for managing entities via Doctrine

* @return Doctrine\ORM\EntityManager

public function getEntityManager()

{

if (null === $this->em) {

$this->em = $this->getServiceLocator()->get('Doctrine\ORM\EntityManager');

}

return $this->em;

}

All pretty tedious and not very elegant. So I started looking for a more elegant way to do things.

(Semi)-automated injection of Doctrine EntityManager

The configuration of Zf2 is quite mighty and worth looking at if you want things to be done FOR you instead of just tediously trying to build and maintain stuff yourself. Still haven’t found a comprehensive guide to it so it took me a lot of digging around.

First of all you instead of creating your form directly like that:

$form = new CategoryForm($this->getEntityManager(), 'formName', $optionsArray);

1	$form = new CategoryForm($this->getEntityManager(), 'formName', $optionsArray);

you get your form through the FormElementManager like this:

$forms = $this->getServiceLocator()->get('FormElementManager');
$form = $forms->get('CategoryForm', array('name' => 'formName', 'options' => array()));

1 2	$forms = $this->getServiceLocator()->get('FormElementManager'); $form = $forms->get('CategoryForm', array('name' => 'formName', 'options' => array()));

This way you can make use of the getFormElementConfig() function in your Module.php:

<?php

namespace Application;

/**
 * .... all kinds of other stuff 
 * 
 */

// very important - otherwise OjectManagerAwareInterface will not be recognized and you will NOT see an error 
use DoctrineModule\Persistence\ObjectManagerAwareInterface;

class Module
{
    public function getFormElementConfig()
    {
        return array(
            'invokables' => array(
                'CategoryForm' => 'Application\Form\CategoryForm',
            ),
            'initializers' => array(
                'ObjectManagerInitializer' => function ($element, $formElements) {
                    // look if the form implements the ObjectManagerAwareInterface
                    if ($element instanceof ObjectManagerAwareInterface) {
                        // locate the EntityManager using the serviceLocator
                        $services = $formElements->getServiceLocator();
                        $entityManager = $services->get('Doctrine\ORM\EntityManager');
                        // set the forms EntityManager or Objectmanager, 2 names for the same thing
                        $element->setObjectManager($entityManager);
                    }
                }
        );
    }

    /**
     * .... other stuff in Module.php
     * 
     */  
}

<?php

namespace Application;

/**

* .... all kinds of other stuff

// very important - otherwise OjectManagerAwareInterface will not be recognized and you will NOT see an error

use DoctrineModule\Persistence\ObjectManagerAwareInterface;

class Module

{

public function getFormElementConfig()

{

return array(

'invokables' => array(

'CategoryForm' => 'Application\Form\CategoryForm',

'initializers' => array(

'ObjectManagerInitializer' => function ($element, $formElements) {

// look if the form implements the ObjectManagerAwareInterface

if ($element instanceof ObjectManagerAwareInterface) {

// locate the EntityManager using the serviceLocator

$services = $formElements->getServiceLocator();

$entityManager = $services->get('Doctrine\ORM\EntityManager');

// set the forms EntityManager or Objectmanager, 2 names for the same thing

$element->setObjectManager($entityManager);

}

);

}

/**

* .... other stuff in Module.php

}

What you can see here is that there is a function called getFormElementConfig() which accepts an array. Most important part here are the “initializers”. You can have more than one initializer and the names (in my case ObjectManagerInitializer) can be anything you like. Though it makes sense to chose a speaking name of course.

As soon as you get your form via the FormElementManager (don’t forget to add your FormName to the invokables part of the array) Zf2 recognizes there is some work to be done on getting your new – much cooler – form.

The initializer will check if your form implements the ObjectManagerAwareInterface and if so it will get the entityManager via the serviceLocator and set it using setObjectManager().

One thing that remains to be done is change the form accordingly. Here is the Code:

<?php

namespace Application\Form;

use Zend\Filter\StringTrim;
use Zend\Filter\StripTags;
use Zend\Form\Element;
use Zend\Form\Form;
use Zend\InputFilter\Input;
use Zend\InputFilter\InputFilter;
use Zend\Validator;
use Zend\Validator\NotEmpty;
use Zend\Validator\StringLength;

use DoctrineModule\Persistence\ObjectManagerAwareInterface;
use Doctrine\Common\Persistence\ObjectManager;

class CategoryForm extends Form implements ObjectManagerAwareInterface
{
    /**
     *
     * @var Doctrine\ORM\EntityManager
     */
    private $objectManager;

    /**
     * needs to be set in init(), because constructor won't be aware of objectmanager
     */
    public function init()
    {        
        $this->add(array(
            'name' => 'id',
            'type' => 'Hidden',
        ));

        $name = new Element\Text('name');
        $name->setOptions( array('label' => 'Kategoriebezeichnung'));
        $this->add($name);

        $this->add(array(
                'name' => 'parent',
                'type' => 'DoctrineModule\Form\Element\ObjectSelect',
                'options' => array(
                        'label' => "übergeordnete Kategorie",
                        'empty_option'    => '',
                        'object_manager' => $this->getObjectManager(),
                        'target_class' => 'Application\Entity\Category',
                        'property' => 'name',                   
                ),
        ));

        $this->add(array(
            'name' => 'submit',
            'type' => 'Submit',
            'attributes' => array(
                'value' => 'Go',
                'id' => 'submitbutton',
            ),
        ));

        $this->setInputFilter($this->createInputFilter());
    }

    public function __construct($name = null, $options = array())
    {         
        parent::__construct($name, $options);
    }

    public function createInputFilter()
    {
        $inputFilter = new InputFilter();

        $catFilter = new Input('parent');
        $catFilter->setRequired(false);
        $inputFilter->add($catFilter);

        // name Input
        $nameFilter = new Input('name');
        $nameFilter->setRequired(true);
        $nameFilter->getFilterChain()->attach(new StringTrim());
        $nameFilter->getFilterChain()->attach(new StripTags());
        $inputFilter->add($nameFilter);

        return $inputFilter;
    }

    public function setObjectManager(ObjectManager $objectManager) {
        $this->objectManager = $objectManager;
    }

    /**
     * Get the object manager
     *
     * @return ObjectManager
     */
    public function getObjectManager() {
        return $this->objectManager;
    }

}

100

<?php

namespace Application\Form;

use Zend\Filter\StringTrim;

use Zend\Filter\StripTags;

use Zend\Form\Element;

use Zend\Form\Form;

use Zend\InputFilter\Input;

use Zend\InputFilter\InputFilter;

use Zend\Validator;

use Zend\Validator\NotEmpty;

use Zend\Validator\StringLength;

use DoctrineModule\Persistence\ObjectManagerAwareInterface;

use Doctrine\Common\Persistence\ObjectManager;

class CategoryForm extends Form implements ObjectManagerAwareInterface

{

/**

* @var Doctrine\ORM\EntityManager

private $objectManager;

/**

* needs to be set in init(), because constructor won't be aware of objectmanager

public function init()

{

$this->add(array(

'name' => 'id',

'type' => 'Hidden',

));

$name = new Element\Text('name');

$name->setOptions( array('label' => 'Kategoriebezeichnung'));

$this->add($name);

$this->add(array(

'name' => 'parent',

'type' => 'DoctrineModule\Form\Element\ObjectSelect',

'options' => array(

'label' => "übergeordnete Kategorie",

'empty_option' => '',

'object_manager' => $this->getObjectManager(),

'target_class' => 'Application\Entity\Category',

'property' => 'name',

));

$this->add(array(

'name' => 'submit',

'type' => 'Submit',

'attributes' => array(

'value' => 'Go',

'id' => 'submitbutton',

));

$this->setInputFilter($this->createInputFilter());

}

public function __construct($name = null, $options = array())

{

parent::__construct($name, $options);

}

public function createInputFilter()

{

$inputFilter = new InputFilter();

$catFilter = new Input('parent');

$catFilter->setRequired(false);

$inputFilter->add($catFilter);

// name Input

$nameFilter = new Input('name');

$nameFilter->setRequired(true);

$nameFilter->getFilterChain()->attach(new StringTrim());

$nameFilter->getFilterChain()->attach(new StripTags());

$inputFilter->add($nameFilter);

return $inputFilter;

}

public function setObjectManager(ObjectManager $objectManager) {

$this->objectManager = $objectManager;

}

/**

* Get the object manager

* @return ObjectManager

public function getObjectManager() {

return $this->objectManager;

}

The Form now implements the ObjectManagerAwareInterface – which requires the functions getObjectManager() and setObjectManager(). When creating the formElements you only have to call the getObjectManager() function now and you are done.

Note that you have to add the fields not in __construct but in init() now. At the point of construction the objectManager will not yet be present.

Voilà! Now you can create your form without worrying about creating and injecting anything beforehand! :)

PHPUnit without success / fail message

Inject DoctrineORM EntityManager in ZF2 Form

Hand-ish, not very elegant way of injecting Doctrine EntityManager in Zf2 Form

(Semi)-automated injection of Doctrine EntityManager

Version 1.3 von maxdome-imdb verfügbar

Database under git version control – basic version ;)

Create a new repository