C# Class Sdl.Web.Tridion.Navigation.DynamicNavigationProvider

Navigation Provider implementation based on Taxonomies (Categories and Keywords)
Inheritance: INavigationProvider, IOnDemandNavigationProvider
Show file Open project: sdl/dxa-web-application-dotnet

Public Methods

Method Description
GetBreadcrumbNavigationLinks ( string requestUrlPath, Sdl.Web.Common.Configuration.Localization localization ) : NavigationLinks

Gets Navigation Links for the breadcrumb trail for the given request URL path.
GetContextNavigationLinks ( string requestUrlPath, Sdl.Web.Common.Configuration.Localization localization ) : NavigationLinks

Gets Navigation Links for the context navigation panel for the given request URL path.
GetNavigationModel ( Sdl.Web.Common.Configuration.Localization localization ) : SitemapItem

Gets the Navigation Model (Sitemap) for a given Localization.
GetNavigationSubtree ( string sitemapItemId, NavigationFilter filter, Sdl.Web.Common.Configuration.Localization localization ) : IEnumerable

Gets a Navigation subtree for the given Sitemap Item.
GetTopNavigationLinks ( string requestUrlPath, Sdl.Web.Common.Configuration.Localization localization ) : NavigationLinks

Gets Navigation Links for the top navigation menu for the given request URL path.

Private Methods

Method Description
AddDescendants ( TaxonomyNode taxonomyNode, NavigationFilter filter, Sdl.Web.Common.Configuration.Localization localization ) : void
BuildNavigationModel ( string navTaxonomyUri, Sdl.Web.Common.Configuration.Localization localization ) : SitemapItem
CreateSitemapItem ( IPageMeta pageMeta, string taxonomyId ) : SitemapItem
CreateTaxonomyNode ( Keyword keyword, int expandLevels, NavigationFilter filter, Sdl.Web.Common.Configuration.Localization localization ) : TaxonomyNode
ExpandAncestorsForKeyword ( string keywordUri, string taxonomyUri, NavigationFilter filter, Sdl.Web.Common.Configuration.Localization localization ) : TaxonomyNode
ExpandAncestorsForPage ( string pageUri, string taxonomyUri, NavigationFilter filter, Sdl.Web.Common.Configuration.Localization localization ) : TaxonomyNode
ExpandClassifiedPages ( Keyword keyword, string taxonomyId, Sdl.Web.Common.Configuration.Localization localization ) : Sdl.Web.Common.Models.SitemapItem[]
ExpandDescendants ( string keywordUri, string taxonomyUri, NavigationFilter filter, Sdl.Web.Common.Configuration.Localization localization ) : IEnumerable
ExpandTaxonomyRoots ( NavigationFilter filter, Sdl.Web.Common.Configuration.Localization localization ) : IEnumerable
FormatKeywordNodeId ( string keywordUri, string taxonomyId ) : string
GetNavigationTaxonomyUri ( Sdl.Web.Common.Configuration.Localization localization ) : string
GetPublicationTcmUri ( Sdl.Web.Common.Configuration.Localization localization ) : string
IsHome ( SitemapItem sitemapItem, Sdl.Web.Common.Configuration.Localization localization ) : bool
MergeSubtrees ( SitemapItem subtreeRoot, SitemapItem subtreeToMergeInto ) : void
ParseSitemapItemId ( string sitemapItemId, string &taxonomyId, string &keywordId, string &pageId ) : void
ResolveNavigationTaxonomyUri ( Sdl.Web.Common.Configuration.Localization localization ) : string
StripFileExtension ( string urlPath ) : string
StripSequencePrefix ( string title, string &sequencePrefix ) : string

Method Details

GetBreadcrumbNavigationLinks() public method

Gets Navigation Links for the breadcrumb trail for the given request URL path.
public GetBreadcrumbNavigationLinks ( string requestUrlPath, Sdl.Web.Common.Configuration.Localization localization ) : NavigationLinks
requestUrlPath string The request URL path.
localization Sdl.Web.Common.Configuration.Localization The Localization.
return Sdl.Web.Common.Models.NavigationLinks

GetContextNavigationLinks() public method

Gets Navigation Links for the context navigation panel for the given request URL path.
public GetContextNavigationLinks ( string requestUrlPath, Sdl.Web.Common.Configuration.Localization localization ) : NavigationLinks
requestUrlPath string The request URL path.
localization Sdl.Web.Common.Configuration.Localization The Localization.
return Sdl.Web.Common.Models.NavigationLinks

GetNavigationModel() public method

Gets the Navigation Model (Sitemap) for a given Localization.
public GetNavigationModel ( Sdl.Web.Common.Configuration.Localization localization ) : SitemapItem
localization Sdl.Web.Common.Configuration.Localization The Localization.
return Sdl.Web.Common.Models.SitemapItem

GetNavigationSubtree() public method

Gets a Navigation subtree for the given Sitemap Item.
public GetNavigationSubtree ( string sitemapItemId, NavigationFilter filter, Sdl.Web.Common.Configuration.Localization localization ) : IEnumerable
sitemapItemId string The context identifier. Can be null.
filter Sdl.Web.Common.Models.Navigation.NavigationFilter The used to specify which information to put in the subtree.
localization Sdl.Web.Common.Configuration.Localization The context .
return IEnumerable

GetTopNavigationLinks() public method

Gets Navigation Links for the top navigation menu for the given request URL path.
public GetTopNavigationLinks ( string requestUrlPath, Sdl.Web.Common.Configuration.Localization localization ) : NavigationLinks
requestUrlPath string The request URL path.
localization Sdl.Web.Common.Configuration.Localization The Localization.
return Sdl.Web.Common.Models.NavigationLinks