如何在 Zend Framework 中创建模块化 MVC 组件

Question

我在 Zend Framework 应用程序中创建模块化可重用组件时遇到问题。在本例中，我指的不是 Zend Framework 模块，而是拥有可重用 MVC 小部件的能力（如果您愿意）。我遇到的问题可能对于我的实现来说非常特殊，但如果有人能指出正确的方向，我非常乐意将其扔掉并重新开始。不管怎样，细节和代码有望更好地解释事情，即使我正在做的不是最好的方式，它也应该显示我想要实现的目标：

一个简单的例子是邮件列表注册表单。我想将其包含在使用不同控制器的网站的几个页面上，这在如何处理数据和返回相关消息方面提出了一些问题。我不想执行以下任何操作，因为它们真的很臭：

1. 创建一个带有表单处理的基本控制器并扩展（坏）
2. 在相关控制器中重复表单处理代码（更糟糕！）

我觉得干净的方式要创建新的控制器来处理邮件列表表单数据，请使用视图助手轻松地将表单和相关标记输出到所需页面，然后在处理表单后重定向回发生注册的页面。但是，我想使用 Zend_Form 提供的表单验证，这意味着如果验证失败但在同一请求中，我需要以某种方式将表单对象传递回视图助手。我目前正在通过将其设置为视图上的变量，然后转发回上一页而不是重定向来实现此目的，这是可以的。如果验证正常，那么我更愿意使用重定向回原始页面。不过，我在执行此操作时遇到了困难，因为我想将有关注册状态的消息传递回组件。通常我会使用 FlashMessenger Action Helper，在这种情况下我可以为其命名，这样消息就不会与其他页面数据冲突，但我无法从 View Helper 中访问它。所以目前我也在转发这种情况。我更喜欢重定向，以防止用户刷新页面时重新提交表单并保持 URL 干净。我意识到我本质上希望在页面内有一个迷你 MVC 调度过程，我认为这就是操作堆栈的用途？我对此确实了解不多，如果有任何指点，我将不胜感激。这是我当前的代码：

Controller:

<?php
class MailingListController extends Zend_Controller_Action {

    public function insertAction() {
        $request = $this->getRequest();
        $returnTo = $request->getParam('return_to');

        if(!$request->isPost() || (!isset($returnTo) || empty($returnTo))) {
            $this->_redirect('/');
        }

        $mailingList = new Model_MailingList();
        $form = new Form_MailingList();

        $returnTo = explode('/', $returnTo);

        if($form->isValid($_POST)) {
            $emailAddress = $form->getValue('email_address');

            $mailingList->addEmailAddress($emailAddress);

            $this->view->mailingListMessages = $mailingList->getMessages();
            $this->view->mailingListForm = "";
        }
        else {
            $this->view->mailingListForm = $form;
        }

        $this->_forward($returnTo[2], $returnTo[1], $returnTo[0]);
    }
}

return_to 是一个包含当前 URI（模块/控制器/操作）的字符串，它是在视图助手中生成的。我更喜欢在 $form->isValid($_POST) 块内重定向。

View Helper：

<?php
class Zend_View_Helper_MailingList extends Zend_View_Helper_Abstract {

    public function mailingList($form, $messages = "") {
        if(!isset($form)) {
            $request = Zend_Controller_Front::getInstance()->getRequest();
            $currentPage = $request->getModuleName() . '/' . $request->getControllerName() . '/' . $request->getActionName();

            $form = new Form_MailingList();
            $form->setAction('/mailing-list/insert');
            $form->setCurrentPage($currentPage);
        }

        $html = '<div class="mailingList"><h2>Join Our Mailing List</h2>' . $form;
        $html .= $messages;
        $html .= '</div>';

        return $html;
    }

}

在 View Helper 中获取 Front Controller 的实例并不理想，但我更愿意尽可能封装。

如果我有一个验证失败的表单对象，我可以将其传递回帮助器以输出错误消息。如果我有一些消息要渲染，我也可以将它们传递给助手。

在我的视图脚本中，我使用如下帮助程序：

<?=$this->mailingList($this->mailingListForm, $this->mailingListMessages);?>

如果 MailingListController 未在视图上设置 mailingListForm 或 mailingListMessages，它将输出一个没有消息的新表单。

非常感谢任何帮助！

Answer 1

使用ajax似乎是一种最佳方式。 View Action Helper 仅用于首次加载邮件表单。

控制器

class MailingListController extends Zend_Controller_Action {

public function insertAction() {
    $request = $this->getRequest();

    $form = new Form_MailingList();

    if ($request->isPost()) {
        if ($form->isValid($request->getPost())) {
            $mailingList = new Model_MailingList();
            $emailAddress = $form->getValue('email_address');
            $mailingList->addEmailAddress($emailAddress);
            $form = $mailingList->getMessages();
        }
    }

    $this->view->form = $form;
}

}

视图脚本 insert.phtml

<?php echo $this->form; ?>

表单类

class Form_MailingList extends Zend_Form {

public function init() {
    //among other things
    $this->setAttrib('id', 'mailing-list-form');
    $this->setAction('/mailing-list/insert');
}

}

视图助手

class Zend_View_Helper_MailingList extends Zend_View_Helper_Abstract {

public function mailingList() {
    $this->view->headScript()->appendFile('/js/mailing-list.js');
    return '<div id="mailing-list-wrap">' . $this->view->action('insert', 'mailing-list') . '</div>';
}

}

JS文件邮件列表.js

$(document).ready(function() {
    $('#mailing-list-form').submit(function() {
        var formAction = $(this).attr('action');
        var formData = $(this).serialize();

        $.post(formAction, formData, function(data) {
            //response going in form's parent container
            $(this).parent().html(data);
        });

        return false;
    });
});

Answer 2

我认为你的做法与我的做法非常接近。如果你抛开想要在页面中显示 Zend_Form 错误消息的要求，那么你要做的是：

• 视图助手只显示表单（它不需要将表单对象或消息作为参数）
• 表单像现在一样提交到您的其他控制器
• 邮件列表控制器在成功时重定向（而不是转发）回返回 URL
• 邮件列表控制器自行重新显示表单，并在失败时显示错误

这使一切变得更加简单，唯一问题是如果如果出现任何验证错误，用户就会失去上下文，并得到一个带有表单的普通旧页面，而不是原来的位置。然后，您可以通过更改提交方式来解决此问题（现在或以后）。相反，Ajax，并通过渲染错误。 JS。但这将是一项相当大的工作量。

Answer 3

好的，我已经想出了一个令我感到高兴的解决方案，并解决了我面临的一些问题。希望这可以帮助面临类似问题的人。现在唯一的缺点是我在视图助手中引用模型。我知道这不是松散耦合，但我之前已经见过几次这样做了，甚至在 ZF 文档作为避免使用“操作”视图助手的方法（这将创建新的 MVC 调度循环）。总的来说，我认为 DRYness 和封装是值得的，可能还有其他合适的术语。

为了能够使用从我的 MailingListController 返回的重定向，但维护来自我的模型的消息和任何表单验证错误，我需要将它们存储在会话中。对于消息，我通常使用 FlashMessenger 操作帮助程序，但由于在视图帮助程序中获取它不是最佳实践，它不会处理我的表单错误，它真正做的只是将内容保存到会话中，无论如何这是不必要的。我可以在 Model_MailingList 中实现我自己的会话存储，我也可以将其用于表单错误。然后，我可以在重定向后使用错误重新填充表单并打印出任何相关消息。不管怎样，代码如下：

控制器：

<?php

class MailingListController extends Zend_Controller_Action {

    public function insertAction() {
        $request = $this->getRequest();
        $returnTo = $request->getParam('return_to');

        if(!$request->isPost() || (!isset($returnTo) || empty($returnTo))) {
            $this->_redirect('/');
        }

        $mailingList = new Model_MailingList();
        $form = new Form_MailingList();

        if($form->isValid($_POST)) {
            $emailAddress = $form->getValue('email_address');
            $mailingList->addEmailAddress($emailAddress);
        }
        else {
            $mailingList->setFormErrors($form->getMessages());
        }

        $redirect = rtrim($request->getBaseUrl(), '/') . $returnTo;
        $this->_redirect($redirect);
    }
}

我已经向我的 Model_MailingList 类添加了一个方法； setFormErrors($errors) 如果验证失败，我会从表单传递错误消息。这会将错误数组保存到会话中。

我通常使用具有 addMessage 和 getMessages 方法的基模型类。它们仅访问受保护的消息数组。在我的 Model_MailingList 中，我重写这些方法以将消息存储在会话中。在 addEmailAddress($emailAddress) 方法中，我已经调用 addMessage 来说明将电子邮件地址插入数据库是否已成功。

模型：

<?php

class Model_MailingList extends Thinkjam_Model_DbAbstract {

    private $_session;

    public function __construct() {
        $this->_session = new Zend_Session_Namespace(__CLASS__);
    }

    public function setFormErrors($errors) {
        $this->_session->formErrors = $errors;
    }

    public function getFormErrors() {
        $errors = array();

        if(isset($this->_session->formErrors)) {
            $errors = $this->_session->formErrors;
            unset($this->_session->formErrors);
        }

        return $errors;
    }

    // override addMessage and getMessages

    protected function addMessage($message) {
        if(!isset($this->_session->messages)) {
            $this->_session->messages = array();
        }
        $this->_session->messages[] = $message;
    }

    public function getMessages() {
        if(isset($this->_session->messages)) {
            $this->_messages = $this->_session->messages;
            unset($this->_session->messages);
        }

        return $this->_messages;
    }

    …

    public function addEmailAddress($emailAddress) {
        ...

        // I call this if db insert was successful: 
        $this->addMessage("Thank you. You have been successfully added to the mailing list.")
    }
}

我现在不需要将任何参数传递给视图助手，因为它可以直接从模型查询其状态。 $this->view->messenger 只是另一个将数组转换为无序列表的视图助手。

View Helper：

<?php

class Zend_View_Helper_MailingList extends Zend_View_Helper_Abstract {

    private $_mailingList;

    public function MailingList() {
        $this->_mailingList = new Model_MailingList();
        return $this;
    }

    public function getForm() {
        $request = Zend_Controller_Front::getInstance()->getRequest();
        $currentPage = '/' . $request->getModuleName() . '/' . $request->getControllerName() . '/' . $request->getActionName();

        $form = new Form_MailingList();
        $form->setAction('/mailing-list/insert');
        $form->setCurrentPage($currentPage);
        $form->setErrors($this->_mailingList->getFormErrors());

        $html = '<div class="mailingList"><h2>Join Our Mailing List</h2>' . $form;
        $html .= $this->view->messenger($this->_mailingList->getMessages());
        $html .= '</div>';

        return $html;
    }

}

然后在 Form_MailingList 类中，我只需要添加一个附加方法来重新填充错误消息。虽然 getMessages() 是 Zend_Form 的一个方法，但似乎没有任何相应的 setMessages()。不过，您可以在 Zend_Form_Element 上执行此操作，因此我将以下函数添加到 Form_MailingList 类中：

表单：

<?php

class Form_MailingList extends Thinkjam_Form_Abstract {

    ...

    public function setErrors(array $errors) {
        foreach($errors as $key => $value) {
            $this->getElement($key)->setErrors($value);
        }
    }

}

我现在可以使用 MailingList 视图帮助程序在站点的任何页面上添加注册表单：

<?=$this->MailingList()->getForm();?>

我意识到很多问题我面临的是一系列非常具体的情况，但希望这可以以某种方式帮助其他人！

干杯，
亚历克斯