7

我一直在关注 GUI 扩展并注意示例使用_isEnabledor isEnabled,不带下划线。两者似乎都可以扩展或可能替换现有功能。

已启用

例如,PowerTools 基类(似乎没有“扩展”现有功能)具有:

PowerTools.BaseCommand.prototype.isEnabled = function(selection, pipeline)
{
    var p = this.properties;

    if (!p.initialized)
    {
        this.initialize();
    }

    if (!this.isToolConfigured())
    {
        return false;
    }

    if (this.isValidSelection)
    {
        return this.isValidSelection(selection, pipeline);
    }

    return true;
};

工具可以使用此基类并声明 .isValidSelection,例如:

PowerTools.Commands.CountItems.prototype.isValidSelection = 
                                       function (selection) { ... }

_isEnabled

我看到安圭拉使用._isEnabled现有功能(在代码中许多地方的 Chrome 控制台中)。例如,WhereUsed有:

Tridion.Cme.Commands.WhereUsed.prototype._isAvailable =
                      function WhereUsed$_isAvailable(selection) ...

私人功能?

我熟悉前面的下划线是私有变量的命名约定。_isEnabled 和其他以下划线开头的函数是“私有的”吗?如果是这样,那么

  • 我们应该如何扩展(向现有代码添加附加功能)这些功能?
  • 我们应该如何替换(不运行现有代码,而是让我们的代码像“覆盖”一样运行)这些?

我假设相同的方法适用于以下划线开头的其他函数,例如_isAvailable, 和_invoke.

4

1 回答 1

8

为命令调用以下方法:

  1. 可用
  2. 已启用
  3. 调用

所有命令的基类 - Tridion.Core.Command - 具有这些方法的标准实现。在大多数情况下,此默认实现允许对命令进行扩展。它们还调用下划线方法(_isAvailable、_isEnabled 和 _execute)。

我不知道为什么 CME 命令只覆盖下划线方法。也许有人认为这样更容易。它们应该被认为是私有的(或相当于 C# 中的“受保护”),所以这对我来说实际上似乎是一种不好的做法。

实现适当的方法(isAvailable、isEnabled 和 invoke)然后使用 this.callBase 调用基本实现会更简洁。但是,在这种情况下,您可能需要停止管道,或者还需要覆盖下划线方法,以避免您的返回值被默认的下划线方法覆盖。这取决于您正在实施或扩展的命令。

简而言之:使用下划线方法可能是不好的做法,但核心实现似乎确实让您更难“正确”地做到这一点。因此,我的目标是避免使用下划线方法,但如果事实证明这样做太难,请不要大汗淋漓。

PS isValidSelection 是一种仅限 PowerTools 的方法,它将它们都需要的公共逻辑与每个命令特定的逻辑分开。

于 2012-08-13T16:29:25.633 回答