Skip to main content

A DD4T.net Implementation - Navigtion Utils

In the previous posts Navigation and Navigation (part 2), I presented the NavigationFactory class and the object model obtained by deserializing the navigation XML.

In this post, I will present simple examples of creating breadcrumb and navigation structures.

Breadcrumb

When rendering a breadcrumb trail, we start by locating the NavigationItem in the navigation object model corresponding to the current page, and then we follow the "ParentItem" relation to go up until the navigation root. We retain each NavigationItem that we encounter in this traversal. Finally, the breadcrumb trail is the reversed list of these NavigationItems.

The following code is part of the NavigationFactory and returns an array of NavigationItem objects corresponding to the breadcrumb trail.

public NavigationItem[] GetBreadcrumb(NavigationItem page)
{
    IList<NavigationItem> result = new List<NavigationItem>();
    if (page != null)
    {
        do
        {
            result.Add(page);
            page = page.ParentItem;
        }
        while (page != null);
    }

    return result.Reverse().ToArray();
}

The method GetBreadcrumb expects a NavigationItem object as parameter, which means we first need to get the NavigationItem for the current IPage. The method below builds such a NavigationItem array for the given IPage. The code checks whether the current page is in the Navigation, or otherwise whether its Structure Group is in the navigation object model.

private List<NavigationItem> GetBreadcrumbForPage(IPage page)
{
    NavigationItem item = NavigationFactory.GetItemById(Navigation, page.Id) ??
        NavigationFactory.GetItemById(Navigation, page.StructureGroup.Id);

    return GetBreadcrumbForNavigationItem(item);
}

Once the NavigationItem corresponding to the current IPage has been identified, we call method GetBreadcrumbForNavigationItem which builds the actual breadcrumb. Notice that we discard the first element in the returned array, because this corresponds to the Root Structure Group.

Additionally, the code checks whether the last element in the breadcrumb is a default page (e.g. default.aspx), and if so, it removes it.

private List<NavigationItem> GetBreadcrumbForNavigationItem(NavigationItem item)
{
    List<NavigationItem> result = new List<NavigationItem>(NavigationFactory.GetBreadcrumb(item));
    if (result.Count > 0)
    {
        result.RemoveAt(0);

        NavigationItem lastItem = result.LastOrDefault();
        if (lastItem != null && UriHelper.IsDefaultPage(lastItem.ActualUrl))
        {
            result.Remove(lastItem);
        }
    }

    return result;
}

Navigation

Rendering navigation implies getting the Navigation object model and traversing it top-bottom in order to generate the HTML structures for each level.

The following code exists in a Razor template and calls a partial view passing to it the NavigationItem array of the first level items in the navigation:

    @Html.Partial("_PartialNavigation", Html.GetNavigations((IPage)Model))

The method GetNavigations is defined as extension method for HtmlHelper and it is in charge with reading the navigation items directly under the root Structure Group:

public static IList<NavigationItem> GetNavigations(this HtmlHelper htmlHelper, IPage page)
{
    if (page == null)
    {
        return new NavigationItem[0];
    }
    INavigationFactory navigationFactory = DependencyResolver.Current.GetService<INavigationFactory>();
    Navigation navigation = navigationFactory.GetNavigation();
    return new List<NavigationItem>(navigationFactory.GetNavigation(navigation));
}

The Razor view presented below belongs to file _PartialNavigation.cshtml and it shows some sample code that generates a two-level deep HTML navigation:

@model IList<NavigationItem>

<ul>
    @foreach (NavigationItem levelOne in Model)
    {
        <li>
            <a href="@levelOne.Url">@levelOne.Title</a>
            <ul>
                @foreach (NavigationItem levelTwo in levelOne.ChildItems)
                {
                    <li>
                        <a href="@levelTwo.Url">@levelTwo.Title</a>
                    </li>
                }
            </ul>
        </li>
    }
</ul>


Comments

Popular posts from this blog

A DD4T.net Implementation - Custom Binary Publisher

The default way to publish binaries in DD4T is implemented in class DD4T.Templates.Base.Utils.BinaryPublisher and uses method RenderedItem.AddBinary(Component) . This produces binaries that have their TCM URI as suffix in their filename. In my recent project, we had a requirement that binary file names should be clean (without the TCM URI suffix). Therefore, it was time to modify the way DD4T was publishing binaries. The method in charge with publishing binaries is called PublishItem and is defined in class BinaryPublisher . I therefore extended the BinaryPublisher and overrode method PublishItem. public class CustomBinaryPublisher : BinaryPublisher { private Template currentTemplate; private TcmUri structureGroupUri; In its simplest form, method PublishItem just takes the item and passes it to the AddBinary. In order to accomplish the requirement, we must specify a filename while publishing. This is the file name part of the binary path of Component.BinaryConten

Event System to Create Mapped Structure Groups for Binary Publish

As a continuation of last week's Publish Binaries to Mapped Structure Group , this week's TBB is in fact the Event System part of that solution. Make sure you do check out the previous post first, which explains why and what this Event System does. To reiterate, the Event System intercepts a Multimedia Component save, take its Folder path and create a 1-to-1 mapping of Structure Groups. The original code was written, again, by my colleague Eric Huiza : [ TcmExtension ( "MyEvents" )] public class EventsManager  : TcmExtension {     private Configuration configuration;     private readonly Regex SAFE_DIRNAME_REGEX = new Regex ( @"[\W_]+" );     public EventsManager() {         ExeConfigurationFileMap fileMap = new ExeConfigurationFileMap ();         fileMap.ExeConfigFilename = Path .GetDirectoryName( Assembly .GetExecutingAssembly().Location) + "\\EventSystem.config" ;         configuration = ConfigurationManager

Running sp_updatestats on AWS RDS database

Part of the maintenance tasks that I perform on a MSSQL Content Manager database is to run stored procedure sp_updatestats . exec sp_updatestats However, that is not supported on an AWS RDS instance. The error message below indicates that only the sa  account can perform this: Msg 15247 , Level 16 , State 1 , Procedure sp_updatestats, Line 15 [Batch Start Line 0 ] User does not have permission to perform this action. Instead there are several posts that suggest using UPDATE STATISTICS instead: https://dba.stackexchange.com/questions/145982/sp-updatestats-vs-update-statistics I stumbled upon the following post from 2008 (!!!), https://social.msdn.microsoft.com/Forums/sqlserver/en-US/186e3db0-fe37-4c31-b017-8e7c24d19697/spupdatestats-fails-to-run-with-permission-error-under-dbopriveleged-user , which describes a way to wrap the call to sp_updatestats and execute it under a different user: create procedure dbo.sp_updstats with execute as 'dbo' as