2018-06-29 19:52:40 +02:00
using System ;
using System.Collections.Generic ;
using System.Data ;
using System.Linq ;
using System.Web ;
using Examine ;
using Umbraco.Core ;
2018-09-06 13:07:09 +02:00
using Umbraco.Core.Models.PublishedContent ;
2018-06-29 19:52:40 +02:00
using Umbraco.Core.Models ;
using Umbraco.Core.Services ;
2018-12-17 12:17:03 +11:00
using Umbraco.Examine ;
2018-06-29 19:52:40 +02:00
using Umbraco.Web.Composing ;
2019-03-05 13:02:59 +01:00
using Umbraco.Web.PublishedCache ;
2018-06-29 19:52:40 +02:00
namespace Umbraco.Web
{
/// <summary>
/// Provides extension methods for <c>IPublishedContent</c>.
/// </summary>
public static class PublishedContentExtensions
{
// see notes in PublishedElementExtensions
//
private static IPublishedValueFallback PublishedValueFallback = > Current . PublishedValueFallback ;
2019-03-05 13:02:59 +01:00
private static IPublishedSnapshot PublishedSnapshot = > Current . PublishedSnapshot ;
2018-06-29 19:52:40 +02:00
#region Urls
/// <summary>
/// Gets the url for the content.
/// </summary>
/// <param name="content">The content.</param>
/// <returns>The url for the content.</returns>
/// <remarks>Better use the <c>Url</c> property but that method is here to complement <c>UrlAbsolute()</c>.</remarks>
public static string Url ( this IPublishedContent content )
{
return content . Url ;
}
/// <summary>
/// Gets the absolute url for the content.
/// </summary>
/// <param name="content">The content.</param>
/// <returns>The absolute url for the content.</returns>
public static string UrlAbsolute ( this IPublishedContent content )
{
// adapted from PublishedContentBase.Url
switch ( content . ItemType )
{
case PublishedItemType . Content :
2019-02-14 09:49:45 +01:00
if ( Current . UmbracoContext = = null )
throw new InvalidOperationException ( "Cannot resolve a Url for a content item when Current.UmbracoContext is null." ) ;
if ( Current . UmbracoContext . UrlProvider = = null )
throw new InvalidOperationException ( "Cannot resolve a Url for a content item when Current.UmbracoContext.UrlProvider is null." ) ;
return Current . UmbracoContext . UrlProvider . GetUrl ( content . Id , true ) ;
2018-06-29 19:52:40 +02:00
case PublishedItemType . Media :
throw new NotSupportedException ( "AbsoluteUrl is not supported for media types." ) ;
default :
throw new ArgumentOutOfRangeException ( ) ;
}
}
/// <summary>
/// Gets the Url segment.
/// </summary>
/// <remarks>
/// <para>Gets the url segment for the document, taking its content type and a specified
/// culture in account. For invariant content types, the culture is ignored, else it is
/// used to try and find the segment corresponding to the culture. May return null.</para>
/// </remarks>
public static string GetUrlSegment ( this IPublishedContent content , string culture = null )
{
// for invariant content, return the invariant url segment
2018-06-20 14:18:57 +02:00
if ( ! content . ContentType . VariesByCulture ( ) )
2018-06-29 19:52:40 +02:00
return content . UrlSegment ;
2018-06-12 17:05:37 +02:00
// content.GetCulture(culture) will use the 'current' culture (via accessor) in case 'culture'
// is null (meaning, 'current') - and can return 'null' if that culture is not published - and
// will return 'null' if the content is variant and culture is invariant
2018-06-29 19:52:40 +02:00
// else try and get the culture info
2018-06-12 17:05:37 +02:00
// return the corresponding url segment, or null if none
2018-06-29 19:52:40 +02:00
var cultureInfo = content . GetCulture ( culture ) ;
return cultureInfo ? . UrlSegment ;
2018-09-06 13:07:09 +02:00
}
public static bool IsAllowedTemplate ( this IPublishedContent content , int templateId )
{
2019-01-21 14:27:11 +01:00
if ( Current . Configs . Settings ( ) . WebRouting . DisableAlternativeTemplates )
2018-09-06 13:07:09 +02:00
return content . TemplateId = = templateId ;
2019-01-21 14:27:11 +01:00
if ( content . TemplateId = = templateId | | ! Current . Configs . Settings ( ) . WebRouting . ValidateAlternativeTemplates )
return true ;
2018-09-06 13:07:09 +02:00
2019-01-21 14:27:11 +01:00
var publishedContentContentType = Current . Services . ContentTypeService . Get ( content . ContentType . Id ) ;
if ( publishedContentContentType = = null )
throw new NullReferenceException ( "No content type returned for published content (contentType='" + content . ContentType . Id + "')" ) ;
return publishedContentContentType . IsAllowedTemplate ( templateId ) ;
2018-09-06 13:07:09 +02:00
}
public static bool IsAllowedTemplate ( this IPublishedContent content , string templateAlias )
{
2018-09-06 14:10:10 +02:00
var template = Current . Services . FileService . GetTemplate ( templateAlias ) ;
return template ! = null & & content . IsAllowedTemplate ( template . Id ) ;
2018-09-06 13:07:09 +02:00
}
#endregion
#region IsComposedOf
/// <summary>
/// Gets a value indicating whether the content is of a content type composed of the given alias
/// </summary>
/// <param name="content">The content.</param>
/// <param name="alias">The content type alias.</param>
/// <returns>A value indicating whether the content is of a content type composed of a content type identified by the alias.</returns>
public static bool IsComposedOf ( this IPublishedContent content , string alias )
{
return content . ContentType . CompositionAliases . Contains ( alias ) ;
2018-06-29 19:52:40 +02:00
}
#endregion
#region Template
/// <summary>
/// Returns the current template Alias
/// </summary>
/// <param name="content"></param>
2018-11-15 07:23:09 +00:00
/// <returns>Empty string if none is set.</returns>
2018-06-29 19:52:40 +02:00
public static string GetTemplateAlias ( this IPublishedContent content )
{
2018-11-15 07:23:09 +00:00
if ( content . TemplateId . HasValue = = false )
{
return string . Empty ;
}
var template = Current . Services . FileService . GetTemplate ( content . TemplateId . Value ) ;
2018-06-29 19:52:40 +02:00
return template = = null ? string . Empty : template . Alias ;
}
#endregion
2018-12-13 15:08:12 +01:00
#region HasValue , Value , Value < T >
2018-06-29 19:52:40 +02:00
/// <summary>
/// Gets a value indicating whether the content has a value for a property identified by its alias.
/// </summary>
/// <param name="content">The content.</param>
/// <param name="alias">The property alias.</param>
2018-12-13 15:08:12 +01:00
/// <param name="culture">The variation language.</param>
/// <param name="segment">The variation segment.</param>
/// <param name="fallback">Optional fallback strategy.</param>
2018-06-29 19:52:40 +02:00
/// <returns>A value indicating whether the content has a value for the property identified by the alias.</returns>
2018-12-13 15:08:12 +01:00
/// <remarks>Returns true if HasValue is true, or a fallback strategy can provide a value.</remarks>
public static bool HasValue ( this IPublishedContent content , string alias , string culture = null , string segment = null , Fallback fallback = default )
2018-06-29 19:52:40 +02:00
{
2018-12-13 15:08:12 +01:00
var property = content . GetProperty ( alias ) ;
2018-06-29 19:52:40 +02:00
2018-12-13 15:08:12 +01:00
// if we have a property, and it has a value, return that value
if ( property ! = null & & property . HasValue ( culture , segment ) )
return true ;
2018-06-29 19:52:40 +02:00
2018-12-13 15:08:12 +01:00
// else let fallback try to get a value
2019-01-21 14:27:11 +01:00
return PublishedValueFallback . TryGetValue ( content , alias , culture , segment , fallback , null , out _ , out _ ) ;
2018-06-29 19:52:40 +02:00
}
/// <summary>
2018-07-21 15:58:49 +02:00
/// Gets the value of a content's property identified by its alias, if it exists, otherwise a default value.
2018-06-29 19:52:40 +02:00
/// </summary>
/// <param name="content">The content.</param>
/// <param name="alias">The property alias.</param>
/// <param name="culture">The variation language.</param>
/// <param name="segment">The variation segment.</param>
2018-07-24 13:32:29 +02:00
/// <param name="fallback">Optional fallback strategy.</param>
2018-10-03 10:31:35 +02:00
/// <param name="defaultValue">The default value.</param>
2018-06-29 19:52:40 +02:00
/// <returns>The value of the content's property identified by the alias, if it exists, otherwise a default value.</returns>
2018-10-03 10:31:35 +02:00
public static object Value ( this IPublishedContent content , string alias , string culture = null , string segment = null , Fallback fallback = default , object defaultValue = default )
2018-06-29 19:52:40 +02:00
{
var property = content . GetProperty ( alias ) ;
2018-10-03 10:31:35 +02:00
// if we have a property, and it has a value, return that value
2018-06-29 19:52:40 +02:00
if ( property ! = null & & property . HasValue ( culture , segment ) )
return property . GetValue ( culture , segment ) ;
2018-10-03 10:31:35 +02:00
// else let fallback try to get a value
2019-01-21 14:27:11 +01:00
if ( PublishedValueFallback . TryGetValue ( content , alias , culture , segment , fallback , defaultValue , out var value , out property ) )
2018-10-03 10:31:35 +02:00
return value ;
// else... if we have a property, at least let the converter return its own
2018-12-13 15:08:12 +01:00
// vision of 'no value' (could be an empty enumerable)
2019-01-21 14:27:11 +01:00
return property ? . GetValue ( culture , segment ) ;
2018-06-29 19:52:40 +02:00
}
/// <summary>
2018-07-21 15:58:49 +02:00
/// Gets the value of a content's property identified by its alias, converted to a specified type.
2018-06-29 19:52:40 +02:00
/// </summary>
/// <typeparam name="T">The target property type.</typeparam>
/// <param name="content">The content.</param>
/// <param name="alias">The property alias.</param>
/// <param name="culture">The variation language.</param>
/// <param name="segment">The variation segment.</param>
2018-07-24 13:32:29 +02:00
/// <param name="fallback">Optional fallback strategy.</param>
2018-10-03 10:31:35 +02:00
/// <param name="defaultValue">The default value.</param>
2018-06-29 19:52:40 +02:00
/// <returns>The value of the content's property identified by the alias, converted to the specified type.</returns>
2018-10-03 10:31:35 +02:00
public static T Value < T > ( this IPublishedContent content , string alias , string culture = null , string segment = null , Fallback fallback = default , T defaultValue = default )
2018-06-29 19:52:40 +02:00
{
var property = content . GetProperty ( alias ) ;
2018-10-03 10:31:35 +02:00
// if we have a property, and it has a value, return that value
2018-06-29 19:52:40 +02:00
if ( property ! = null & & property . HasValue ( culture , segment ) )
return property . Value < T > ( culture , segment ) ;
2018-10-03 10:31:35 +02:00
// else let fallback try to get a value
2019-01-21 14:27:11 +01:00
if ( PublishedValueFallback . TryGetValue ( content , alias , culture , segment , fallback , defaultValue , out var value , out property ) )
2018-10-03 10:31:35 +02:00
return value ;
// else... if we have a property, at least let the converter return its own
// vision of 'no value' (could be an empty enumerable) - otherwise, default
return property = = null ? default : property . Value < T > ( culture , segment ) ;
2018-06-29 19:52:40 +02:00
}
#endregion
2018-07-30 10:10:01 +02:00
#region Variations
/// <summary>
/// Determines whether the content has a culture.
/// </summary>
/// <remarks>Culture is case-insensitive.</remarks>
public static bool HasCulture ( this IPublishedContent content , string culture )
2019-01-23 15:35:20 +01:00
= > content . Cultures . ContainsKey ( culture ? ? string . Empty ) ;
2018-07-30 10:10:01 +02:00
2019-01-16 08:21:24 +01:00
/// <summary>
2019-01-17 18:03:07 +01:00
/// Filters a sequence of <see cref="IPublishedContent"/> to return invariant items, and items that are published for the specified culture.
2019-01-16 08:21:24 +01:00
/// </summary>
2019-01-17 18:03:07 +01:00
/// <param name="contents">The content items.</param>
/// <param name="culture">The specific culture to filter for. If null is used the current culture is used. (Default is null).</param>
2019-03-05 13:02:59 +01:00
internal static IEnumerable < T > WhereIsInvariantOrHasCulture < T > ( this IEnumerable < T > contents , string culture = null )
where T : class , IPublishedContent
2019-01-16 08:21:24 +01:00
{
if ( contents = = null ) throw new ArgumentNullException ( nameof ( contents ) ) ;
2019-01-17 18:03:07 +01:00
culture = culture ? ? Current . VariationContextAccessor . VariationContext ? . Culture ? ? "" ;
2019-01-16 08:21:24 +01:00
2019-01-17 18:03:07 +01:00
// either does not vary by culture, or has the specified culture
return contents . Where ( x = > ! x . ContentType . VariesByCulture ( ) | | x . HasCulture ( culture ) ) ;
2019-01-16 08:21:24 +01:00
}
2019-01-17 18:03:07 +01:00
2018-07-30 10:10:01 +02:00
#endregion
2018-06-29 19:52:40 +02:00
#region Search
2018-12-17 12:17:03 +11:00
public static IEnumerable < PublishedSearchResult > SearchDescendants ( this IPublishedContent content , string term , string indexName = null )
2018-06-29 19:52:40 +02:00
{
2019-01-27 01:17:32 -05:00
// TODO: inject examine manager
2018-06-29 19:52:40 +02:00
2018-12-11 15:42:32 +11:00
indexName = string . IsNullOrEmpty ( indexName ) ? Constants . UmbracoIndexes . ExternalIndexName : indexName ;
2018-12-03 22:10:56 +11:00
if ( ! ExamineManager . Instance . TryGetIndex ( indexName , out var index ) )
throw new InvalidOperationException ( "No index found with name " + indexName ) ;
2018-06-29 19:52:40 +02:00
2018-12-03 22:10:56 +11:00
var searcher = index . GetSearcher ( ) ;
2018-06-29 19:52:40 +02:00
2018-12-17 12:17:03 +11:00
//var t = term.Escape().Value;
//var luceneQuery = "+__Path:(" + content.Path.Replace("-", "\\-") + "*) +" + t;
2018-06-29 19:52:40 +02:00
2018-12-17 12:17:03 +11:00
var query = searcher . CreateQuery ( )
. Field ( UmbracoExamineIndex . IndexPathFieldName , ( content . Path + "," ) . MultipleCharacterWildcard ( ) )
. And ( )
. ManagedQuery ( term ) ;
2018-06-29 19:52:40 +02:00
2019-02-14 09:49:45 +01:00
return query . Execute ( ) . ToPublishedSearchResults ( Current . UmbracoContext . ContentCache ) ;
2018-06-29 19:52:40 +02:00
}
2018-12-17 12:17:03 +11:00
public static IEnumerable < PublishedSearchResult > SearchChildren ( this IPublishedContent content , string term , string indexName = null )
2018-06-29 19:52:40 +02:00
{
2019-01-27 01:17:32 -05:00
// TODO: inject examine manager
2018-06-29 19:52:40 +02:00
2018-12-11 15:42:32 +11:00
indexName = string . IsNullOrEmpty ( indexName ) ? Constants . UmbracoIndexes . ExternalIndexName : indexName ;
2018-12-03 22:10:56 +11:00
if ( ! ExamineManager . Instance . TryGetIndex ( indexName , out var index ) )
throw new InvalidOperationException ( "No index found with name " + indexName ) ;
2018-06-29 19:52:40 +02:00
2018-12-03 22:10:56 +11:00
var searcher = index . GetSearcher ( ) ;
2018-06-29 19:52:40 +02:00
2018-12-17 12:17:03 +11:00
//var t = term.Escape().Value;
//var luceneQuery = "+parentID:" + content.Id + " +" + t;
2018-06-29 19:52:40 +02:00
2018-12-17 12:17:03 +11:00
var query = searcher . CreateQuery ( )
. Field ( "parentID" , content . Id )
. And ( )
. ManagedQuery ( term ) ;
2018-06-29 19:52:40 +02:00
2019-02-14 09:49:45 +01:00
return query . Execute ( ) . ToPublishedSearchResults ( Current . UmbracoContext . ContentCache ) ;
2018-06-29 19:52:40 +02:00
}
#endregion
#region IsSomething : misc .
/// <summary>
/// Determines whether the specified content is a specified content type.
/// </summary>
/// <param name="content">The content to determine content type of.</param>
/// <param name="docTypeAlias">The alias of the content type to test against.</param>
/// <returns>True if the content is of the specified content type; otherwise false.</returns>
public static bool IsDocumentType ( this IPublishedContent content , string docTypeAlias )
{
return content . ContentType . Alias . InvariantEquals ( docTypeAlias ) ;
}
/// <summary>
/// Determines whether the specified content is a specified content type or it's derived types.
/// </summary>
/// <param name="content">The content to determine content type of.</param>
/// <param name="docTypeAlias">The alias of the content type to test against.</param>
/// <param name="recursive">When true, recurses up the content type tree to check inheritance; when false just calls IsDocumentType(this IPublishedContent content, string docTypeAlias).</param>
/// <returns>True if the content is of the specified content type or a derived content type; otherwise false.</returns>
public static bool IsDocumentType ( this IPublishedContent content , string docTypeAlias , bool recursive )
{
if ( content . IsDocumentType ( docTypeAlias ) )
return true ;
return recursive & & content . IsComposedOf ( docTypeAlias ) ;
}
#endregion
#region IsSomething : equality
public static bool IsEqual ( this IPublishedContent content , IPublishedContent other )
{
return content . Id = = other . Id ;
}
public static HtmlString IsEqual ( this IPublishedContent content , IPublishedContent other , string valueIfTrue )
{
return content . IsEqual ( other , valueIfTrue , string . Empty ) ;
}
public static HtmlString IsEqual ( this IPublishedContent content , IPublishedContent other , string valueIfTrue , string valueIfFalse )
{
return new HtmlString ( content . IsEqual ( other ) ? valueIfTrue : valueIfFalse ) ;
}
public static bool IsNotEqual ( this IPublishedContent content , IPublishedContent other )
{
return content . IsEqual ( other ) = = false ;
}
public static HtmlString IsNotEqual ( this IPublishedContent content , IPublishedContent other , string valueIfTrue )
{
return content . IsNotEqual ( other , valueIfTrue , string . Empty ) ;
}
public static HtmlString IsNotEqual ( this IPublishedContent content , IPublishedContent other , string valueIfTrue , string valueIfFalse )
{
return new HtmlString ( content . IsNotEqual ( other ) ? valueIfTrue : valueIfFalse ) ;
}
#endregion
#region IsSomething : ancestors and descendants
public static bool IsDescendant ( this IPublishedContent content , IPublishedContent other )
{
2018-07-30 21:31:35 +10:00
return other . Level < content . Level & & content . Path . InvariantStartsWith ( other . Path . EnsureEndsWith ( ',' ) ) ;
2018-06-29 19:52:40 +02:00
}
public static HtmlString IsDescendant ( this IPublishedContent content , IPublishedContent other , string valueIfTrue )
{
return content . IsDescendant ( other , valueIfTrue , string . Empty ) ;
}
public static HtmlString IsDescendant ( this IPublishedContent content , IPublishedContent other , string valueIfTrue , string valueIfFalse )
{
return new HtmlString ( content . IsDescendant ( other ) ? valueIfTrue : valueIfFalse ) ;
}
public static bool IsDescendantOrSelf ( this IPublishedContent content , IPublishedContent other )
{
2018-07-30 21:31:35 +10:00
return content . Path . InvariantEquals ( other . Path ) | | content . IsDescendant ( other ) ;
2018-06-29 19:52:40 +02:00
}
public static HtmlString IsDescendantOrSelf ( this IPublishedContent content , IPublishedContent other , string valueIfTrue )
{
return content . IsDescendantOrSelf ( other , valueIfTrue , string . Empty ) ;
}
public static HtmlString IsDescendantOrSelf ( this IPublishedContent content , IPublishedContent other , string valueIfTrue , string valueIfFalse )
{
return new HtmlString ( content . IsDescendantOrSelf ( other ) ? valueIfTrue : valueIfFalse ) ;
}
public static bool IsAncestor ( this IPublishedContent content , IPublishedContent other )
{
2018-07-30 21:31:35 +10:00
return content . Level < other . Level & & other . Path . InvariantStartsWith ( content . Path . EnsureEndsWith ( ',' ) ) ;
2018-06-29 19:52:40 +02:00
}
public static HtmlString IsAncestor ( this IPublishedContent content , IPublishedContent other , string valueIfTrue )
{
return content . IsAncestor ( other , valueIfTrue , string . Empty ) ;
}
public static HtmlString IsAncestor ( this IPublishedContent content , IPublishedContent other , string valueIfTrue , string valueIfFalse )
{
return new HtmlString ( content . IsAncestor ( other ) ? valueIfTrue : valueIfFalse ) ;
}
public static bool IsAncestorOrSelf ( this IPublishedContent content , IPublishedContent other )
{
2018-07-30 21:31:35 +10:00
return other . Path . InvariantEquals ( content . Path ) | | content . IsAncestor ( other ) ;
2018-06-29 19:52:40 +02:00
}
public static HtmlString IsAncestorOrSelf ( this IPublishedContent content , IPublishedContent other , string valueIfTrue )
{
return content . IsAncestorOrSelf ( other , valueIfTrue , string . Empty ) ;
}
public static HtmlString IsAncestorOrSelf ( this IPublishedContent content , IPublishedContent other , string valueIfTrue , string valueIfFalse )
{
return new HtmlString ( content . IsAncestorOrSelf ( other ) ? valueIfTrue : valueIfFalse ) ;
}
#endregion
#region Axes : ancestors , ancestors - or - self
// as per XPath 1.0 specs <20> 2.2,
// - the ancestor axis contains the ancestors of the context node; the ancestors of the context node consist
// of the parent of context node and the parent's parent and so on; thus, the ancestor axis will always
// include the root node, unless the context node is the root node.
// - the ancestor-or-self axis contains the context node and the ancestors of the context node; thus,
// the ancestor axis will always include the root node.
//
// as per XPath 2.0 specs <20> 3.2.1.1,
// - the ancestor axis is defined as the transitive closure of the parent axis; it contains the ancestors
// of the context node (the parent, the parent of the parent, and so on) - The ancestor axis includes the
// root node of the tree in which the context node is found, unless the context node is the root node.
// - the ancestor-or-self axis contains the context node and the ancestors of the context node; thus,
// the ancestor-or-self axis will always include the root node.
//
// the ancestor and ancestor-or-self axis are reverse axes ie they contain the context node or nodes that
// are before the context node in document order.
//
// document order is defined by <20> 2.4.1 as:
// - the root node is the first node.
// - every node occurs before all of its children and descendants.
// - the relative order of siblings is the order in which they occur in the children property of their parent node.
// - children and descendants occur before following siblings.
/// <summary>
/// Gets the ancestors of the content.
/// </summary>
/// <param name="content">The content.</param>
/// <returns>The ancestors of the content, in down-top order.</returns>
/// <remarks>Does not consider the content itself.</remarks>
public static IEnumerable < IPublishedContent > Ancestors ( this IPublishedContent content )
{
return content . AncestorsOrSelf ( false , null ) ;
}
/// <summary>
/// Gets the ancestors of the content, at a level lesser or equal to a specified level.
/// </summary>
/// <param name="content">The content.</param>
/// <param name="maxLevel">The level.</param>
/// <returns>The ancestors of the content, at a level lesser or equal to the specified level, in down-top order.</returns>
/// <remarks>Does not consider the content itself. Only content that are "high enough" in the tree are returned.</remarks>
public static IEnumerable < IPublishedContent > Ancestors ( this IPublishedContent content , int maxLevel )
{
return content . AncestorsOrSelf ( false , n = > n . Level < = maxLevel ) ;
}
/// <summary>
/// Gets the ancestors of the content, of a specified content type.
/// </summary>
/// <param name="content">The content.</param>
/// <param name="contentTypeAlias">The content type.</param>
/// <returns>The ancestors of the content, of the specified content type, in down-top order.</returns>
/// <remarks>Does not consider the content itself. Returns all ancestors, of the specified content type.</remarks>
public static IEnumerable < IPublishedContent > Ancestors ( this IPublishedContent content , string contentTypeAlias )
{
return content . AncestorsOrSelf ( false , n = > n . ContentType . Alias = = contentTypeAlias ) ;
}
/// <summary>
/// Gets the ancestors of the content, of a specified content type.
/// </summary>
/// <typeparam name="T">The content type.</typeparam>
/// <param name="content">The content.</param>
/// <returns>The ancestors of the content, of the specified content type, in down-top order.</returns>
/// <remarks>Does not consider the content itself. Returns all ancestors, of the specified content type.</remarks>
public static IEnumerable < T > Ancestors < T > ( this IPublishedContent content )
where T : class , IPublishedContent
{
return content . Ancestors ( ) . OfType < T > ( ) ;
}
/// <summary>
/// Gets the ancestors of the content, at a level lesser or equal to a specified level, and of a specified content type.
/// </summary>
/// <typeparam name="T">The content type.</typeparam>
/// <param name="content">The content.</param>
/// <param name="maxLevel">The level.</param>
/// <returns>The ancestors of the content, at a level lesser or equal to the specified level, and of the specified
/// content type, in down-top order.</returns>
/// <remarks>Does not consider the content itself. Only content that are "high enough" in the trees, and of the
/// specified content type, are returned.</remarks>
public static IEnumerable < T > Ancestors < T > ( this IPublishedContent content , int maxLevel )
where T : class , IPublishedContent
{
return content . Ancestors ( maxLevel ) . OfType < T > ( ) ;
}
/// <summary>
/// Gets the content and its ancestors.
/// </summary>
/// <param name="content">The content.</param>
/// <returns>The content and its ancestors, in down-top order.</returns>
public static IEnumerable < IPublishedContent > AncestorsOrSelf ( this IPublishedContent content )
{
return content . AncestorsOrSelf ( true , null ) ;
}
/// <summary>
/// Gets the content and its ancestors, at a level lesser or equal to a specified level.
/// </summary>
/// <param name="content">The content.</param>
/// <param name="maxLevel">The level.</param>
/// <returns>The content and its ancestors, at a level lesser or equal to the specified level,
/// in down-top order.</returns>
/// <remarks>Only content that are "high enough" in the tree are returned. So it may or may not begin
/// with the content itself, depending on its level.</remarks>
public static IEnumerable < IPublishedContent > AncestorsOrSelf ( this IPublishedContent content , int maxLevel )
{
return content . AncestorsOrSelf ( true , n = > n . Level < = maxLevel ) ;
}
/// <summary>
/// Gets the content and its ancestors, of a specified content type.
/// </summary>
/// <param name="content">The content.</param>
/// <param name="contentTypeAlias">The content type.</param>
/// <returns>The content and its ancestors, of the specified content type, in down-top order.</returns>
/// <remarks>May or may not begin with the content itself, depending on its content type.</remarks>
public static IEnumerable < IPublishedContent > AncestorsOrSelf ( this IPublishedContent content , string contentTypeAlias )
{
return content . AncestorsOrSelf ( true , n = > n . ContentType . Alias = = contentTypeAlias ) ;
}
/// <summary>
/// Gets the content and its ancestors, of a specified content type.
/// </summary>
/// <typeparam name="T">The content type.</typeparam>
/// <param name="content">The content.</param>
/// <returns>The content and its ancestors, of the specified content type, in down-top order.</returns>
/// <remarks>May or may not begin with the content itself, depending on its content type.</remarks>
public static IEnumerable < T > AncestorsOrSelf < T > ( this IPublishedContent content )
where T : class , IPublishedContent
{
return content . AncestorsOrSelf ( ) . OfType < T > ( ) ;
}
/// <summary>
/// Gets the content and its ancestor, at a lever lesser or equal to a specified level, and of a specified content type.
/// </summary>
/// <typeparam name="T">The content type.</typeparam>
/// <param name="content">The content.</param>
/// <param name="maxLevel">The level.</param>
/// <returns>The content and its ancestors, at a level lesser or equal to the specified level, and of the specified
/// content type, in down-top order.</returns>
/// <remarks>May or may not begin with the content itself, depending on its level and content type.</remarks>
public static IEnumerable < T > AncestorsOrSelf < T > ( this IPublishedContent content , int maxLevel )
where T : class , IPublishedContent
{
return content . AncestorsOrSelf ( maxLevel ) . OfType < T > ( ) ;
}
/// <summary>
/// Gets the ancestor of the content, ie its parent.
/// </summary>
/// <param name="content">The content.</param>
/// <returns>The ancestor of the content.</returns>
/// <remarks>This method is here for consistency purposes but does not make much sense.</remarks>
public static IPublishedContent Ancestor ( this IPublishedContent content )
{
return content . Parent ;
}
/// <summary>
/// Gets the nearest ancestor of the content, at a lever lesser or equal to a specified level.
/// </summary>
/// <param name="content">The content.</param>
/// <param name="maxLevel">The level.</param>
/// <returns>The nearest (in down-top order) ancestor of the content, at a level lesser or equal to the specified level.</returns>
/// <remarks>Does not consider the content itself. May return <c>null</c>.</remarks>
public static IPublishedContent Ancestor ( this IPublishedContent content , int maxLevel )
{
return content . EnumerateAncestors ( false ) . FirstOrDefault ( x = > x . Level < = maxLevel ) ;
}
/// <summary>
/// Gets the nearest ancestor of the content, of a specified content type.
/// </summary>
/// <param name="content">The content.</param>
/// <param name="contentTypeAlias">The content type alias.</param>
/// <returns>The nearest (in down-top order) ancestor of the content, of the specified content type.</returns>
/// <remarks>Does not consider the content itself. May return <c>null</c>.</remarks>
public static IPublishedContent Ancestor ( this IPublishedContent content , string contentTypeAlias )
{
return content . EnumerateAncestors ( false ) . FirstOrDefault ( x = > x . ContentType . Alias = = contentTypeAlias ) ;
}
/// <summary>
/// Gets the nearest ancestor of the content, of a specified content type.
/// </summary>
/// <typeparam name="T">The content type.</typeparam>
/// <param name="content">The content.</param>
/// <returns>The nearest (in down-top order) ancestor of the content, of the specified content type.</returns>
/// <remarks>Does not consider the content itself. May return <c>null</c>.</remarks>
public static T Ancestor < T > ( this IPublishedContent content )
where T : class , IPublishedContent
{
return content . Ancestors < T > ( ) . FirstOrDefault ( ) ;
}
/// <summary>
/// Gets the nearest ancestor of the content, at the specified level and of the specified content type.
/// </summary>
/// <typeparam name="T">The content type.</typeparam>
/// <param name="content">The content.</param>
/// <param name="maxLevel">The level.</param>
/// <returns>The ancestor of the content, at the specified level and of the specified content type.</returns>
/// <remarks>Does not consider the content itself. If the ancestor at the specified level is
/// not of the specified type, returns <c>null</c>.</remarks>
public static T Ancestor < T > ( this IPublishedContent content , int maxLevel )
where T : class , IPublishedContent
{
return content . Ancestors < T > ( maxLevel ) . FirstOrDefault ( ) ;
}
/// <summary>
/// Gets the content or its nearest ancestor.
/// </summary>
/// <param name="content">The content.</param>
/// <returns>The content.</returns>
/// <remarks>This method is here for consistency purposes but does not make much sense.</remarks>
public static IPublishedContent AncestorOrSelf ( this IPublishedContent content )
{
return content ;
}
/// <summary>
/// Gets the content or its nearest ancestor, at a lever lesser or equal to a specified level.
/// </summary>
/// <param name="content">The content.</param>
/// <param name="maxLevel">The level.</param>
/// <returns>The content or its nearest (in down-top order) ancestor, at a level lesser or equal to the specified level.</returns>
/// <remarks>May or may not return the content itself depending on its level. May return <c>null</c>.</remarks>
public static IPublishedContent AncestorOrSelf ( this IPublishedContent content , int maxLevel )
{
return content . EnumerateAncestors ( true ) . FirstOrDefault ( x = > x . Level < = maxLevel ) ;
}
/// <summary>
/// Gets the content or its nearest ancestor, of a specified content type.
/// </summary>
/// <param name="content">The content.</param>
/// <param name="contentTypeAlias">The content type.</param>
/// <returns>The content or its nearest (in down-top order) ancestor, of the specified content type.</returns>
/// <remarks>May or may not return the content itself depending on its content type. May return <c>null</c>.</remarks>
public static IPublishedContent AncestorOrSelf ( this IPublishedContent content , string contentTypeAlias )
{
return content . EnumerateAncestors ( true ) . FirstOrDefault ( x = > x . ContentType . Alias = = contentTypeAlias ) ;
}
/// <summary>
/// Gets the content or its nearest ancestor, of a specified content type.
/// </summary>
/// <typeparam name="T">The content type.</typeparam>
/// <param name="content">The content.</param>
/// <returns>The content or its nearest (in down-top order) ancestor, of the specified content type.</returns>
/// <remarks>May or may not return the content itself depending on its content type. May return <c>null</c>.</remarks>
public static T AncestorOrSelf < T > ( this IPublishedContent content )
where T : class , IPublishedContent
{
return content . AncestorsOrSelf < T > ( ) . FirstOrDefault ( ) ;
}
/// <summary>
/// Gets the content or its nearest ancestor, at a lever lesser or equal to a specified level, and of a specified content type.
/// </summary>
/// <typeparam name="T">The content type.</typeparam>
/// <param name="content">The content.</param>
/// <param name="maxLevel">The level.</param>
/// <returns></returns>
public static T AncestorOrSelf < T > ( this IPublishedContent content , int maxLevel )
where T : class , IPublishedContent
{
return content . AncestorsOrSelf < T > ( maxLevel ) . FirstOrDefault ( ) ;
}
public static IEnumerable < IPublishedContent > AncestorsOrSelf ( this IPublishedContent content , bool orSelf , Func < IPublishedContent , bool > func )
{
var ancestorsOrSelf = content . EnumerateAncestors ( orSelf ) ;
return func = = null ? ancestorsOrSelf : ancestorsOrSelf . Where ( func ) ;
}
/// <summary>
/// Enumerates ancestors of the content, bottom-up.
/// </summary>
/// <param name="content">The content.</param>
/// <param name="orSelf">Indicates whether the content should be included.</param>
/// <returns>Enumerates bottom-up ie walking up the tree (parent, grand-parent, etc).</returns>
internal static IEnumerable < IPublishedContent > EnumerateAncestors ( this IPublishedContent content , bool orSelf )
{
if ( content = = null ) throw new ArgumentNullException ( nameof ( content ) ) ;
if ( orSelf ) yield return content ;
while ( ( content = content . Parent ) ! = null )
yield return content ;
}
#endregion
#region Axes : descendants , descendants - or - self
/// <summary>
/// Returns all DescendantsOrSelf of all content referenced
/// </summary>
/// <param name="parentNodes"></param>
/// <param name="docTypeAlias"></param>
2019-01-16 08:21:24 +01:00
/// <param name="culture">The specific culture to filter for. If null is used the current culture is used. (Default is null)</param>
2018-06-29 19:52:40 +02:00
/// <returns></returns>
/// <remarks>
/// This can be useful in order to return all nodes in an entire site by a type when combined with TypedContentAtRoot
/// </remarks>
2019-01-24 15:29:50 +01:00
public static IEnumerable < IPublishedContent > DescendantsOrSelfOfType ( this IEnumerable < IPublishedContent > parentNodes , string docTypeAlias , string culture = null )
2018-06-29 19:52:40 +02:00
{
2019-01-24 15:29:50 +01:00
return parentNodes . SelectMany ( x = > x . DescendantsOrSelfOfType ( docTypeAlias , culture ) ) ;
2018-06-29 19:52:40 +02:00
}
/// <summary>
/// Returns all DescendantsOrSelf of all content referenced
/// </summary>
/// <param name="parentNodes"></param>
2019-01-16 08:21:24 +01:00
/// <param name="culture">The specific culture to filter for. If null is used the current culture is used. (Default is null)</param>
2018-06-29 19:52:40 +02:00
/// <returns></returns>
/// <remarks>
/// This can be useful in order to return all nodes in an entire site by a type when combined with TypedContentAtRoot
/// </remarks>
2019-01-16 08:21:24 +01:00
public static IEnumerable < T > DescendantsOrSelf < T > ( this IEnumerable < IPublishedContent > parentNodes , string culture = null )
2018-06-29 19:52:40 +02:00
where T : class , IPublishedContent
{
2019-01-16 08:21:24 +01:00
return parentNodes . SelectMany ( x = > x . DescendantsOrSelf < T > ( culture ) ) ;
2018-06-29 19:52:40 +02:00
}
// as per XPath 1.0 specs <20> 2.2,
// - the descendant axis contains the descendants of the context node; a descendant is a child or a child of a child and so on; thus
// the descendant axis never contains attribute or namespace nodes.
// - the descendant-or-self axis contains the context node and the descendants of the context node.
//
// as per XPath 2.0 specs <20> 3.2.1.1,
// - the descendant axis is defined as the transitive closure of the child axis; it contains the descendants of the context node (the
// children, the children of the children, and so on).
// - the descendant-or-self axis contains the context node and the descendants of the context node.
//
// the descendant and descendant-or-self axis are forward axes ie they contain the context node or nodes that are after the context
// node in document order.
//
// document order is defined by <20> 2.4.1 as:
// - the root node is the first node.
// - every node occurs before all of its children and descendants.
// - the relative order of siblings is the order in which they occur in the children property of their parent node.
// - children and descendants occur before following siblings.
2019-01-16 08:21:24 +01:00
public static IEnumerable < IPublishedContent > Descendants ( this IPublishedContent content , string culture = null )
2018-06-29 19:52:40 +02:00
{
2019-01-16 08:21:24 +01:00
return content . DescendantsOrSelf ( false , null , culture ) ;
2018-06-29 19:52:40 +02:00
}
2019-01-16 08:21:24 +01:00
public static IEnumerable < IPublishedContent > Descendants ( this IPublishedContent content , int level , string culture = null )
2018-06-29 19:52:40 +02:00
{
2019-01-16 08:21:24 +01:00
return content . DescendantsOrSelf ( false , p = > p . Level > = level , culture ) ;
2018-06-29 19:52:40 +02:00
}
2019-01-24 15:29:50 +01:00
public static IEnumerable < IPublishedContent > DescendantsOfType ( this IPublishedContent content , string contentTypeAlias , string culture = null )
2018-06-29 19:52:40 +02:00
{
2019-01-16 08:21:24 +01:00
return content . DescendantsOrSelf ( false , p = > p . ContentType . Alias = = contentTypeAlias , culture ) ;
2018-06-29 19:52:40 +02:00
}
2019-01-16 08:21:24 +01:00
public static IEnumerable < T > Descendants < T > ( this IPublishedContent content , string culture = null )
2018-06-29 19:52:40 +02:00
where T : class , IPublishedContent
{
2019-01-16 08:21:24 +01:00
return content . Descendants ( culture ) . OfType < T > ( ) ;
2018-06-29 19:52:40 +02:00
}
2019-01-16 08:21:24 +01:00
public static IEnumerable < T > Descendants < T > ( this IPublishedContent content , int level , string culture = null )
2018-06-29 19:52:40 +02:00
where T : class , IPublishedContent
{
2019-01-16 08:21:24 +01:00
return content . Descendants ( level , culture ) . OfType < T > ( ) ;
2018-06-29 19:52:40 +02:00
}
2019-01-16 08:21:24 +01:00
public static IEnumerable < IPublishedContent > DescendantsOrSelf ( this IPublishedContent content , string culture = null )
2018-06-29 19:52:40 +02:00
{
2019-01-16 08:21:24 +01:00
return content . DescendantsOrSelf ( true , null , culture ) ;
2018-06-29 19:52:40 +02:00
}
2019-01-16 08:21:24 +01:00
public static IEnumerable < IPublishedContent > DescendantsOrSelf ( this IPublishedContent content , int level , string culture = null )
2018-06-29 19:52:40 +02:00
{
2019-01-16 08:21:24 +01:00
return content . DescendantsOrSelf ( true , p = > p . Level > = level , culture ) ;
2018-06-29 19:52:40 +02:00
}
2019-01-24 15:29:50 +01:00
public static IEnumerable < IPublishedContent > DescendantsOrSelfOfType ( this IPublishedContent content , string contentTypeAlias , string culture = null )
2018-06-29 19:52:40 +02:00
{
2019-01-16 08:21:24 +01:00
return content . DescendantsOrSelf ( true , p = > p . ContentType . Alias = = contentTypeAlias , culture ) ;
2018-06-29 19:52:40 +02:00
}
2019-01-16 08:21:24 +01:00
public static IEnumerable < T > DescendantsOrSelf < T > ( this IPublishedContent content , string culture = null )
2018-06-29 19:52:40 +02:00
where T : class , IPublishedContent
{
2019-01-16 08:21:24 +01:00
return content . DescendantsOrSelf ( culture ) . OfType < T > ( ) ;
2018-06-29 19:52:40 +02:00
}
2019-01-16 08:21:24 +01:00
public static IEnumerable < T > DescendantsOrSelf < T > ( this IPublishedContent content , int level , string culture = null )
2018-06-29 19:52:40 +02:00
where T : class , IPublishedContent
{
2019-01-16 08:21:24 +01:00
return content . DescendantsOrSelf ( level , culture ) . OfType < T > ( ) ;
2018-06-29 19:52:40 +02:00
}
2019-01-15 14:54:34 +01:00
public static IPublishedContent Descendant ( this IPublishedContent content , string culture = null )
2018-06-29 19:52:40 +02:00
{
2019-01-15 14:54:34 +01:00
return content . Children ( culture ) . FirstOrDefault ( ) ;
2018-06-29 19:52:40 +02:00
}
2019-01-15 14:54:34 +01:00
public static IPublishedContent Descendant ( this IPublishedContent content , int level , string culture = null )
2018-06-29 19:52:40 +02:00
{
2019-01-15 14:54:34 +01:00
return content . EnumerateDescendants ( false , culture ) . FirstOrDefault ( x = > x . Level = = level ) ;
2018-06-29 19:52:40 +02:00
}
2019-01-24 15:29:50 +01:00
public static IPublishedContent DescendantOfType ( this IPublishedContent content , string contentTypeAlias , string culture = null )
2018-06-29 19:52:40 +02:00
{
2019-01-15 14:54:34 +01:00
return content . EnumerateDescendants ( false , culture ) . FirstOrDefault ( x = > x . ContentType . Alias = = contentTypeAlias ) ;
2018-06-29 19:52:40 +02:00
}
2019-01-15 14:54:34 +01:00
public static T Descendant < T > ( this IPublishedContent content , string culture = null )
2018-06-29 19:52:40 +02:00
where T : class , IPublishedContent
{
2019-01-15 14:54:34 +01:00
return content . EnumerateDescendants ( false , culture ) . FirstOrDefault ( x = > x is T ) as T ;
2018-06-29 19:52:40 +02:00
}
2019-01-15 14:54:34 +01:00
public static T Descendant < T > ( this IPublishedContent content , int level , string culture = null )
2018-06-29 19:52:40 +02:00
where T : class , IPublishedContent
{
2019-01-15 14:54:34 +01:00
return content . Descendant ( level , culture ) as T ;
2018-06-29 19:52:40 +02:00
}
2019-01-15 14:54:34 +01:00
public static IPublishedContent DescendantOrSelf ( this IPublishedContent content , string culture = null )
2018-06-29 19:52:40 +02:00
{
return content ;
}
2019-01-15 14:54:34 +01:00
public static IPublishedContent DescendantOrSelf ( this IPublishedContent content , int level , string culture = null )
2018-06-29 19:52:40 +02:00
{
2019-01-15 14:54:34 +01:00
return content . EnumerateDescendants ( true , culture ) . FirstOrDefault ( x = > x . Level = = level ) ;
2018-06-29 19:52:40 +02:00
}
2019-01-24 15:29:50 +01:00
public static IPublishedContent DescendantOrSelfOfType ( this IPublishedContent content , string contentTypeAlias , string culture = null )
2018-06-29 19:52:40 +02:00
{
2019-01-15 14:54:34 +01:00
return content . EnumerateDescendants ( true , culture ) . FirstOrDefault ( x = > x . ContentType . Alias = = contentTypeAlias ) ;
2018-06-29 19:52:40 +02:00
}
2019-01-15 14:54:34 +01:00
public static T DescendantOrSelf < T > ( this IPublishedContent content , string culture = null )
2018-06-29 19:52:40 +02:00
where T : class , IPublishedContent
{
2019-01-15 14:54:34 +01:00
return content . EnumerateDescendants ( true , culture ) . FirstOrDefault ( x = > x is T ) as T ;
2018-06-29 19:52:40 +02:00
}
2019-01-15 14:54:34 +01:00
public static T DescendantOrSelf < T > ( this IPublishedContent content , int level , string culture = null )
2018-06-29 19:52:40 +02:00
where T : class , IPublishedContent
{
2019-01-15 14:54:34 +01:00
return content . DescendantOrSelf ( level , culture ) as T ;
2018-06-29 19:52:40 +02:00
}
2019-01-15 14:54:34 +01:00
internal static IEnumerable < IPublishedContent > DescendantsOrSelf ( this IPublishedContent content , bool orSelf , Func < IPublishedContent , bool > func , string culture = null )
2018-06-29 19:52:40 +02:00
{
2019-01-15 14:54:34 +01:00
return content . EnumerateDescendants ( orSelf , culture ) . Where ( x = > func = = null | | func ( x ) ) ;
2018-06-29 19:52:40 +02:00
}
2019-01-15 14:54:34 +01:00
internal static IEnumerable < IPublishedContent > EnumerateDescendants ( this IPublishedContent content , bool orSelf , string culture = null )
2018-06-29 19:52:40 +02:00
{
if ( content = = null ) throw new ArgumentNullException ( nameof ( content ) ) ;
if ( orSelf ) yield return content ;
2019-01-15 14:54:34 +01:00
foreach ( var desc in content . Children ( culture ) . SelectMany ( x = > x . EnumerateDescendants ( ) ) )
2018-06-29 19:52:40 +02:00
yield return desc ;
}
2019-01-15 14:54:34 +01:00
internal static IEnumerable < IPublishedContent > EnumerateDescendants ( this IPublishedContent content , string culture = null )
2018-06-29 19:52:40 +02:00
{
yield return content ;
2019-01-15 14:54:34 +01:00
foreach ( var desc in content . Children ( culture ) . SelectMany ( x = > x . EnumerateDescendants ( ) ) )
2018-06-29 19:52:40 +02:00
yield return desc ;
}
#endregion
#region Axes : parent
// Parent is native
/// <summary>
/// Gets the parent of the content, of a given content type.
/// </summary>
/// <typeparam name="T">The content type.</typeparam>
/// <param name="content">The content.</param>
/// <returns>The parent of content, of the given content type, else null.</returns>
public static T Parent < T > ( this IPublishedContent content )
where T : class , IPublishedContent
{
if ( content = = null ) throw new ArgumentNullException ( nameof ( content ) ) ;
return content . Parent as T ;
}
#endregion
#region Axes : children
/// <summary>
/// Gets the children of the content.
/// </summary>
/// <param name="content">The content.</param>
2019-01-16 08:21:24 +01:00
/// <param name="culture">The specific culture to filter for. If null is used the current culture is used. (Default is null)</param>
2018-06-29 19:52:40 +02:00
/// <returns>The children of the content.</returns>
/// <remarks>
/// <para>Children are sorted by their sortOrder.</para>
/// <para>This method exists for consistency, it is the same as calling content.Children as a property.</para>
/// </remarks>
2019-01-15 14:54:34 +01:00
public static IEnumerable < IPublishedContent > Children ( this IPublishedContent content , string culture = null )
2018-06-29 19:52:40 +02:00
{
2019-01-24 12:17:30 +01:00
if ( content = = null ) throw new ArgumentNullException ( nameof ( content ) ) ;
2019-01-17 18:03:07 +01:00
return content . Children . WhereIsInvariantOrHasCulture ( culture ) ;
2018-06-29 19:52:40 +02:00
}
/// <summary>
/// Gets the children of the content, filtered by a predicate.
/// </summary>
/// <param name="content">The content.</param>
/// <param name="predicate">The predicate.</param>
2019-01-16 08:21:24 +01:00
/// <param name="culture">The specific culture to filter for. If null is used the current culture is used. (Default is null)</param>
2018-06-29 19:52:40 +02:00
/// <returns>The children of the content, filtered by the predicate.</returns>
/// <remarks>
/// <para>Children are sorted by their sortOrder.</para>
/// </remarks>
2019-01-15 14:54:34 +01:00
public static IEnumerable < IPublishedContent > Children ( this IPublishedContent content , Func < IPublishedContent , bool > predicate , string culture = null )
2018-06-29 19:52:40 +02:00
{
2019-01-15 14:54:34 +01:00
return content . Children ( culture ) . Where ( predicate ) ;
2018-06-29 19:52:40 +02:00
}
/// <summary>
/// Gets the children of the content, of any of the specified types.
/// </summary>
/// <param name="content">The content.</param>
2019-01-16 08:21:24 +01:00
/// <param name="culture">The specific culture to filter for. If null is used the current culture is used. (Default is null)</param>
2019-02-20 21:06:36 +11:00
/// <param name="contentTypeAlias">The content type alias.</param>
2018-06-29 19:52:40 +02:00
/// <returns>The children of the content, of any of the specified types.</returns>
2019-02-20 21:06:36 +11:00
public static IEnumerable < IPublishedContent > ChildrenOfType ( this IPublishedContent content , string contentTypeAlias , string culture = null )
2018-06-29 19:52:40 +02:00
{
2019-02-20 21:06:36 +11:00
return content . Children ( x = > contentTypeAlias . InvariantContains ( x . ContentType . Alias ) , culture ) ;
2018-06-29 19:52:40 +02:00
}
/// <summary>
/// Gets the children of the content, of a given content type.
/// </summary>
/// <typeparam name="T">The content type.</typeparam>
/// <param name="content">The content.</param>
2019-01-16 08:21:24 +01:00
/// <param name="culture">The specific culture to filter for. If null is used the current culture is used. (Default is null)</param>
2018-06-29 19:52:40 +02:00
/// <returns>The children of content, of the given content type.</returns>
/// <remarks>
/// <para>Children are sorted by their sortOrder.</para>
/// </remarks>
2019-01-15 14:54:34 +01:00
public static IEnumerable < T > Children < T > ( this IPublishedContent content , string culture = null )
2018-06-29 19:52:40 +02:00
where T : class , IPublishedContent
{
2019-01-15 14:54:34 +01:00
return content . Children ( culture ) . OfType < T > ( ) ;
2018-06-29 19:52:40 +02:00
}
2019-01-15 14:54:34 +01:00
public static IPublishedContent FirstChild ( this IPublishedContent content , string culture = null )
2018-06-29 19:52:40 +02:00
{
2019-01-15 14:54:34 +01:00
return content . Children ( culture ) . FirstOrDefault ( ) ;
2018-06-29 19:52:40 +02:00
}
/// <summary>
/// Gets the first child of the content, of a given content type.
/// </summary>
2019-02-20 21:06:36 +11:00
public static IPublishedContent FirstChildOfType ( this IPublishedContent content , string contentTypeAlias , string culture = null )
2018-06-29 19:52:40 +02:00
{
2019-02-20 21:06:36 +11:00
return content . ChildrenOfType ( contentTypeAlias , culture ) . FirstOrDefault ( ) ;
2018-06-29 19:52:40 +02:00
}
2019-01-15 14:54:34 +01:00
public static IPublishedContent FirstChild ( this IPublishedContent content , Func < IPublishedContent , bool > predicate , string culture = null )
2018-06-29 19:52:40 +02:00
{
2019-01-15 14:54:34 +01:00
return content . Children ( predicate , culture ) . FirstOrDefault ( ) ;
2018-06-29 19:52:40 +02:00
}
2019-01-18 08:34:14 +01:00
public static IPublishedContent FirstChild ( this IPublishedContent content , Guid uniqueId , string culture = null )
2019-01-17 13:33:44 +01:00
{
2019-01-18 08:34:14 +01:00
return content . Children ( x = > x . Key = = uniqueId , culture ) . FirstOrDefault ( ) ;
2019-01-17 13:33:44 +01:00
}
2019-01-15 14:54:34 +01:00
public static T FirstChild < T > ( this IPublishedContent content , string culture = null )
2018-06-29 19:52:40 +02:00
where T : class , IPublishedContent
{
2019-01-15 14:54:34 +01:00
return content . Children < T > ( culture ) . FirstOrDefault ( ) ;
2018-06-29 19:52:40 +02:00
}
2019-01-15 14:54:34 +01:00
public static T FirstChild < T > ( this IPublishedContent content , Func < T , bool > predicate , string culture = null )
2018-06-29 19:52:40 +02:00
where T : class , IPublishedContent
{
2019-01-15 14:54:34 +01:00
return content . Children < T > ( culture ) . FirstOrDefault ( predicate ) ;
2018-06-29 19:52:40 +02:00
}
/// <summary>
/// Gets the children of the content in a DataTable.
/// </summary>
/// <param name="content">The content.</param>
/// <param name="services">A service context.</param>
/// <param name="contentTypeAliasFilter">An optional content type alias.</param>
2019-01-16 08:21:24 +01:00
/// <param name="culture">The specific culture to filter for. If null is used the current culture is used. (Default is null)</param>
2018-06-29 19:52:40 +02:00
/// <returns>The children of the content.</returns>
2019-01-15 14:54:34 +01:00
public static DataTable ChildrenAsTable ( this IPublishedContent content , ServiceContext services , string contentTypeAliasFilter = "" , string culture = null )
2018-06-29 19:52:40 +02:00
{
2019-01-15 14:54:34 +01:00
return GenerateDataTable ( content , services , contentTypeAliasFilter , culture ) ;
2018-06-29 19:52:40 +02:00
}
/// <summary>
/// Gets the children of the content in a DataTable.
/// </summary>
/// <param name="content">The content.</param>
/// <param name="services">A service context.</param>
/// <param name="contentTypeAliasFilter">An optional content type alias.</param>
2019-01-16 08:21:24 +01:00
/// <param name="culture">The specific culture to filter for. If null is used the current culture is used. (Default is null)</param>
2018-06-29 19:52:40 +02:00
/// <returns>The children of the content.</returns>
2019-01-15 14:54:34 +01:00
private static DataTable GenerateDataTable ( IPublishedContent content , ServiceContext services , string contentTypeAliasFilter = "" , string culture = null )
2018-06-29 19:52:40 +02:00
{
var firstNode = contentTypeAliasFilter . IsNullOrWhiteSpace ( )
2019-01-15 14:54:34 +01:00
? content . Children ( culture ) . Any ( )
? content . Children ( culture ) . ElementAt ( 0 )
2018-06-29 19:52:40 +02:00
: null
2019-01-15 14:54:34 +01:00
: content . Children ( culture ) . FirstOrDefault ( x = > x . ContentType . Alias = = contentTypeAliasFilter ) ;
2018-06-29 19:52:40 +02:00
if ( firstNode = = null )
return new DataTable ( ) ; //no children found
//use new utility class to create table so that we don't have to maintain code in many places, just one
var dt = Core . DataTableExtensions . GenerateDataTable (
//pass in the alias of the first child node since this is the node type we're rendering headers for
firstNode . ContentType . Alias ,
//pass in the callback to extract the Dictionary<string, string> of all defined aliases to their names
alias = > GetPropertyAliasesAndNames ( services , alias ) ,
//pass in a callback to populate the datatable, yup its a bit ugly but it's already legacy and we just want to maintain code in one place.
( ) = >
{
//create all row data
var tableData = Core . DataTableExtensions . CreateTableData ( ) ;
//loop through each child and create row data for it
foreach ( var n in content . Children . OrderBy ( x = > x . SortOrder ) )
{
if ( contentTypeAliasFilter . IsNullOrWhiteSpace ( ) = = false )
{
if ( n . ContentType . Alias ! = contentTypeAliasFilter )
continue ; //skip this one, it doesn't match the filter
}
var standardVals = new Dictionary < string , object >
{
{ "Id" , n . Id } ,
{ "NodeName" , n . Name } ,
{ "NodeTypeAlias" , n . ContentType . Alias } ,
{ "CreateDate" , n . CreateDate } ,
{ "UpdateDate" , n . UpdateDate } ,
{ "CreatorName" , n . CreatorName } ,
{ "WriterName" , n . WriterName } ,
{ "Url" , n . Url }
} ;
var userVals = new Dictionary < string , object > ( ) ;
foreach ( var p in from IPublishedProperty p in n . Properties where p . GetSourceValue ( ) ! = null select p )
{
// probably want the "object value" of the property here...
userVals [ p . Alias ] = p . GetValue ( ) ;
}
//add the row data
Core . DataTableExtensions . AddRowData ( tableData , standardVals , userVals ) ;
}
return tableData ;
}
) ;
return dt ;
}
#endregion
2019-03-19 14:59:52 +01:00
#region Axes : Siblings
2019-03-05 13:02:59 +01:00
/// <summary>
2019-03-19 14:59:52 +01:00
/// Gets the siblings of the content.
2019-03-05 13:02:59 +01:00
/// </summary>
/// <param name="content">The content.</param>
/// <param name="culture">The specific culture to filter for. If null is used the current culture is used. (Default is null)</param>
2019-03-19 14:59:52 +01:00
/// <returns>The siblings of the content.</returns>
/// <remarks>
/// <para>Note that in V7 this method also return the content node self.</para>
/// </remarks>
public static IEnumerable < IPublishedContent > Siblings ( this IPublishedContent content , string culture = null )
{
return SiblingsAndSelf ( content , culture ) . Where ( x = > x . Id ! = content . Id ) ;
}
/// <summary>
/// Gets the siblings of the content, of a given content type.
/// </summary>
/// <param name="content">The content.</param>
/// <param name="culture">The specific culture to filter for. If null is used the current culture is used. (Default is null)</param>
/// <param name="contentTypeAlias">The content type alias.</param>
/// <returns>The siblings of the content, of the given content type.</returns>
/// <remarks>
/// <para>Note that in V7 this method also return the content node self.</para>
/// </remarks>
public static IEnumerable < IPublishedContent > SiblingsOfType ( this IPublishedContent content , string contentTypeAlias , string culture = null )
{
return SiblingsAndSelfOfType ( content , contentTypeAlias , culture ) . Where ( x = > x . Id ! = content . Id ) ;
}
/// <summary>
/// Gets the siblings of the content, of a given content type.
/// </summary>
/// <typeparam name="T">The content type.</typeparam>
/// <param name="content">The content.</param>
/// <param name="culture">The specific culture to filter for. If null is used the current culture is used. (Default is null)</param>
/// <returns>The siblings of the content, of the given content type.</returns>
/// <remarks>
/// <para>Note that in V7 this method also return the content node self.</para>
/// </remarks>
public static IEnumerable < IPublishedContent > Siblings < T > ( this IPublishedContent content , string culture = null )
where T : class , IPublishedContent
{
return SiblingsAndSelf < T > ( content , culture ) . Where ( x = > x . Id ! = content . Id ) ;
}
/// <summary>
/// Gets the siblings of the content including the node itself to indicate the position.
/// </summary>
/// <param name="content">The content.</param>
/// <param name="culture">The specific culture to filter for. If null is used the current culture is used. (Default is null)</param>
/// <returns>The siblings of the content including the node itself.</returns>
public static IEnumerable < IPublishedContent > SiblingsAndSelf ( this IPublishedContent content , string culture = null )
2019-03-05 13:02:59 +01:00
{
return content . Parent ! = null
? content . Parent . Children ( culture )
: PublishedSnapshot . Content . GetAtRoot ( ) . WhereIsInvariantOrHasCulture ( culture ) ;
}
/// <summary>
2019-03-19 14:59:52 +01:00
/// Gets the siblings of the content including the node itself to indicate the position, of a given content type.
2019-03-05 13:02:59 +01:00
/// </summary>
/// <param name="content">The content.</param>
/// <param name="culture">The specific culture to filter for. If null is used the current culture is used. (Default is null)</param>
/// <param name="contentTypeAlias">The content type alias.</param>
2019-03-19 14:59:52 +01:00
/// <returns>The siblings of the content including the node itself, of the given content type.</returns>
public static IEnumerable < IPublishedContent > SiblingsAndSelfOfType ( this IPublishedContent content , string contentTypeAlias , string culture = null )
2019-03-05 13:02:59 +01:00
{
return content . Parent ! = null
? content . Parent . ChildrenOfType ( contentTypeAlias , culture )
: PublishedSnapshot . Content . GetAtRoot ( ) . OfTypes ( contentTypeAlias ) . WhereIsInvariantOrHasCulture ( culture ) ;
}
/// <summary>
2019-03-19 14:59:52 +01:00
/// Gets the siblings of the content including the node itself to indicate the position, of a given content type.
2019-03-05 13:02:59 +01:00
/// </summary>
/// <typeparam name="T">The content type.</typeparam>
/// <param name="content">The content.</param>
/// <param name="culture">The specific culture to filter for. If null is used the current culture is used. (Default is null)</param>
2019-03-19 14:59:52 +01:00
/// <returns>The siblings of the content including the node itself, of the given content type.</returns>
public static IEnumerable < T > SiblingsAndSelf < T > ( this IPublishedContent content , string culture = null )
2019-03-05 13:02:59 +01:00
where T : class , IPublishedContent
{
return content . Parent ! = null
? content . Parent . Children < T > ( culture )
: PublishedSnapshot . Content . GetAtRoot ( ) . OfType < T > ( ) . WhereIsInvariantOrHasCulture ( culture ) ;
}
#endregion
2018-06-29 19:52:40 +02:00
#region Axes : custom
/// <summary>
/// Gets the root content for this content.
/// </summary>
/// <param name="content">The content.</param>
/// <returns>The 'site' content ie AncestorOrSelf(1).</returns>
public static IPublishedContent Root ( this IPublishedContent content )
{
return content . AncestorOrSelf ( 1 ) ;
}
#endregion
#region PropertyAliasesAndNames
private static Func < ServiceContext , string , Dictionary < string , string > > _getPropertyAliasesAndNames ;
/// <summary>
/// This is used only for unit tests to set the delegate to look up aliases/names dictionary of a content type
/// </summary>
internal static Func < ServiceContext , string , Dictionary < string , string > > GetPropertyAliasesAndNames
{
get = > _getPropertyAliasesAndNames ? ? GetAliasesAndNames ;
set = > _getPropertyAliasesAndNames = value ;
}
private static Dictionary < string , string > GetAliasesAndNames ( ServiceContext services , string alias )
{
var type = services . ContentTypeService . Get ( alias )
? ? services . MediaTypeService . Get ( alias )
? ? ( IContentTypeBase ) services . MemberTypeService . Get ( alias ) ;
var fields = GetAliasesAndNames ( type ) ;
// ensure the standard fields are there
var stdFields = new Dictionary < string , string >
{
{ "Id" , "Id" } ,
{ "NodeName" , "NodeName" } ,
{ "NodeTypeAlias" , "NodeTypeAlias" } ,
{ "CreateDate" , "CreateDate" } ,
{ "UpdateDate" , "UpdateDate" } ,
{ "CreatorName" , "CreatorName" } ,
{ "WriterName" , "WriterName" } ,
{ "Url" , "Url" }
} ;
foreach ( var field in stdFields . Where ( x = > fields . ContainsKey ( x . Key ) = = false ) )
{
fields [ field . Key ] = field . Value ;
}
return fields ;
}
private static Dictionary < string , string > GetAliasesAndNames ( IContentTypeBase contentType )
{
return contentType . PropertyTypes . ToDictionary ( x = > x . Alias , x = > x . Name ) ;
}
#endregion
}
}