CakePHP 4视图区块间如何正确共享变量？

问题描述 #

我有一个“通用”布局模板，希望在其中定义一组通用表单选项，传递给所有包含待填充区块的专用模板：

<?php

$formOptions = [
    'id' => 'page-content-form',
    'name' => 'page-content-form',
];

echo $this->fetch('h4');

echo $this->fetch('form-start');

echo $this->fetch('form-fields');

我有多个类似下面的专用模板，仅区块细节不同：

<?php

$this->extend('/element/layout/page_content_form');

$this->append('h4');
echo $this->Html->tag('h4', 'Title');
$this->end();

$this->append('form-start');
echo $this->Form->create($pageContent, $formOptions);
$this->end();

$this->append('form-fields');
// 更多代码...
$this->end();

运行后会触发 Undefined variable $formOptions 警告，以及 [TypeError] Bootstrap4\View\Helper\FormHelper::create(): Argument #2 ($options) must be of type array, null given 错误。

我尝试在布局模板中添加 $this->set('formOptions', $formOptions)，但未解决问题。

请问如何在视图的不同区块间正确传递或共享变量？

解决方法 #

在CakePHP中，子模板（专用模板）的执行顺序先于父模板（通用布局模板），这就是为什么你在父模板里set变量后子模板仍无法获取——子模板执行时，父模板的代码还未运行。

以下是几种可行的解决方案：

1. 提前在父模板顶部设置变量 #

修改通用布局模板，把变量设置放在最顶部，确保子模板执行前变量已存在：

<?php
// 先设置共享变量，子模板扩展时可直接访问
$this->set('formOptions', [
    'id' => 'page-content-form',
    'name' => 'page-content-form',
]);

echo $this->fetch('h4');
echo $this->fetch('form-start');
echo $this->fetch('form-fields');

2. 直接赋值给视图的viewVars属性 #

如果第一种方式不适用，可直接将变量注入到视图的共享变量集合中：

<?php
$formOptions = [
    'id' => 'page-content-form',
    'name' => 'page-content-form',
];
// 直接存入viewVars，确保子模板能访问
$this->viewVars['formOptions'] = $formOptions;

echo $this->fetch('h4');
echo $this->fetch('form-start');
echo $this->fetch('form-fields');

3. 封装成视图助手（推荐） #

若这组选项是全局通用的，将其封装为视图助手更便于维护：
创建助手类：

// src/View/Helper/FormOptionsHelper.php
namespace App\View\Helper;

use Cake\View\Helper;

class FormOptionsHelper extends Helper
{
    public function pageContent()
    {
        return [
            'id' => 'page-content-form',
            'name' => 'page-content-form',
        ];
    }
}

在专用模板中使用：

$this->append('form-start');
echo $this->Form->create($pageContent, $this->FormOptions->pageContent());
$this->end();

后续修改选项只需调整助手类，无需逐个修改模板。

内容的提问来源于stack exchange，提问作者mrodo