Yii 多页表单向导最佳实践

2022-08-30 17:45:18

我正在尝试用Yii构建一个多页表单,但我对PHP和Yii很陌生,我想知道编写多页表单的最佳实践是什么。到目前为止,我计划做的是添加一个名为“step”的隐藏字段,其中包含用户在表单中的当前步骤(表单分为3个步骤/页面)。因此,考虑到这一点,这就是我计划如何处理用户单击控制器中的上一个/下一个按钮的方式:

public function actionCreate()
 {
  $userModel = new User;

  $data['activityModel'] = $activityModel; 
  $data['userModel'] = $userModel; 

  if (!empty($_POST['step']))
  {
   switch $_POST['step']:
    case '1':
     $this->render('create_step1', $data);
     break;

    case '2':
     $this->render('create_step2', $data);
     break;

  }else
  {
   $this->render('create_step1', $data);
  }
 }

这种方法有意义吗?还是我偏离了基础,在Yii / PHP中有一种更好,更优化的方法可以做到这一点?

谢谢!


答案 1

有几种方法可以解决这个问题。我看到你在Yii论坛上发帖,所以我假设你也在那里搜索过,但如果你还没有:

我所做的是(只是一个简单的2步ActiveRecord表单)采取一个动作,并根据按钮名称将其划分为条件块,Yii POSTT在表单提交(注意:不适用于ajax提交)。然后,根据点击的按钮,我呈现正确的表单,并在模型上设置正确的方案以进行验证。

像您一样的隐藏“步骤”字段可能与检查 submitButton 名称具有相同的用途。我可能会将“步骤”保存到表单状态,而不是添加隐藏字段,但两者都可以。

有些人使用有状态 activeForm 属性来保存向导中单个步骤中的数据,或者您可以使用会话,甚至可以保存到临时数据库表中。在下面我完全未经测试的示例中,我使用的是有状态表单功能。

以下是我基本上为ActiveRecord表单所做的工作的示例。这体现在“actionCreate”中:

<?php if (isset($_POST['cancel'])) {
  $this->redirect(array('home'));
} elseif (isset($_POST['step2'])) {
  $this->setPageState('step1',$_POST['Model']); // save step1 into form state
  $model=new Model('step1');
  $model->attributes = $_POST['Model'];
  if($model->validate())
    $this->render('form2',array('model'=>$model));
  else {
    $this->render('form1',array('model'=>$model));
  }
} elseif (isset($_POST['finish'])) {
  $model=new Model('finish');
  $model->attributes = $this->getPageState('step1',array()); //get the info from step 1
  $model->attributes = $_POST['Model']; // then the info from step2
  if ($model->save())
    $this->redirect(array('home'));
  else {
    $this->render('form2',array('model'=>$model));
} else { // this is the default, first time (step1)
  $model=new Model('new');
  $this->render('form1',array('model'=>$model));
} ?>

表单将如下所示:

形式 1:

<?php $form=$this->beginWidget('CActiveForm', array(
    'enableAjaxValidation'=>false,
    'id'=>'model-form',
    'stateful'=>true,
));
<!-- form1 fields go here -->
echo CHtml::submitButton("Cancel",array('name'=>'cancel');
echo CHtml::submitButton("On to Step 2 >",array('name'=>'step2');
$this->endWidget(); ?>

表格 2:

<?php $form=$this->beginWidget('CActiveForm', array(
    'enableAjaxValidation'=>false,
    'id'=>'model-form',
    'stateful'=>true,
));
<!-- form2 fields go here -->
echo CHtml::submitButton("Back to Step 1",array('name'=>'step1');
echo CHtml::submitButton("Finish",array('name'=>'finish');
$this->endWidget(); ?>

我希望这是有帮助的!


答案 2

Yii提供了一个称为页面状态的功能来实现多步骤/多页表单向导之类的东西。

让我们先来看看 Yii 文档:

页面状态是在同一页面的 POST 请求中持久存在的变量。为了使用持久页面状态,表单必须是有状态的,这些表单是使用 {@link CHtml::statefulForm} 生成的。

因此,每个步骤/页面的形式都需要是有状态的形式。要呈现有状态表单,您只需在启动 ActiveForm 小部件时将属性设置为。在控制器中,您可以使用 或 获取和设置页面状态。CActiveForm::statefultrueCController::getPageState()CController::setPageState()

因此,如果多页窗体向导的实现是在没有 AJAX 请求的情况下以传统样式进行的,则这些是运行良好的基础知识。

但是,如果您想使用AJAX调用来提交步骤数据并显示下一步,Yii的页面状态不可用。

为什么?所有页面状态都通过隐藏输入字段中的 HTTP-POST 传输。输入字段由 Yii 填充,而所谓的输出处理。输出处理在渲染开始,并将替换部分输出。所以 Yii 的页面状态功能需要输出处理。另一方面,AJAX 响应可能会被它损坏,因为输出处理也可能在输出开始时添加或标记以加载所需的 JS 和 CSS 文件。<link><script>

最后,我实现了我自己的有状态表单版本。每次需要时,我都可以通过静态函数调用来获取有状态数据。ActiveFormWidget::getRequestMultiStepData()

注意:我的实现中有一个缺点:在初始化表单小部件之前,需要收集所有有状态数据。但直到现在,我从未遇到过问题。但是,下面是代码:

class ActiveFormWidget extends CActiveForm
{
    public static $inputNameMultiStepData = '_multiStepData';

    public $multiStep = false;
    public $multiStepData = array();

    public function init()
    {
        parent::init();

        # Hidden-Fields
        if ($this->multiStep) {
            echo Html::hiddenField(static::$inputNameMultiStepData, static::encodeInputData($this->multiStepData));
        }
    }

    /**
     * Gets all multi step data sent.
     * @return array|mixed
     */
    public static function getRequestMultiStepData()
    {
        return isset($_REQUEST[static::$inputNameMultiStepData]) ? static::decodeInputData($_REQUEST[static::$inputNameMultiStepData]) : array();
    }


    /**
     * Encodes form data like Yii does for stateful forms.
     * @param $data
     * @return string
     */
    public static function encodeInputData($data)
    {
        $data = Yii::app()->getSecurityManager()->hashData(serialize($data));

        return base64_encode($data);
    }

    /**
     * Decodes form data like Yii does for stateful forms.
     * @param $data
     * @return bool|mixed
     */
    public static function decodeInputData($data)
    {
        $data = base64_decode($data);
        $data = Yii::app()->getSecurityManager()->validateData($data);
        if ($data !== false) {
            return unserialize($data);
        } else {
            return false;
        }
    }
}

推荐