Silverstripe 子页面重排后自动发布实现指南

本教程详细介绍了如何在 Silverstripe CMS 中实现子页面重排后自动发布的功能。针对默认行为下子页面排序变动仅标记为“已修改”而非自动发布的问题，我们将通过重写 onBeforeWrite 和 onAfterWrite 方法，精确检测 Sort 字段变化，并智能判断页面原有发布状态，从而确保已发布页面在位置调整后能自动同步更新。

问题背景与需求分析

在 silverstripe cms 中，当内容管理者通过拖放操作对子页面进行重新排序时，系统会更新这些页面的 sort 字段，以反映其新的位置。然而，默认情况下，这些页面并不会自动发布到 live 阶段。相反，它们会被标记为“已修改”（modified），需要用户手动点击“发布”按钮才能使排序变更在前端生效。对于频繁进行页面排序的网站，这无疑增加了内容管理者的工作量，降低了操作效率。因此，实现子页面重排后自动发布，是提升 silverstripe cms 用户体验的关键需求。

核心解决方案思路

要实现这一自动化功能，我们需要利用 Silverstripe CMS 的数据对象生命周期钩子（DataObject Lifecycle Hooks），特别是 onBeforeWrite() 和 onAfterWrite() 方法。

1. 在 onBeforeWrite() 中捕获页面状态： 在页面数据被写入数据库之前，我们需要确定该页面是否已经处于发布状态（即在 Live 阶段有对应的版本）。这一步至关重要，它可以防止我们意外地自动发布尚未准备好上线的草稿页面。
2. 在 onAfterWrite() 中检测并触发发布： 在页面数据成功写入数据库之后，我们检查两个条件：
   • Sort 字段是否发生了变化？（这表明页面位置被调整）
   • 页面在写入操作之前是否已经发布？（使用 onBeforeWrite() 中捕获的状态） 如果这两个条件都满足，那么我们就触发页面的发布操作，将其最新状态（包括新的排序）同步到 Live 阶段。

实现步骤与示例代码

您需要创建一个继承自 Page 的自定义页面类型（例如 FooPage），并在其中重写 onBeforeWrite() 和 onAfterWrite() 方法。如果您希望将此功能应用于所有页面，可以考虑使用 Extension。

<?php

use SilverStripe\CMS\Model\SiteTree;
use SilverStripe\Versioned\Versioned;

/**
 * FooPage 示例：演示如何在子页面重排后自动发布。
 * 您可以将其应用于任何需要此功能的 Page 类型。
 */
class FooPage extends Page
{
    /**
     * 用于存储在写入操作之前页面的发布状态。
     * 如果页面在写入前已发布且不是草稿独有或已归档，则为 true。
     *
     * @var bool
     */
    private $wasPublishedBeforeWrite = false;

    /**
     * 在数据写入数据库之前执行。
     * 用于在保存操作发生前捕获页面的发布状态。
     */
    protected function onBeforeWrite()
    {
        parent::onBeforeWrite();

        // 检查页面在当前写入操作之前是否已发布。
        // 以下条件确保我们只考虑那些已经在 Live 阶段存在，
        // 且不是草稿独有或已归档，并且其 Live 版本与 Stage 版本一致的页面。
        $this->wasPublishedBeforeWrite = !$this->isArchived() && !$this->isOnDraftOnly() && !$this->isModifiedOnDraft();
    }

    /**
     * 在数据写入数据库之后执行。
     * 用于检测 Sort 字段是否变化，并根据预存的发布状态决定是否自动发布。
     */
    protected function onAfterWrite()
    {
        parent::onAfterWrite();

        // 检查 Sort 字段是否发生变化，并且页面在写入操作之前已处于发布状态。
        // 只有当页面位置被调整且页面之前已发布时，才执行自动发布。
        if ($this->isChanged('Sort') && $this->wasPublishedBeforeWrite) {
            // 在 Silverstripe 4/5 中，`publish()` 方法用于将当前页面发布到 Live 阶段。
            // 对于 Silverstripe 3，对应的方法是 `doPublish()`。
            $this->publish();
        }
    }
}

代码解析

• private $wasPublishedBeforeWrite = false;:

  • 这是一个私有成员变量，用于在 onBeforeWrite 钩子中临时存储页面在当前写入操作前的发布状态。其默认值为 false。

• protected function onBeforeWrite():

  

  Zapier Agents

  Zapier推出的Agents智能体，集成7000+应用程序

  42

  查看详情
  • parent::onBeforeWrite();: 调用父类的 onBeforeWrite 方法，确保所有继承的逻辑都能正常执行。
  • $this-youjiankuohaophpcnwasPublishedBeforeWrite = !$this->isArchived() && !$this->isOnDraftOnly() && !$this->isModifiedOnDraft();: 这是判断页面在写入前是否已发布的核心逻辑。
    • !$this->isArchived(): 检查页面是否未被归档。归档的页面不应被视为已发布并自动更新。
    • !$this->isOnDraftOnly(): 检查页面是否不是仅存在于草稿阶段。如果一个页面从未发布过，它就是“草稿独有”。我们不希望自动发布这些尚未上线的草稿。
    • !$this->isModifiedOnDraft(): 检查页面在草稿阶段是否有未发布的修改。如果一个已发布的页面在草稿阶段有新的、未发布的修改，此方法会返回 true。通过取反，我们确保 wasPublishedBeforeWrite 仅在页面在 Live 阶段处于最新状态（或者至少没有未发布的草稿修改）时才为 true。结合前两个条件，这有效地筛选出那些在写入前已经发布且其 Live 版本是最新或期望更新的页面。

• protected function onAfterWrite():

  • parent::onAfterWrite();: 调用父类的 onAfterWrite 方法。
  • if ($this->isChanged('Sort') && $this->wasPublishedBeforeWrite): 这是触发自动发布的核心条件判断。
    • $this->isChanged('Sort'): 这是一个非常实用的方法，它检查指定字段（此处为 Sort）的值在当前写入操作中是否发生了变化。当页面通过拖放重新排序时，此字段的值会更新，从而使此条件为 true。
    • $this->wasPublishedBeforeWrite: 使用在 onBeforeWrite 中捕获的页面发布状态。只有当页面位置被调整，并且页面在本次修改之前已经处于发布状态时，才执行自动发布。这有效避免了将草稿页面自动发布到 Live 阶段。
  • $this->publish();: 这是 Silverstripe 4/5 中用于将当前页面从草稿阶段发布到 Live 阶段的标准方法。它确保了页面在 CMS 中的更改（包括排序）同步到公共网站，从而实现自动发布。

注意事项

• 页面类型适用性: 上述代码应应用于您希望实现自动发布功能的特定页面类型。如果您有多种页面类型需要此行为，可以考虑创建一个 DataExtension，并将其应用于多个页面类型，以避免代码重复和提高可维护性。
• 发布范围: publish() 方法仅发布当前页面。如果您希望在重排父页面时自动发布其所有子页面（这通常不是排序单个子页面的场景），您可能需要考虑使用 publishRecursive()。但对于单个子页面的排序，publish() 是更精确且效率更高的选择。
• 性能考量: 对于拥有大量子页面的父页面，每次排序操作都会触发一次 publish()。通常情况下，publish() 操作是高效的，不会造成显著的性能问题。但如果您的系统负载极高或数据库操作频繁，建议进行性能测试以确保其表现符合预期。
• 用户体验: 确保这种自动发布行为符合内容管理者的预期。在某些特定场景下，用户可能希望在排序后进行进一步修改，然后再手动发布。然而，对于简单的排序操作，自动发布通常能显著提升效率。
• 调试: 如果自动发布未能按预期工作，请检查 Silverstripe 日志和服务器错误日志。您也可以在 onBeforeWrite 和 onAfterWrite 中添加 SS_Log::log() 或 error_log() 语句来跟踪变量值和执行流程，帮助定位问题。

总结

通过在自定义页面类型中巧妙地利用 onBeforeWrite 和 onAfterWrite 钩子，并结合对页面发布状态和 Sort 字段变化的精确判断，我们成功实现了 Silverstripe 子页面在重排后自动发布的功能。这一解决方案不仅提升了内容管理效率，减少了手动操作，还通过智能判断确保了只有已发布的页面才会被自动更新，避免了意外发布草稿页面的风险，从而优化了 Silverstripe CMS 的用户体验。

以上就是Silverstripe 子页面重排后自动发布实现指南的详细内容，更多请关注php中文网其它相关文章！

相关标签：

php 前端 cms 性能测试 silver if sort 成员变量 父类 继承 private protected function 对象 this 数据库 自动化 cms