Renormalize
This commit is contained in:
Stephan
@@ -1,215 +1,215 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Xml.XPath;
|
||||
using Umbraco.Core.Models.PublishedContent;
|
||||
using Umbraco.Core.Xml;
|
||||
|
||||
namespace Umbraco.Web.PublishedCache
|
||||
{
|
||||
/// <summary>
|
||||
/// Provides access to cached contents.
|
||||
/// </summary>
|
||||
public interface IPublishedCache : IXPathNavigable
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets 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 content, or null.</returns>
|
||||
/// <remarks>The value of <paramref name="preview"/> overrides defaults.</remarks>
|
||||
IPublishedContent GetById(bool preview, int contentId);
|
||||
|
||||
/// <summary>
|
||||
/// Gets 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 content, or null.</returns>
|
||||
/// <remarks>The value of <paramref name="preview"/> overrides defaults.</remarks>
|
||||
IPublishedContent GetById(bool preview, Guid contentId);
|
||||
|
||||
/// <summary>
|
||||
/// Gets a content identified by its unique identifier.
|
||||
/// </summary>
|
||||
/// <param name="contentId">The content unique identifier.</param>
|
||||
/// <returns>The content, or null.</returns>
|
||||
/// <remarks>Considers published or unpublished content depending on defaults.</remarks>
|
||||
IPublishedContent GetById(int contentId);
|
||||
|
||||
/// <summary>
|
||||
/// Gets a content identified by its unique identifier.
|
||||
/// </summary>
|
||||
/// <param name="contentId">The content unique identifier.</param>
|
||||
/// <returns>The content, or null.</returns>
|
||||
/// <remarks>Considers published or unpublished content depending on defaults.</remarks>
|
||||
IPublishedContent GetById(Guid contentId);
|
||||
|
||||
/// <summary>
|
||||
/// Gets a value indicating whether the cache contains a specified content.
|
||||
/// </summary>
|
||||
/// <param name="preview">A value indicating whether to consider unpublished content.</param>
|
||||
/// <param name="contentId">The content unique identifier.</param>
|
||||
/// <returns>A value indicating whether to the cache contains the specified content.</returns>
|
||||
/// <remarks>The value of <paramref name="preview"/> overrides defaults.</remarks>
|
||||
bool HasById(bool preview, int contentId);
|
||||
|
||||
/// <summary>
|
||||
/// Gets a value indicating whether the cache contains a specified content.
|
||||
/// </summary>
|
||||
/// <param name="contentId">The content unique identifier.</param>
|
||||
/// <returns>A value indicating whether to the cache contains the specified content.</returns>
|
||||
/// <remarks>Considers published or unpublished content depending on defaults.</remarks>
|
||||
bool HasById(int contentId);
|
||||
|
||||
/// <summary>
|
||||
/// Gets contents at root.
|
||||
/// </summary>
|
||||
/// <param name="preview">A value indicating whether to consider unpublished content.</param>
|
||||
/// <returns>The contents.</returns>
|
||||
/// <remarks>The value of <paramref name="preview"/> overrides defaults.</remarks>
|
||||
IEnumerable<IPublishedContent> GetAtRoot(bool preview);
|
||||
|
||||
/// <summary>
|
||||
/// Gets contents at root.
|
||||
/// </summary>
|
||||
/// <returns>The contents.</returns>
|
||||
/// <remarks>Considers published or unpublished content depending on defaults.</remarks>
|
||||
IEnumerable<IPublishedContent> GetAtRoot();
|
||||
|
||||
/// <summary>
|
||||
/// Gets a content resulting from an XPath query.
|
||||
/// </summary>
|
||||
/// <param name="preview">A value indicating whether to consider unpublished content.</param>
|
||||
/// <param name="xpath">The XPath query.</param>
|
||||
/// <param name="vars">Optional XPath variables.</param>
|
||||
/// <returns>The content, or null.</returns>
|
||||
/// <remarks>The value of <paramref name="preview"/> overrides defaults.</remarks>
|
||||
IPublishedContent GetSingleByXPath(bool preview, string xpath, params XPathVariable[] vars);
|
||||
|
||||
/// <summary>
|
||||
/// Gets a content resulting from an XPath query.
|
||||
/// </summary>
|
||||
/// <param name="xpath">The XPath query.</param>
|
||||
/// <param name="vars">Optional XPath variables.</param>
|
||||
/// <returns>The content, or null.</returns>
|
||||
/// <remarks>Considers published or unpublished content depending on defaults.</remarks>
|
||||
IPublishedContent GetSingleByXPath(string xpath, params XPathVariable[] vars);
|
||||
|
||||
/// <summary>
|
||||
/// Gets a content resulting from an XPath query.
|
||||
/// </summary>
|
||||
/// <param name="preview">A value indicating whether to consider unpublished content.</param>
|
||||
/// <param name="xpath">The XPath query.</param>
|
||||
/// <param name="vars">Optional XPath variables.</param>
|
||||
/// <returns>The content, or null.</returns>
|
||||
/// <remarks>The value of <paramref name="preview"/> overrides defaults.</remarks>
|
||||
IPublishedContent GetSingleByXPath(bool preview, XPathExpression xpath, params XPathVariable[] vars);
|
||||
|
||||
/// <summary>
|
||||
/// Gets a content resulting from an XPath query.
|
||||
/// </summary>
|
||||
/// <param name="xpath">The XPath query.</param>
|
||||
/// <param name="vars">Optional XPath variables.</param>
|
||||
/// <returns>The content, or null.</returns>
|
||||
/// <remarks>Considers published or unpublished content depending on defaults.</remarks>
|
||||
IPublishedContent GetSingleByXPath(XPathExpression xpath, params XPathVariable[] vars);
|
||||
|
||||
/// <summary>
|
||||
/// Gets contents resulting from an XPath query.
|
||||
/// </summary>
|
||||
/// <param name="preview">A value indicating whether to consider unpublished content.</param>
|
||||
/// <param name="xpath">The XPath query.</param>
|
||||
/// <param name="vars">Optional XPath variables.</param>
|
||||
/// <returns>The contents.</returns>
|
||||
/// <remarks>The value of <paramref name="preview"/> overrides defaults.</remarks>
|
||||
IEnumerable<IPublishedContent> GetByXPath(bool preview, string xpath, params XPathVariable[] vars);
|
||||
|
||||
/// <summary>
|
||||
/// Gets contents resulting from an XPath query.
|
||||
/// </summary>
|
||||
/// <param name="xpath">The XPath query.</param>
|
||||
/// <param name="vars">Optional XPath variables.</param>
|
||||
/// <returns>The contents.</returns>
|
||||
/// <remarks>Considers published or unpublished content depending on defaults.</remarks>
|
||||
IEnumerable<IPublishedContent> GetByXPath(string xpath, params XPathVariable[] vars);
|
||||
|
||||
/// <summary>
|
||||
/// Gets contents resulting from an XPath query.
|
||||
/// </summary>
|
||||
/// <param name="preview">A value indicating whether to consider unpublished content.</param>
|
||||
/// <param name="xpath">The XPath query.</param>
|
||||
/// <param name="vars">Optional XPath variables.</param>
|
||||
/// <returns>The contents.</returns>
|
||||
/// <remarks>The value of <paramref name="preview"/> overrides defaults.</remarks>
|
||||
IEnumerable<IPublishedContent> GetByXPath(bool preview, XPathExpression xpath, params XPathVariable[] vars);
|
||||
|
||||
/// <summary>
|
||||
/// Gets contents resulting from an XPath query.
|
||||
/// </summary>
|
||||
/// <param name="xpath">The XPath query.</param>
|
||||
/// <param name="vars">Optional XPath variables.</param>
|
||||
/// <returns>The contents.</returns>
|
||||
/// <remarks>Considers published or unpublished content depending on defaults.</remarks>
|
||||
IEnumerable<IPublishedContent> GetByXPath(XPathExpression xpath, params XPathVariable[] vars);
|
||||
|
||||
/// <summary>
|
||||
/// Creates an XPath navigator that can be used to navigate contents.
|
||||
/// </summary>
|
||||
/// <param name="preview">A value indicating whether to consider unpublished content.</param>
|
||||
/// <returns>The XPath navigator.</returns>
|
||||
/// <remarks>
|
||||
/// <para>The value of <paramref name="preview"/> overrides the context.</para>
|
||||
/// <para>The navigator is already a safe clone (no need to clone it again).</para>
|
||||
/// </remarks>
|
||||
XPathNavigator CreateNavigator(bool preview);
|
||||
|
||||
/// <summary>
|
||||
/// Creates an XPath navigator that can be used to navigate one node.
|
||||
/// </summary>
|
||||
/// <param name="id">The node identifier.</param>
|
||||
/// <param name="preview">A value indicating whether to consider unpublished content.</param>
|
||||
/// <returns>The XPath navigator, or null.</returns>
|
||||
/// <remarks>
|
||||
/// <para>The value of <paramref name="preview"/> overrides the context.</para>
|
||||
/// <para>The navigator is already a safe clone (no need to clone it again).</para>
|
||||
/// <para>Navigates over the node - and only the node, ie no children. Exists only for backward
|
||||
/// compatibility + transition reasons, we should obsolete that one as soon as possible.</para>
|
||||
/// <para>If the node does not exist, returns null.</para>
|
||||
/// </remarks>
|
||||
XPathNavigator CreateNodeNavigator(int id, bool preview);
|
||||
|
||||
/// <summary>
|
||||
/// Gets a value indicating whether the cache contains published content.
|
||||
/// </summary>
|
||||
/// <param name="preview">A value indicating whether to consider unpublished content.</param>
|
||||
/// <returns>A value indicating whether the cache contains published content.</returns>
|
||||
/// <remarks>The value of <paramref name="preview"/> overrides defaults.</remarks>
|
||||
bool HasContent(bool preview);
|
||||
|
||||
/// <summary>
|
||||
/// Gets a value indicating whether the cache contains published content.
|
||||
/// </summary>
|
||||
/// <returns>A value indicating whether the cache contains published content.</returns>
|
||||
/// <remarks>Considers published or unpublished content depending on defaults.</remarks>
|
||||
bool HasContent();
|
||||
|
||||
/// <summary>
|
||||
/// Gets a content type identified by its unique identifier.
|
||||
/// </summary>
|
||||
/// <param name="id">The content type unique identifier.</param>
|
||||
/// <returns>The content type, or null.</returns>
|
||||
PublishedContentType GetContentType(int id);
|
||||
|
||||
/// <summary>
|
||||
/// Gets a content type identified by its alias.
|
||||
/// </summary>
|
||||
/// <param name="alias">The content type alias.</param>
|
||||
/// <returns>The content type, or null.</returns>
|
||||
/// <remarks>The alias is case-insensitive.</remarks>
|
||||
PublishedContentType GetContentType(string alias);
|
||||
|
||||
// fixme - can we implement this, now? maybe only with NuCache else will throw NotImplemented...
|
||||
IEnumerable<IPublishedContent> GetByContentType(PublishedContentType contentType);
|
||||
}
|
||||
}
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Xml.XPath;
|
||||
using Umbraco.Core.Models.PublishedContent;
|
||||
using Umbraco.Core.Xml;
|
||||
|
||||
namespace Umbraco.Web.PublishedCache
|
||||
{
|
||||
/// <summary>
|
||||
/// Provides access to cached contents.
|
||||
/// </summary>
|
||||
public interface IPublishedCache : IXPathNavigable
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets 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 content, or null.</returns>
|
||||
/// <remarks>The value of <paramref name="preview"/> overrides defaults.</remarks>
|
||||
IPublishedContent GetById(bool preview, int contentId);
|
||||
|
||||
/// <summary>
|
||||
/// Gets 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 content, or null.</returns>
|
||||
/// <remarks>The value of <paramref name="preview"/> overrides defaults.</remarks>
|
||||
IPublishedContent GetById(bool preview, Guid contentId);
|
||||
|
||||
/// <summary>
|
||||
/// Gets a content identified by its unique identifier.
|
||||
/// </summary>
|
||||
/// <param name="contentId">The content unique identifier.</param>
|
||||
/// <returns>The content, or null.</returns>
|
||||
/// <remarks>Considers published or unpublished content depending on defaults.</remarks>
|
||||
IPublishedContent GetById(int contentId);
|
||||
|
||||
/// <summary>
|
||||
/// Gets a content identified by its unique identifier.
|
||||
/// </summary>
|
||||
/// <param name="contentId">The content unique identifier.</param>
|
||||
/// <returns>The content, or null.</returns>
|
||||
/// <remarks>Considers published or unpublished content depending on defaults.</remarks>
|
||||
IPublishedContent GetById(Guid contentId);
|
||||
|
||||
/// <summary>
|
||||
/// Gets a value indicating whether the cache contains a specified content.
|
||||
/// </summary>
|
||||
/// <param name="preview">A value indicating whether to consider unpublished content.</param>
|
||||
/// <param name="contentId">The content unique identifier.</param>
|
||||
/// <returns>A value indicating whether to the cache contains the specified content.</returns>
|
||||
/// <remarks>The value of <paramref name="preview"/> overrides defaults.</remarks>
|
||||
bool HasById(bool preview, int contentId);
|
||||
|
||||
/// <summary>
|
||||
/// Gets a value indicating whether the cache contains a specified content.
|
||||
/// </summary>
|
||||
/// <param name="contentId">The content unique identifier.</param>
|
||||
/// <returns>A value indicating whether to the cache contains the specified content.</returns>
|
||||
/// <remarks>Considers published or unpublished content depending on defaults.</remarks>
|
||||
bool HasById(int contentId);
|
||||
|
||||
/// <summary>
|
||||
/// Gets contents at root.
|
||||
/// </summary>
|
||||
/// <param name="preview">A value indicating whether to consider unpublished content.</param>
|
||||
/// <returns>The contents.</returns>
|
||||
/// <remarks>The value of <paramref name="preview"/> overrides defaults.</remarks>
|
||||
IEnumerable<IPublishedContent> GetAtRoot(bool preview);
|
||||
|
||||
/// <summary>
|
||||
/// Gets contents at root.
|
||||
/// </summary>
|
||||
/// <returns>The contents.</returns>
|
||||
/// <remarks>Considers published or unpublished content depending on defaults.</remarks>
|
||||
IEnumerable<IPublishedContent> GetAtRoot();
|
||||
|
||||
/// <summary>
|
||||
/// Gets a content resulting from an XPath query.
|
||||
/// </summary>
|
||||
/// <param name="preview">A value indicating whether to consider unpublished content.</param>
|
||||
/// <param name="xpath">The XPath query.</param>
|
||||
/// <param name="vars">Optional XPath variables.</param>
|
||||
/// <returns>The content, or null.</returns>
|
||||
/// <remarks>The value of <paramref name="preview"/> overrides defaults.</remarks>
|
||||
IPublishedContent GetSingleByXPath(bool preview, string xpath, params XPathVariable[] vars);
|
||||
|
||||
/// <summary>
|
||||
/// Gets a content resulting from an XPath query.
|
||||
/// </summary>
|
||||
/// <param name="xpath">The XPath query.</param>
|
||||
/// <param name="vars">Optional XPath variables.</param>
|
||||
/// <returns>The content, or null.</returns>
|
||||
/// <remarks>Considers published or unpublished content depending on defaults.</remarks>
|
||||
IPublishedContent GetSingleByXPath(string xpath, params XPathVariable[] vars);
|
||||
|
||||
/// <summary>
|
||||
/// Gets a content resulting from an XPath query.
|
||||
/// </summary>
|
||||
/// <param name="preview">A value indicating whether to consider unpublished content.</param>
|
||||
/// <param name="xpath">The XPath query.</param>
|
||||
/// <param name="vars">Optional XPath variables.</param>
|
||||
/// <returns>The content, or null.</returns>
|
||||
/// <remarks>The value of <paramref name="preview"/> overrides defaults.</remarks>
|
||||
IPublishedContent GetSingleByXPath(bool preview, XPathExpression xpath, params XPathVariable[] vars);
|
||||
|
||||
/// <summary>
|
||||
/// Gets a content resulting from an XPath query.
|
||||
/// </summary>
|
||||
/// <param name="xpath">The XPath query.</param>
|
||||
/// <param name="vars">Optional XPath variables.</param>
|
||||
/// <returns>The content, or null.</returns>
|
||||
/// <remarks>Considers published or unpublished content depending on defaults.</remarks>
|
||||
IPublishedContent GetSingleByXPath(XPathExpression xpath, params XPathVariable[] vars);
|
||||
|
||||
/// <summary>
|
||||
/// Gets contents resulting from an XPath query.
|
||||
/// </summary>
|
||||
/// <param name="preview">A value indicating whether to consider unpublished content.</param>
|
||||
/// <param name="xpath">The XPath query.</param>
|
||||
/// <param name="vars">Optional XPath variables.</param>
|
||||
/// <returns>The contents.</returns>
|
||||
/// <remarks>The value of <paramref name="preview"/> overrides defaults.</remarks>
|
||||
IEnumerable<IPublishedContent> GetByXPath(bool preview, string xpath, params XPathVariable[] vars);
|
||||
|
||||
/// <summary>
|
||||
/// Gets contents resulting from an XPath query.
|
||||
/// </summary>
|
||||
/// <param name="xpath">The XPath query.</param>
|
||||
/// <param name="vars">Optional XPath variables.</param>
|
||||
/// <returns>The contents.</returns>
|
||||
/// <remarks>Considers published or unpublished content depending on defaults.</remarks>
|
||||
IEnumerable<IPublishedContent> GetByXPath(string xpath, params XPathVariable[] vars);
|
||||
|
||||
/// <summary>
|
||||
/// Gets contents resulting from an XPath query.
|
||||
/// </summary>
|
||||
/// <param name="preview">A value indicating whether to consider unpublished content.</param>
|
||||
/// <param name="xpath">The XPath query.</param>
|
||||
/// <param name="vars">Optional XPath variables.</param>
|
||||
/// <returns>The contents.</returns>
|
||||
/// <remarks>The value of <paramref name="preview"/> overrides defaults.</remarks>
|
||||
IEnumerable<IPublishedContent> GetByXPath(bool preview, XPathExpression xpath, params XPathVariable[] vars);
|
||||
|
||||
/// <summary>
|
||||
/// Gets contents resulting from an XPath query.
|
||||
/// </summary>
|
||||
/// <param name="xpath">The XPath query.</param>
|
||||
/// <param name="vars">Optional XPath variables.</param>
|
||||
/// <returns>The contents.</returns>
|
||||
/// <remarks>Considers published or unpublished content depending on defaults.</remarks>
|
||||
IEnumerable<IPublishedContent> GetByXPath(XPathExpression xpath, params XPathVariable[] vars);
|
||||
|
||||
/// <summary>
|
||||
/// Creates an XPath navigator that can be used to navigate contents.
|
||||
/// </summary>
|
||||
/// <param name="preview">A value indicating whether to consider unpublished content.</param>
|
||||
/// <returns>The XPath navigator.</returns>
|
||||
/// <remarks>
|
||||
/// <para>The value of <paramref name="preview"/> overrides the context.</para>
|
||||
/// <para>The navigator is already a safe clone (no need to clone it again).</para>
|
||||
/// </remarks>
|
||||
XPathNavigator CreateNavigator(bool preview);
|
||||
|
||||
/// <summary>
|
||||
/// Creates an XPath navigator that can be used to navigate one node.
|
||||
/// </summary>
|
||||
/// <param name="id">The node identifier.</param>
|
||||
/// <param name="preview">A value indicating whether to consider unpublished content.</param>
|
||||
/// <returns>The XPath navigator, or null.</returns>
|
||||
/// <remarks>
|
||||
/// <para>The value of <paramref name="preview"/> overrides the context.</para>
|
||||
/// <para>The navigator is already a safe clone (no need to clone it again).</para>
|
||||
/// <para>Navigates over the node - and only the node, ie no children. Exists only for backward
|
||||
/// compatibility + transition reasons, we should obsolete that one as soon as possible.</para>
|
||||
/// <para>If the node does not exist, returns null.</para>
|
||||
/// </remarks>
|
||||
XPathNavigator CreateNodeNavigator(int id, bool preview);
|
||||
|
||||
/// <summary>
|
||||
/// Gets a value indicating whether the cache contains published content.
|
||||
/// </summary>
|
||||
/// <param name="preview">A value indicating whether to consider unpublished content.</param>
|
||||
/// <returns>A value indicating whether the cache contains published content.</returns>
|
||||
/// <remarks>The value of <paramref name="preview"/> overrides defaults.</remarks>
|
||||
bool HasContent(bool preview);
|
||||
|
||||
/// <summary>
|
||||
/// Gets a value indicating whether the cache contains published content.
|
||||
/// </summary>
|
||||
/// <returns>A value indicating whether the cache contains published content.</returns>
|
||||
/// <remarks>Considers published or unpublished content depending on defaults.</remarks>
|
||||
bool HasContent();
|
||||
|
||||
/// <summary>
|
||||
/// Gets a content type identified by its unique identifier.
|
||||
/// </summary>
|
||||
/// <param name="id">The content type unique identifier.</param>
|
||||
/// <returns>The content type, or null.</returns>
|
||||
PublishedContentType GetContentType(int id);
|
||||
|
||||
/// <summary>
|
||||
/// Gets a content type identified by its alias.
|
||||
/// </summary>
|
||||
/// <param name="alias">The content type alias.</param>
|
||||
/// <returns>The content type, or null.</returns>
|
||||
/// <remarks>The alias is case-insensitive.</remarks>
|
||||
PublishedContentType GetContentType(string alias);
|
||||
|
||||
// fixme - can we implement this, now? maybe only with NuCache else will throw NotImplemented...
|
||||
IEnumerable<IPublishedContent> GetByContentType(PublishedContentType contentType);
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user