CakePHP 3 多语言行为：解决非默认语言保存导致原始实体为空的问题

在使用 cakephp 3 的 `translatebehavior` 时，当用户在非默认语言环境下创建实体，可能会导致默认语言对应的实体字段为空。这会造成 cms 中出现“幽灵”实体，影响数据完整性。本文将介绍如何通过自定义 `translatebehavior`，重写 `aftersave` 事件，在保存非默认语言翻译后，自动填充默认语言实体中为空的字段，从而确保多语言数据的一致性。

CakePHP 3 多语言行为的常见问题

CakePHP 3 的 TranslateBehavior 提供了强大的多语言支持，允许为模型中的特定字段存储多种语言的翻译。然而，一个常见的问题是，当网站的当前语言不是默认语言时，如果此时创建一个新的实体并保存，那么默认语言对应的实体记录中的翻译字段可能会保持为空。例如，如果默认语言是英语，当前语言是法语，当用户在法语环境下创建一个产品实体时，该产品的英语名称、描述等字段在数据库中会是 NULL。这在内容管理系统中会造成困扰，因为开发者会看到许多“空”的默认语言实体，影响数据管理和显示。

自定义 TranslateBehavior 解决方案

为了解决上述问题，我们可以通过扩展 CakePHP 3 默认的 TranslateBehavior，并重写其 afterSave 事件。在 afterSave 事件中，我们检查当前保存的实体是否为非默认语言的翻译。如果是，并且默认语言的对应字段为空，我们就将当前语言的翻译内容填充到默认语言的实体中。

实现细节：afterSave 方法详解

首先，创建一个自定义的 TranslateBehavior 类，例如 App\Model\Behavior\TranslateBehavior.php，并让它继承 Cake\ORM\Behavior\TranslateBehavior：

<?php
namespace App\Model\Behavior;

use Cake\Datasource\EntityInterface;
use Cake\Event\Event;
use Cake\I18n\I18n;
use Cake\ORM\Behavior\TranslateBehavior as BaseTranslateBehavior;
use Cake\ORM\TableRegistry;

/**
 * 自定义 Translate 行为
 * 目的：在非默认语言下保存实体时，如果默认语言实体字段为空，则用当前翻译填充。
 */
class TranslateBehavior extends BaseTranslateBehavior
{
    /**
     * 在保存后填充原始（未翻译）实体，如果原始字段严格为 null。
     *
     * @param Event $event            触发的 afterSave 事件
     * @param EntityInterface $entity 已翻译的实体
     * @return void
     */
    public function afterSave(Event $event, EntityInterface $entity)
    {
        // 调用父类的 afterSave 方法，确保默认的多语言逻辑被执行
        parent::afterSave($event, $entity);

        $defaultLocale = I18n::getDefaultLocale(); // 获取默认语言环境
        $currentLocale = I18n::getLocale();        // 获取当前语言环境

        // 如果当前语言环境就是默认语言环境，则无需特殊处理，直接返回
        if ($currentLocale === $defaultLocale) {
            return;
        }

        // 获取原始实体对应的 Table 对象
        $table = TableRegistry::getTableLocator()->get($entity->getSource());
        // 临时将 Table 的语言环境设置为默认语言，以便获取默认语言的实体
        $table->setLocale($defaultLocale);

        // 根据实体的主键获取默认语言的原始实体
        $originalEntity = $table->get($entity->{$table->getPrimaryKey()});

        // 遍历行为配置中定义的可翻译字段
        $fields = $this->_config['fields'];
        foreach ($fields as $field) {
            // 如果原始实体的该字段严格为 null，则用当前翻译的字段值填充
            if ($originalEntity->{$field} === null) {
                $originalEntity->{$field} = $entity->{$field};
            }
        }

        // 临时移除 Table 上的 Translate 行为，防止在保存 originalEntity 时触发递归
        // 因为 originalEntity 的保存也会再次触发 afterSave 事件
        $table->removeBehavior('Translate');

        // 保存更新后的原始实体
        $table->save($originalEntity);

        // 重新添加 Translate 行为，并使用之前的配置
        $table->addBehavior('Translate', $this->_config);

        // 将 Table 的语言环境设置回当前语言
        $table->setLocale($currentLocale);
    }
}

代码解析：

立即学习“PHP免费学习笔记（深入）”；

360智图

AI驱动的图片版权查询平台

143

查看详情

1. parent::afterSave($event, $entity);: 确保父类的 afterSave 逻辑被执行，这是 CakePHP TranslateBehavior 正常工作的基础。
2. 语言环境检查: 获取默认语言 ($defaultLocale) 和当前语言 ($currentLocale)。如果当前语言就是默认语言，则无需进行后续的填充操作，直接返回。
3. 获取默认语言实体:
   • 通过 TableRegistry::getTableLocator()->get($entity->getSource()) 获取当前实体所属的 Table 对象。
   • 关键步骤: \$table->setLocale($defaultLocale); 将 Table 的语言环境临时设置为默认语言。这是为了确保我们能够获取到对应默认语言的实体数据。
   • \$table->get($entity->{$table->getPrimaryKey()}); 根据当前实体的主键，获取到默认语言对应的实体。
4. 填充空字段:
   • 遍历 _config['fields'] 中定义的所有可翻译字段。
   • 对于每个字段，如果 \$originalEntity->{$field} 严格为 null，则将当前保存的 \$entity->{$field} 值赋给它。这样就实现了在默认语言字段为空时，用当前翻译内容进行填充。
5. 防止递归保存:
   • \$table->removeBehavior('Translate');：这是非常关键的一步！ 在保存 \$originalEntity 时，如果 TranslateBehavior 仍然附加在 Table 上，那么 \$table->save($originalEntity) 操作会再次触发 afterSave 事件，导致无限递归。因此，在保存 \$originalEntity 之前必须暂时移除它。
   • \$table->save($originalEntity);：保存更新后的默认语言实体。
   • \$table->addBehavior('Translate', $this->_config);：保存完成后，重新添加 TranslateBehavior，并恢复其配置。
6. 恢复语言环境: \$table->setLocale($currentLocale); 将 Table 的语言环境设置回最初的当前语言，以避免影响后续操作。

行为的集成与配置

要使用这个自定义的 TranslateBehavior，你需要在你的 Table 类中加载它，替换掉默认的 TranslateBehavior。

例如，在你的 App\Model\Table\ArticlesTable.php 中：

// src/Model/Table/ArticlesTable.php
namespace App\Model\Table;

use Cake\ORM\Table;

class ArticlesTable extends Table
{
    public function initialize(array $config): void
    {
        parent::initialize($config);

        $this->setTable('articles');
        $this->setDisplayField('title');
        $this->setPrimaryKey('id');

        // 加载自定义的 TranslateBehavior
        // 替换掉默认的 'Translate'
        $this->addBehavior('App\Model\Behavior\Translate', [
            'fields' => ['title', 'body'], // 指定需要翻译的字段
            // 其他 TranslateBehavior 配置...
        ]);

        // ... 其他行为和关联
    }
}

请确保在 addBehavior 中指定了 fields 选项，列出所有需要进行多语言翻译的字段，这些字段将在 afterSave 方法中被遍历和检查。

重要考量与最佳实践

• null 值语义: 此解决方案假定默认语言中的 null 值意味着“未设置”或“需要填充”。如果你的业务逻辑中，默认语言字段的 null 值具有特定含义（例如，表示该字段确实没有值，不应被翻译内容覆盖），则需要调整 if ($originalEntity->{$field} === null) 的判断逻辑，或者考虑更复杂的业务规则。
• 性能影响: 在每次非默认语言的实体保存操作后，都会额外执行一次获取默认语言实体和一次保存操作。对于高并发写入的系统，这可能会带来轻微的性能开销，但对于大多数 CMS 应用来说，这种开销通常可以接受。
• 数据一致性: 这个解决方案极大地提高了多语言数据的一致性，避免了因语言环境切换而产生的“空实体”问题，使得 CMS 管理员能够更清晰地管理内容。
• 版本兼容性: 本教程基于 CakePHP 3。在 CakePHP 4 或更高版本中，核心 API 可能有所变化，但基本思路（扩展行为、重写事件、处理语言环境和防止递归）仍然适用。

通过实现这个自定义的 TranslateBehavior，你可以有效解决 CakePHP 3 在非默认语言环境下保存实体时，默认语言实体字段为空的问题，从而构建一个更加健壮和用户友好的多语言应用程序。

以上就是CakePHP 3 多语言行为：解决非默认语言保存导致原始实体为空的问题的详细内容，更多请关注php中文网其它相关文章！