Form generation with Zend_Form

2010-04-01T01:16:00.000-07:00

Moin, @welt.

Nachdem mir haufenweise Blogs in den verschiedenen Situationen beim Programmieren weitergeholfen haben, hier nun endlich mein eigenes.

Das erste Thema mit dem ich mich gerade beschäftigt habe und ich hier näher erläutern möchte ist die Formulargenerierung mit Zend_Form.

Was brauchen wir?

Das Modul Zend_Form und die Abhängigkeiten aus dem Zend Framework.

Was die Abhängikeiten angeht, so ist es leider ziemlich erschreckend was Zend_Form alles an zusätzlichen Modulen lädt (siehe Code).

Sollte jemand ein besseres Modul zur Formular Erstellung kennen, ich bin für Vorschläge offen ;-).

Los gehts:

FormGenerationInterface.php











interface FormGenerationInterface 
{ 
    /**
     * should return an array
     * that maps objects properties to Zend_Form_Element types
     * @return array
     */ 
    public function getElementTypes(); 
}

Das Interface wird von den Klassen implementiert aus deren Objekten Formulare generiert werden sollen.

Content.php

class Content implements FormGenerationInterface
{
    protected $title = 'testTitle';
    protected $text;
    protected $published;
    protected $elementTypes = array(
        'title' => 'text',
        'text' => 'textarea',
        'published' => 'checkbox',
    );
    public function getElementTypes()
    {
        return $this->elementTypes;
    }
    public function getTitle()
    {
        return $this->title;
    }
    public function getText()
    {
        return $this->text;
    }
    public function isPublished()
    {
        return $this->published;
    }
}

Content ist die Klasse aus deren Objekt ein Formular generiert werden soll.

Wie ihr seht implementiert Content das FormGenerationInterface und hält sich an gewisse Standards was die Getter angeht.

FormFactory.php

class FormFactory
{
    /**
     * @var FormGenerationInterface
     */
    protected $object;
    /**
     * @var Zend_Form
     */
    protected $form;

    /**
     * @param FormGenerationInterface $object
     */
    public function __construct(FormGenerationInterface $object)
    {
        $this->object = $object;
    }

    /**
     * @return Zend_Form
     */
    public function getForm()
    {
        $form = new Zend_Form();

        $this->generateElements($form);

        // add some other things
        $form->setName('generatedForm');

        $submit = new Zend_Form_Element_Submit('submit');
        $form->addElement($submit);

        return $form;
    }

    /**
     * @param Zend_Form $form
     */
    protected function generateElements(Zend_Form $form)
    {
        $elementTypes = $this->object->getElementTypes();

        foreach($elementTypes as $elementName => $elementType) {
            // get element value
            $methodName = $this->getObjectMethodName($elementName, $elementType);
            $elementValue = $this->object->$methodName();

            // set element
            $element = $this->getFormElement($elementType, $elementName);
            $element->setValue($elementValue);

            // add element to form
            $form->addElement($element);
        }
    }

    /**
     * @param string $type
     * @return Zend_Form_Element
     */
    protected function getFormElement($type, $name)
    {
        $elementName = 'Zend_Form_Element_' . ucfirst($type);
        return new $elementName($name);
    }

    /**
     * @param string $name
     * @param string $type
     * @return string
     */
    protected function getObjectMethodName($name, $type)
    {
        switch($type)
        {
            case 'checkbox':
                $methodPraefix = 'is';
                break;
            default:
                $methodPraefix = 'get';
        }

        return $methodPraefix . ucfirst($name);
    }
}

Die FormFactory bekommt als Abhängigkeit ein Object übergeben, aus welchem das Formular generiert werden soll (in diesem Fall das Object der Klasse Content). Per Typehint wird sichergestellt, dass FormGenerationInterface implementiert ist.

Die Methode getForm gibt das fertige Object der Klasse Zend_Form zurück und lädt die Methode generateElements.

generateElements liest Content durch die über getElementTypes geholte Map aus und dekoriert die Instanz von Zend_Form mit den passenden Zend_Form_Element Objekten.

Jetzt zahlt es sich aus, dass wir Content einheitliche Getter Namen gegeben haben da wir jetzt anhand der elementTypes feststellen können welcher Getter Praefix benutzt wird.

Das wars im Groben auch schon, ich hoffe ich konnte hier einige Anregungen geben was einem Zend_Form ermöglicht.

Hier der Code zum Post

schnipseljagd

Form generation with Zend_Form