在 Kentico 自定义对象宏方法中访问嵌套属性

Question

我正在尝试在 Kentico（v8.2.x 或 v9.0）中编写一个宏方法，该方法已适当缓存，并公开了一个包含几个 public 成员的 POCO。

在 Visual Studio 中进行调试，我可以看到查询运行正常，并且返回的对象实例正是我想要的。此外，使用 Kentico 中的 Debug 应用程序检查缓存项也显示完整的 POCO 实例数据已按预期缓存。

但是，在调用宏时，我似乎只能读取对象的字符串表示形式。

它是一个扩展 CurrentUserInfo 类型的宏，所以我试图这样调用它：

{% CurrentUser.ClientStatus() %}

但是尝试检索任何嵌套属性失败。

我确定这只是我没有做某事（比如正确注册这些属性）。但是从 documentation 开始，我看到了很多可以的东西。例如：

命名来源
命名回调源
匿名来源
或者以某种方式将它们注册为单独的字段

这是宏本身：

/// <summary>
/// A class containing custom user-extension macros.
/// </summary>
[assembly: RegisterExtension(typeof(CustomUserMacros), typeof(CurrentUserInfo))]
public class CustomUserMacros : MacroMethodContainer
{
    /// <summary>
    /// Retrieves data regarding user client.
    /// </summary>
    /// <param name="context">The context.</param>
    /// <param name="parameters">The parameters.</param>
    /// <returns>Data regarding user client information.</returns>
    [MacroMethod(typeof(ClientInfo), "Retrieves client info.", 1)]
    [MacroMethodParam(0, "user", typeof(CurrentUserInfo), "The user.")]
    public static object ClientStatus(
            EvaluationContext context,
            params object[] parameters)
    {
        ClientInfo retVal = null;
        if (parameters != null && parameters.Length > 0
                && parameters[0].GetType() == typeof(CurrentUserInfo))
        {
            var siteName = SiteContext.CurrentSiteName;
            var userGuid = ((CurrentUserInfo)parameters[0]).UserGUID;
            var uInfo = UserInfoProvider.GetUserInfoByGUID(userGuid);
            retVal = CacheHelper.Cache(
                cs => new ClientInfo(uInfo, siteName),
                new CacheSettings(
                    60, 
                    typeof(CustomUserMacros), 
                    "ClientStatus", 
                    userGuid));
        }

        return retVal;
    }
}

ClientInfo class 非常简单：

public class ClientInfo
{
    public string Summary { get; private set; }

    public CustomTableItem ClientRecord { get; private set; }

    public IEnumerable<string> MediaPaths { get; private set; }

    public ClientInfo(UserInfo userInfo, string siteCodeName) {
        // ...
        // Set properties, etc...
    }

    public override string ToString()
    {
        return Summary;
    }
}

以类似于以下的方式访问属性的最简单方法是什么？

{% CurrentUser.ClientStatus().ClientRecord["< Column Name >"] %}

Answer 1

首先，我建议您使用系统 -> 宏 -> 控制台来测试您的宏 - 它非常有用。在您的情况下，您应该能够访问这样的属性：

{% CurrentUser.ClientStatus().Summary %}

Answer 2

为了能够按照您描述的方式访问属性，父对象必须是 DataRow 或 DataRowView 类型或实现以下接口之一：IVirtualHierarchicalObject, IHierarchicalObject, IDataContainer, ISimpleDataContainer.

在您的情况下，ClientInfo 应该实施 IDataContainer。嵌套的 CustomTableItem 已经实现了接口之一，因为它继承自 AbstractInfo.

您必须实现几个成员，这些成员主要使用名为 columnName 的参数来识别您应该 return:

的成员

public class ClientInfo : IDataContainer
{
    ...
    public object GetValue(string columnName)
    {
        switch (columnName)
        {
            case "ClientRecord":
                return ClientRecord;

            case "Summary":
                return Summary;

            case "MediaPaths":
                return MediaPaths;
        }
        return null;
    }
    ...
}

Answer 3

在这种情况下可能行不通，但同样值得注意的是，您可以使用 CMS.Base.DataContainer 或 IEnumerable<CMS.Base.DataContainer>:

return 简单的对象值

return myCollection.Select(myObj => new DataContainer
                {
                    ["Value1"] = myObj.Value1,
                    ["Value2"] = myObj.Value2
                });

在 Kentico 自定义对象宏方法中访问嵌套属性

Accessing nested properties in a Kentico custom object macro method

c#

asp.net

kentico