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

时间:2016-02-02 09:59:23

标签: c# asp.net kentico

我正在尝试在Kentico(v8.2.x或v9.0)中编写一个适当缓存的单个宏方法,并使用一些公共成员公开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课程非常简单:

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 >"] %}

3 个答案:

答案 0 :(得分:5)

为了能够以您描述的方式访问属性,父对象必须是DataRowDataRowView类型,或者实现以下接口之一:IVirtualHierarchicalObjectIHierarchicalObjectIDataContainerISimpleDataContainer

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

你必须实现几个成员,这些成员主要使用一个名为columnName的参数来识别你应该返回其值的成员:

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;
    }
    ...
}

答案 1 :(得分:1)

可能在这种情况下不起作用,但值得注意的是,您可以使用CMS.Base.DataContainerIEnumerable<CMS.Base.DataContainer>返回简单的对象值:

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

答案 2 :(得分:-2)

首先我建议你使用System - &gt;宏 - &gt;用于测试宏的控制台 - 它非常有用。 在您的情况下,您应该能够访问这样的属性:

{% CurrentUser.ClientStatus().Summary %}