yv01p/Umbraco-CMS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

U4-8720 - add dynamic support, UmbracoHelper methods

Browse Source
This commit is contained in:
Stephan
2016-07-19 16:13:46 +02:00
parent dc476dcb02
commit a0caab410e
4 changed files with 207 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/Umbraco.Web/IDynamicPublishedContentQuery.cs
View File

@@ -1,3 +1,4 @@
using System;
using System.Collections.Generic;
using System.Xml.XPath;
using Umbraco.Core.Xml;
@@ -10,15 +11,22 @@ namespace Umbraco.Web
public interface IDynamicPublishedContentQuery
{
dynamic Content(int id);
dynamic Content(Guid id);
dynamic ContentSingleAtXPath(string xpath, params XPathVariable[] vars);
dynamic ContentSingleAtXPath(XPathExpression xpath, params XPathVariable[] vars);
dynamic Content(IEnumerable<int> ids);
dynamic Content(IEnumerable<Guid> ids);
dynamic ContentAtXPath(string xpath, params XPathVariable[] vars);
dynamic ContentAtXPath(XPathExpression xpath, params XPathVariable[] vars);
dynamic ContentAtRoot();
// note: we CANNOT implement Media by Guid in v7 without break-changing IPublishedCache,
// since we don't support XPath navigation of the media tree.
dynamic Media(int id);
//dynamic Media(Guid id);
dynamic Media(IEnumerable<int> ids);
//dynamic Media(IEnumerable<Guid> ids);
dynamic MediaAtRoot();
/// <summary>

2
src/Umbraco.Web/ITypedPublishedContentQuery.cs
View File

@@ -20,7 +20,7 @@ namespace Umbraco.Web
IEnumerable<IPublishedContent> TypedContentAtXPath(XPathExpression xpath, params XPathVariable[] vars);
IEnumerable<IPublishedContent> TypedContentAtRoot();
// note: we CANNOT implement TypedMedia in v7 without break-changing IPublishedCache,
// note: we CANNOT implement TypedMedia by Guid in v7 without break-changing IPublishedCache,
// since we don't support XPath navigation of the media tree.
IPublishedContent TypedMedia(int id);

33
src/Umbraco.Web/PublishedContentQuery.cs
View File

@@ -113,7 +113,14 @@ namespace Umbraco.Web
? DocumentById(id, _contentCache, DynamicNull.Null)
: _dynamicContentQuery.Content(id);
}
public dynamic Content(Guid id)
{
return _dynamicContentQuery == null
? DocumentById(id, _contentCache, DynamicNull.Null)
: _dynamicContentQuery.Content(id);
}
public dynamic ContentSingleAtXPath(string xpath, params XPathVariable[] vars)
{
return _dynamicContentQuery == null
@@ -135,6 +142,13 @@ namespace Umbraco.Web
: _dynamicContentQuery.Content(ids);
}
public dynamic Content(IEnumerable<Guid> ids)
{
return _dynamicContentQuery == null
? DocumentByIds(_contentCache, ids.ToArray())
: _dynamicContentQuery.Content(ids);
}
public dynamic ContentAtXPath(string xpath, params XPathVariable[] vars)
{
return _dynamicContentQuery == null
@@ -270,6 +284,14 @@ namespace Umbraco.Web
: new DynamicPublishedContent(doc).AsDynamic();
}
private dynamic DocumentById(Guid id, ContextualPublishedCache cache, object ifNotFound)
{
var doc = TypedDocumentById(id, cache);
return doc == null
? ifNotFound
: new DynamicPublishedContent(doc).AsDynamic();
}
private dynamic DocumentByXPath(string xpath, XPathVariable[] vars, ContextualPublishedCache cache, object ifNotFound)
{
var doc = cache.GetSingleByXPath(xpath, vars);
@@ -295,6 +317,15 @@ namespace Umbraco.Web
return new DynamicPublishedContentList(nodes);
}
private dynamic DocumentByIds(ContextualPublishedCache cache, IEnumerable<Guid> ids)
{
var dNull = DynamicNull.Null;
var nodes = ids.Select(eachId => DocumentById(eachId, cache, dNull))
.Where(x => TypeHelper.IsTypeAssignableFrom<DynamicNull>(x) == false)
.Cast<DynamicPublishedContent>();
return new DynamicPublishedContentList(nodes);
}
private dynamic DocumentsByXPath(string xpath, XPathVariable[] vars, ContextualPublishedCache cache)
{
return new DynamicPublishedContentList(

220
src/Umbraco.Web/UmbracoHelper.cs
View File

@@ -15,6 +15,7 @@ using Umbraco.Web.Routing;
using Umbraco.Web.Security;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Web.Mvc;
using System.Web.Routing;
using Umbraco.Core.Cache;
@@ -561,21 +562,35 @@ namespace Umbraco.Web
#region Content
public IPublishedContent TypedContent(object id)
{
int intId;
return ConvertIdObjectToInt(id, out intId) ? ContentQuery.TypedContent(intId) : null;
{
return TypedContentForObject(id);
}
public IPublishedContent TypedContent(int id)
private IPublishedContent TypedContentForObject(object id)
{
int intId;
if (ConvertIdObjectToInt(id, out intId))
return ContentQuery.TypedContent(intId);
Guid guidId;
if (ConvertIdObjectToGuid(id, out guidId))
return ContentQuery.TypedContent(guidId);
return null;
}
public IPublishedContent TypedContent(int id)
{
return ContentQuery.TypedContent(id);
}
public IPublishedContent TypedContent(Guid id)
{
return ContentQuery.TypedContent(id);
}
public IPublishedContent TypedContent(string id)
{
int intId;
return ConvertIdObjectToInt(id, out intId) ? ContentQuery.TypedContent(intId) : null;
}
return TypedContentForObject(id);
}
public IPublishedContent TypedContentSingleAtXPath(string xpath, params XPathVariable[] vars)
{
@@ -584,9 +599,21 @@ namespace Umbraco.Web
public IEnumerable<IPublishedContent> TypedContent(params object[] ids)
{
return ContentQuery.TypedContent(ConvertIdsObjectToInts(ids));
return TypedContentForObjects(ids);
}
private IEnumerable<IPublishedContent> TypedContentForObjects(IEnumerable<object> ids)
{
var idsA = ids.ToArray();
IEnumerable<int> intIds;
if (ConvertIdsObjectToInts(idsA, out intIds))
return ContentQuery.TypedContent(intIds);
IEnumerable<Guid> guidIds;
if (ConvertIdsObjectToGuids(idsA, out guidIds))
return ContentQuery.TypedContent(guidIds);
return Enumerable.Empty<IPublishedContent>();
}
/// <summary>
/// Gets the contents corresponding to the identifiers.
/// </summary>
@@ -598,6 +625,11 @@ namespace Umbraco.Web
return ContentQuery.TypedContent(ids);
}
public IEnumerable<IPublishedContent> TypedContent(params Guid[] ids)
{
return ContentQuery.TypedContent(ids);
}
/// <summary>
/// Gets the contents corresponding to the identifiers.
/// </summary>
@@ -605,8 +637,8 @@ namespace Umbraco.Web
/// <returns>The existing contents corresponding to the identifiers.</returns>
/// <remarks>If an identifier does not match an existing content, it will be missing in the returned value.</remarks>
public IEnumerable<IPublishedContent> TypedContent(params string[] ids)
{
return ContentQuery.TypedContent(ConvertIdsObjectToInts(ids));
{
return TypedContentForObjects(ids);
}
/// <summary>
@@ -616,8 +648,8 @@ namespace Umbraco.Web
/// <returns>The existing contents corresponding to the identifiers.</returns>
/// <remarks>If an identifier does not match an existing content, it will be missing in the returned value.</remarks>
public IEnumerable<IPublishedContent> TypedContent(IEnumerable<object> ids)
{
return ContentQuery.TypedContent(ConvertIdsObjectToInts(ids));
{
return TypedContentForObjects(ids);
}
/// <summary>
@@ -628,7 +660,7 @@ namespace Umbraco.Web
/// <remarks>If an identifier does not match an existing content, it will be missing in the returned value.</remarks>
public IEnumerable<IPublishedContent> TypedContent(IEnumerable<string> ids)
{
return ContentQuery.TypedContent(ConvertIdsObjectToInts(ids));
return TypedContentForObjects(ids);
}
/// <summary>
@@ -659,20 +691,29 @@ namespace Umbraco.Web
public dynamic Content(object id)
{
int intId;
return ConvertIdObjectToInt(id, out intId) ? ContentQuery.Content(intId) : DynamicNull.Null;
return ContentForObject(id);
}
public dynamic Content(int id)
private dynamic ContentForObject(object id)
{
int intId;
if (ConvertIdObjectToInt(id, out intId))
return ContentQuery.Content(intId);
Guid guidId;
if (ConvertIdObjectToGuid(id, out guidId))
return ContentQuery.Content(guidId);
return DynamicNull.Null;
}
public dynamic Content(int id)
{
return ContentQuery.Content(id);
}
public dynamic Content(string id)
{
int intId;
return ConvertIdObjectToInt(id, out intId) ? ContentQuery.Content(intId) : DynamicNull.Null;
}
return ContentForObject(id);
}
public dynamic ContentSingleAtXPath(string xpath, params XPathVariable[] vars)
{
@@ -691,9 +732,21 @@ namespace Umbraco.Web
/// <returns>The existing contents corresponding to the identifiers.</returns>
/// <remarks>If an identifier does not match an existing content, it will be missing in the returned value.</remarks>
public dynamic Content(params object[] ids)
{
return ContentQuery.Content(ConvertIdsObjectToInts(ids));
}
{
return ContentForObjects(ids);
}
private dynamic ContentForObjects(IEnumerable<object> ids)
{
var idsA = ids.ToArray();
IEnumerable<int> intIds;
if (ConvertIdsObjectToInts(idsA, out intIds))
return ContentQuery.Content(intIds);
IEnumerable<Guid> guidIds;
if (ConvertIdsObjectToGuids(idsA, out guidIds))
return ContentQuery.Content(guidIds);
return Enumerable.Empty<IPublishedContent>();
}
/// <summary>
/// Gets the contents corresponding to the identifiers.
@@ -714,8 +767,8 @@ namespace Umbraco.Web
/// <remarks>If an identifier does not match an existing content, it will be missing in the returned value.</remarks>
public dynamic Content(params string[] ids)
{
return ContentQuery.Content(ConvertIdsObjectToInts(ids));
}
return ContentForObjects(ids);
}
/// <summary>
/// Gets the contents corresponding to the identifiers.
@@ -725,8 +778,8 @@ namespace Umbraco.Web
/// <remarks>If an identifier does not match an existing content, it will be missing in the returned value.</remarks>
public dynamic Content(IEnumerable<object> ids)
{
return ContentQuery.Content(ConvertIdsObjectToInts(ids));
}
return ContentForObjects(ids);
}
/// <summary>
/// Gets the contents corresponding to the identifiers.
@@ -747,8 +800,8 @@ namespace Umbraco.Web
/// <remarks>If an identifier does not match an existing content, it will be missing in the returned value.</remarks>
public dynamic Content(IEnumerable<string> ids)
{
return ContentQuery.Content(ConvertIdsObjectToInts(ids));
}
return ContentForObjects(ids);
}
public dynamic ContentAtXPath(string xpath, params XPathVariable[] vars)
{
@@ -765,35 +818,68 @@ namespace Umbraco.Web
return ContentQuery.ContentAtRoot();
}
private bool ConvertIdObjectToInt(object id, out int intId)
private static bool ConvertIdObjectToInt(object id, out int intId)
{
var s = id as string;
if (s != null)
{
return int.TryParse(s, out intId);
}
}
if (id is int)
{
intId = (int) id;
return true;
}
throw new InvalidOperationException("The value of parameter 'id' must be either a string or an integer");
intId = default(int);
return false;
}
private IEnumerable<int> ConvertIdsObjectToInts(IEnumerable<object> ids)
private static bool ConvertIdObjectToGuid(object id, out Guid guidId)
{
var s = id as string;
if (s != null)
{
return Guid.TryParse(s, out guidId);
}
if (id is Guid)
{
guidId = (Guid) id;
return true;
}
guidId = default(Guid);
return false;
}
private static bool ConvertIdsObjectToInts(IEnumerable<object> ids, out IEnumerable<int> intIds)
{
var list = new List<int>();
intIds = null;
foreach (var id in ids)
{
int intId;
if (ConvertIdObjectToInt(id, out intId))
{
list.Add(intId);
}
else
return false; // if one of them is not an int, fail
}
return list;
intIds = list;
return true;
}
private static bool ConvertIdsObjectToGuids(IEnumerable<object> ids, out IEnumerable<Guid> guidIds)
{
var list = new List<Guid>();
guidIds = null;
foreach (var id in ids)
{
Guid guidId;
if (ConvertIdObjectToGuid(id, out guidId))
list.Add(guidId);
else
return false; // if one of them is not a guid, fail
}
guidIds = list;
return true;
}
#endregion
@@ -834,9 +920,21 @@ namespace Umbraco.Web
/// <returns>The existing medias corresponding to the identifiers.</returns>
/// <remarks>If an identifier does not match an existing media, it will be missing in the returned value.</remarks>
public IEnumerable<IPublishedContent> TypedMedia(params object[] ids)
{
return ContentQuery.TypedMedia(ConvertIdsObjectToInts(ids));
}
{
return TypedMediaForObjects(ids);
}
private IEnumerable<IPublishedContent> TypedMediaForObjects(IEnumerable<object> ids)
{
var idsA = ids.ToArray();
IEnumerable<int> intIds;
if (ConvertIdsObjectToInts(idsA, out intIds))
return ContentQuery.TypedMedia(intIds);
//IEnumerable<Guid> guidIds;
//if (ConvertIdsObjectToGuids(idsA, out guidIds))
// return ContentQuery.TypedMedia(guidIds);
return Enumerable.Empty<IPublishedContent>();
}
/// <summary>
/// Gets the medias corresponding to the identifiers.
@@ -857,8 +955,8 @@ namespace Umbraco.Web
/// <remarks>If an identifier does not match an existing media, it will be missing in the returned value.</remarks>
public IEnumerable<IPublishedContent> TypedMedia(params string[] ids)
{
return ContentQuery.TypedMedia(ConvertIdsObjectToInts(ids));
}
return TypedMediaForObjects(ids);
}
/// <summary>
/// Gets the medias corresponding to the identifiers.
@@ -868,8 +966,8 @@ namespace Umbraco.Web
/// <remarks>If an identifier does not match an existing media, it will be missing in the returned value.</remarks>
public IEnumerable<IPublishedContent> TypedMedia(IEnumerable<object> ids)
{
return ContentQuery.TypedMedia(ConvertIdsObjectToInts(ids));
}
return TypedMediaForObjects(ids);
}
/// <summary>
/// Gets the medias corresponding to the identifiers.
@@ -890,8 +988,8 @@ namespace Umbraco.Web
/// <remarks>If an identifier does not match an existing media, it will be missing in the returned value.</remarks>
public IEnumerable<IPublishedContent> TypedMedia(IEnumerable<string> ids)
{
return ContentQuery.TypedMedia(ConvertIdsObjectToInts(ids));
}
return TypedMediaForObjects(ids);
}
public IEnumerable<IPublishedContent> TypedMediaAtRoot()
{
@@ -922,9 +1020,21 @@ namespace Umbraco.Web
/// <returns>The existing medias corresponding to the identifiers.</returns>
/// <remarks>If an identifier does not match an existing media, it will be missing in the returned value.</remarks>
public dynamic Media(params object[] ids)
{
return ContentQuery.Media(ConvertIdsObjectToInts(ids));
}
{
return MediaForObjects(ids);
}
private dynamic MediaForObjects(IEnumerable<object> ids)
{
var idsA = ids.ToArray();
IEnumerable<int> intIds;
if (ConvertIdsObjectToInts(idsA, out intIds))
return ContentQuery.Media(intIds);
//IEnumerable<Guid> guidIds;
//if (ConvertIdsObjectToGuids(idsA, out guidIds))
// return ContentQuery.Media(guidIds);
return Enumerable.Empty<IPublishedContent>();
}
/// <summary>
/// Gets the medias corresponding to the identifiers.
@@ -944,8 +1054,8 @@ namespace Umbraco.Web
/// <returns>The existing medias corresponding to the identifiers.</returns>
/// <remarks>If an identifier does not match an existing media, it will be missing in the returned value.</remarks>
public dynamic Media(params string[] ids)
{
return ContentQuery.Media(ConvertIdsObjectToInts(ids));
{
return MediaForObjects(ids);
}
/// <summary>
@@ -956,8 +1066,8 @@ namespace Umbraco.Web
/// <remarks>If an identifier does not match an existing media, it will be missing in the returned value.</remarks>
public dynamic Media(IEnumerable<object> ids)
{
return ContentQuery.Media(ConvertIdsObjectToInts(ids));
}
return MediaForObjects(ids);
}
/// <summary>
/// Gets the medias corresponding to the identifiers.
@@ -978,8 +1088,8 @@ namespace Umbraco.Web
/// <remarks>If an identifier does not match an existing media, it will be missing in the returned value.</remarks>
public dynamic Media(IEnumerable<string> ids)
{
return ContentQuery.Media(ConvertIdsObjectToInts(ids));
}
return MediaForObjects(ids);
}
public dynamic MediaAtRoot()
{