Zend Framework 2表单元素错误类+自定义ViewHelper来呈现表单

时间:2013-12-29 21:37:45

标签: forms zend-framework2 custom-component viewhelper

这是我本周的第三个问题(总体而言) - 希望我不会在这里被禁止:D 无论如何,搜索周围,找不到解决我的问题的确切解释。

一个。我搜索过并找到了一个自定义的ViewHelper来渲染我的表单。它的作用是递归获取所有的字段集,当它到达元素级别时,它是这样的:

    public function renderElement($element) {
        $html = '
            <div class="row">' . 
            '<label class="col-md-12" for="' . $element->getAttribute('id') . '">' . $element->getLabel() . '</label>' . 
            $this->view->formElement($element) . 
            $this->view->FormElementErrors($element) .
            '<div class="clearfix" style="height: 15px;"></div>';

        return $html . PHP_EOL;
    }

表单呈现正常,但以下情况除外: 1)如何向表单元素添加错误类? (就像我在视图中使用formRow帮助器一样,它会自动广告'输入错误'类,同时在创建元素时保持我的fieldset中指定的初始类 - 'attributes'=&gt; array('class'=&gt ;'some-class')),所以元素的class属性在它无效的情况下变成“some-class input-error”。 2)如何为包含错误消息的'ul'设置一个类(由$ this-&gt; view-&gt; formElementErrors($ element)呈现的'ul')?希望这是一个单行,我不必逐条消息并为错误消息列表编写html,但如果不是这样的话(我不知道该怎么做)。< / p>

B中。假设有时我不使用此自定义ViewHelper来呈现我的表单。 Zend的formRow视图助手有时会很方便。这让我想到了以下代码:

    echo $this->formRow($this->form->get('user_fieldset')->get('user_name'));

我注意到这会在我的元素上自动添加'input-error'类(如果它无效),这是完美的,但我怎么能告诉formRow给'ul'一个类显示错误消息?

我会更进一步,问我怎么能这样做:

    echo $this->formLabel($this->form->get('user_fieldset')->get('user_name'));
    echo $this->formInput($this->form->get('user_fieldset')->get('user_name'));
    echo $this->formElementErrors($this->form->get('user_fieldset')->get('user_name'), array('class' => 'form-validation-error'));

也会向元素发布错误类,而不仅仅是错误消息列表,但如果有人回答了A点,我认为这是同一个问题。

2 个答案:

答案 0 :(得分:4)

我设法这样做了:

public function renderElement($element) {
    // FORM ROW
    $html = '<div class="form-group">';

    // LABEL
    $html .= '<label class="form-label" for="' . $element->getAttribute('id') . '">' . $element->getLabel() . '</label>';

    // ELEMENT
    /*
     - Check if element has error messages
     - If it does, add my error-class to the element's existing one(s),
       to style the element differently on error
    */
    if (count($element->getMessages()) > 0) {
        $classAttribute = ($element->hasAttribute('class') ? $element->getAttribute('class') . ' ' : '');
        $classAttribute .= 'input-error';
        /* 
         * Normally, here I would have added a space in my string (' input-error')
         * Logically, I would figure that if the element already has a class "cls"
         * and I would do $element->getAttribute('class') . 'another-class'
         * then the class attribute would become "clsanother-class"
         * BUT it seems that, even if I don't intentionally add a space in my string,
         * I still get "cls another-class" as the resulted concatenated string
         * I assume that when building the form, ZF2 automatically
         * adds spaces after attributes values? so you/it won't have to
         * consider that later, when you'd eventually need to add another
         * value to an attribute?
         */
        $element->setAttribute('class', $classAttribute);
    }
    $html .= $this->view->formElement($element);
    /*
     * Of course, you could decide/need to do things differently,
     * depending on the element's type

       switch ($element->getAttribute('type')) {
           case 'text':
           case 'email': {

               break;
           }
           default: {

           }
       }
     */
    // ERROR MESSAGES
    // Custom class (.form-validation-error) for the default html wrapper - <ul>
    $html .= $this->view->FormElementErrors($element, array('class' => 'form-validation-error'));

    $html .= '</div>'; # /.form-group
    $html .= '<div class="clearfix" style="height: 15px;"></div>';

    return $html . PHP_EOL;
}

我不喜欢这个,但我想没有更短的方法。我认为ZF2应该有类似的东西:

if ($element->hasErrors()) { $element->addClass('some-class'); }

开箱即用。这就是我所期望的答案,它只是一种我错过/无法找到的方法。但事实证明,ZF2在整个世界中没有任何东西,你可能需要开箱即用,你最终不得不写(或多或少)偶尔的帮手。

无论如何,如果有人需要它,那么这是整个RenderForm视图助手:

namespace User\View\Helper;

use Zend\View\Helper\AbstractHelper;

class RenderForm extends AbstractHelper {

    public function __invoke($form) {
        $form->prepare();
        $html = $this->view->form()->openTag($form) . PHP_EOL;
        $html .= $this->renderFieldsets($form->getFieldsets());
        $html .= $this->renderElements($form->getElements());
        $html .= $this->view->form()->closeTag($form) . PHP_EOL;
        return $html;
    }

    public function renderFieldsets($fieldsets) {

        foreach ($fieldsets as $fieldset) {
            if (count($fieldset->getFieldsets()) > 0) {
                $html = $this->renderFieldsets($fieldset->getFieldsets());
            } else {
                $html = '<fieldset>';
                    // You can use fieldset's name for the legend (if that's not inappropriate)
                    $html .= '<legend>' . ucfirst($fieldset->getName()) . '</legend>';
                    // or it's label (if you had set one)
                    // $html .= '<legend>' . ucfirst($fieldset->getLabel()) . '</legend>';
                    $html .= $this->renderElements($fieldset->getElements());
                $html .= '</fieldset>';
                // I actually never use the <fieldset> html tag.
                // Feel free to use anything you like, if you do have to
                // make grouping certain elements stand out to the user
            }
        }

        return $html;
    }

    public function renderElements($elements) {
        $html = '';
        foreach ($elements as $element) {
            $html .= $this->renderElement($element);
        }
        return $html;
    }

    public function renderElement($element) {
        // FORM ROW
        $html = '<div class="form-group">';

        // LABEL
        $html .= '<label class="form-label" for="' . $element->getAttribute('id') . '">' . $element->getLabel() . '</label>'; # add translation here

        // ELEMENT
        /*
         - Check if element has error messages
         - If it does, add my error-class to the element's existing one(s),
           to style the element differently on error
        */
        if (count($element->getMessages()) > 0) {
            $classAttribute = ($element->hasAttribute('class') ? $element->getAttribute('class') . ' ' : '');
            $classAttribute .= 'input-error';

            $element->setAttribute('class', $classAttribute);
        }
        $html .= $this->view->formElement($element);

        // ERROR MESSAGES
        $html .= $this->view->FormElementErrors($element, array('class' => 'form-validation-error'));


        $html .= '</div>'; # /.row
        $html .= '<div class="clearfix" style="height: 15px;"></div>';

        return $html . PHP_EOL;
    }

}

用户是我的模块。我在它的配置文件夹中创建了一个'viewhelper.config.php':

return array(
    'invokables' => array(
        'renderForm' => 'User\View\Helper\RenderForm',
    ),
);

并在Module.php中:

public function getViewHelperConfig() {
    return include __DIR__ . '/config/viewhelper.config.php';
}

然后,在您的视图中,只需致电:

$this->renderForm($form);

当然,如果你没有很多视图帮助器,你就无法为此创建一个单独的配置文件,只需单独添加Module.php并添加:

'view_helpers' => array(
    'invokables' => array(
        'renderForm' => 'User\View\Helper\RenderForm',
    ),
),

到任何配置文件。

答案 1 :(得分:2)

我使用getMessages()方法检查元素是否有验证消息。例如。

<div class="form-group <?=($this->form->get('user_fieldset')->get('user_name')->getMessages())?'has-error':'';?>">
    ...
</div>

这个问题似乎很老了,你必须自己解决。 :)