Files
Umbraco-CMS/src/Umbraco.Web/PublishedCache/ContextualPublishedContentCache.cs
2013-04-10 14:02:16 -02:00

75 lines
3.5 KiB
C#

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Umbraco.Core.Models;
namespace Umbraco.Web.PublishedCache
{
/// <summary>
/// Provides access to cached documents in a specified context.
/// </summary>
public class ContextualPublishedContentCache : ContextualPublishedCache<IPublishedContentCache>
{
/// <summary>
/// Initializes a new instance of the <see cref="ContextualPublishedContentCache"/> class with a published content cache and a context.
/// </summary>
/// <param name="cache">A published content cache.</param>
/// <param name="umbracoContext">A context.</param>
internal ContextualPublishedContentCache(IPublishedContentCache cache, UmbracoContext umbracoContext)
: base(umbracoContext, cache)
{ }
/// <summary>
/// Gets content identified by a route.
/// </summary>
/// <param name="route">The route</param>
/// <param name="hideTopLevelNode">A value forcing the HideTopLevelNode setting.</param>
/// <returns>The content, or null.</returns>
/// <remarks>
/// <para>A valid route is either a simple path eg <c>/foo/bar/nil</c> or a root node id and a path, eg <c>123/foo/bar/nil</c>.</para>
/// <para>Considers published or unpublished content depending on context.</para>
/// </remarks>
public IPublishedContent GetByRoute(string route, bool? hideTopLevelNode = null)
{
return GetByRoute(UmbracoContext.InPreviewMode, route, hideTopLevelNode);
}
/// <summary>
/// Gets content identified by a route.
/// </summary>
/// <param name="preview">A value indicating whether to consider unpublished content.</param>
/// <param name="route">The route</param>
/// <param name="hideTopLevelNode">A value forcing the HideTopLevelNode setting.</param>
/// <returns>The content, or null.</returns>
/// <remarks>A valid route is either a simple path eg <c>/foo/bar/nil</c> or a root node id and a path, eg <c>123/foo/bar/nil</c>.</remarks>
public IPublishedContent GetByRoute(bool preview, string route, bool? hideTopLevelNode = null)
{
return InnerCache.GetByRoute(UmbracoContext, preview, route, hideTopLevelNode);
}
/// <summary>
/// Gets the route for a content identified by its unique identifier.
/// </summary>
/// <param name="contentId">The content unique identifier.</param>
/// <returns>The route.</returns>
/// <remarks>Considers published or unpublished content depending on context.</remarks>
public string GetRouteById(int contentId)
{
return GetRouteById(UmbracoContext.InPreviewMode, contentId);
}
/// <summary>
/// Gets the route for a content identified by its unique identifier.
/// </summary>
/// <param name="preview">A value indicating whether to consider unpublished content.</param>
/// <param name="contentId">The content unique identifier.</param>
/// <returns>The route.</returns>
/// <remarks>Considers published or unpublished content depending on context.</remarks>
public string GetRouteById(bool preview, int contentId)
{
return InnerCache.GetRouteById(UmbracoContext, preview, contentId);
}
}
}