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

publicizes a few APIs and adds more API docs

Browse Source
This commit is contained in:
Shannon
2016-12-29 11:36:39 +11:00
parent d83d23803a
commit 40f7d820a6
4 changed files with 39 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
src/Umbraco.Core/Models/Editors/ContentPropertyData.cs
View File

@@ -16,6 +16,11 @@ namespace Umbraco.Core.Models.Editors
/// </remarks>
public class ContentPropertyData
{
public ContentPropertyData(object value, PreValueCollection preValues)
: this(value, preValues, new Dictionary<string, object>())
{
}
public ContentPropertyData(object value, PreValueCollection preValues, IDictionary<string, object> additionalData)
{
Value = value;
@@ -28,6 +33,9 @@ namespace Umbraco.Core.Models.Editors
/// </summary>
public object Value { get; private set; }
/// <summary>
/// The pre-value collection for the content property
/// </summary>
public PreValueCollection PreValues { get; private set; }
/// <summary>

4
src/Umbraco.Core/Persistence/Repositories/VersionableRepositoryBase.cs
View File

@@ -561,9 +561,7 @@ WHERE EXISTS(
var preVals = new PreValueCollection(asDictionary);
var contentPropData = new ContentPropertyData(property.Value,
preVals,
new Dictionary<string, object>());
var contentPropData = new ContentPropertyData(property.Value, preVals);
TagExtractor.SetPropertyTags(property, contentPropData, property.Value, tagSupport);
}

3
src/Umbraco.Core/PropertyEditors/TagValueType.cs
View File

@@ -14,7 +14,8 @@
/// The list of tags will be supplied by the property editor's ConvertEditorToDb method result which will need to return an IEnumerable{string} value
/// </summary>
/// <remarks>
/// if the ConvertEditorToDb doesn't return an IEnumerable{string} then an exception will be thrown.
/// if the ConvertEditorToDb doesn't return an IEnumerable{string} then it will automatically try to be detected as either CSV or JSON and if neither of those match
/// an exception will be thrown.
/// </remarks>
CustomTagList
}

35
src/Umbraco.Core/Services/TagExtractor.cs
View File

@@ -9,10 +9,15 @@ using Umbraco.Core.PropertyEditors;
namespace Umbraco.Core.Services
{
/// <summary>
/// A simple utility class to extract the tag values from a property/property editor and set them on the content
/// A utility class to extract the tag values from a property/property editor and set them on the content
/// </summary>
internal class TagExtractor
public class TagExtractor
{
/// <summary>
/// Will return the <see cref="SupportTagsAttribute"/> for the given <see cref="PropertyEditor"/>
/// </summary>
/// <param name="propEd"></param>
/// <returns></returns>
public static SupportTagsAttribute GetAttribute(PropertyEditor propEd)
{
if (propEd == null) return null;
@@ -23,9 +28,12 @@ namespace Umbraco.Core.Services
/// <summary>
/// Sets the tag values on the content property based on the property editor's tags attribute
/// </summary>
/// <param name="property"></param>
/// <param name="propertyData"></param>
/// <param name="convertedPropertyValue"></param>
/// <param name="property">The content's Property</param>
/// <param name="propertyData">The data that has been submitted to be saved for a content property</param>
/// <param name="convertedPropertyValue">
/// If the <see cref="TagValueType"/> is <see cref="TagValueType.FromDelimitedValue"/> then this is expected to be a delimited string,
/// otherwise if it is <see cref="TagValueType.CustomTagList"/> then this is expected to be IEnumerable{string}
/// </param>
/// <param name="attribute"></param>
public static void SetPropertyTags(Property property, ContentPropertyData propertyData, object convertedPropertyValue, SupportTagsAttribute attribute)
{
@@ -51,7 +59,20 @@ namespace Umbraco.Core.Services
}
}
public static void SetPropertyTags(Property property, object convertedPropertyValue, string delimiter, bool replaceTags, string tagGroup, TagValueType valueType, TagCacheStorageType storageType)
/// <summary>
/// Sets the tag values on the content property based on the property editor's tags attribute
/// </summary>
/// <param name="property">The content's Property</param>
/// <param name="convertedPropertyValue">
/// If the <see cref="TagValueType"/> is <see cref="TagValueType.FromDelimitedValue"/> then this is expected to be a delimited string,
/// otherwise if it is <see cref="TagValueType.CustomTagList"/> then this is expected to be IEnumerable{string}
/// </param>
/// <param name="delimiter">The delimiter for the value if convertedPropertyValue is a string delimited value</param>
/// <param name="replaceTags">Whether or not to replace the tags with the new value or append them (true to replace, false to append)</param>
/// <param name="tagGroup">The tag group to use when tagging</param>
/// <param name="valueType">Defines how the tag values will be extracted</param>
/// <param name="storageType">Defines how to store the tags in cache (CSV or Json)</param>
internal static void SetPropertyTags(Property property, object convertedPropertyValue, string delimiter, bool replaceTags, string tagGroup, TagValueType valueType, TagCacheStorageType storageType)
{
if (convertedPropertyValue == null)
{
@@ -65,7 +86,7 @@ namespace Umbraco.Core.Services
property.SetTags(storageType, property.Alias, tags, replaceTags, tagGroup);
break;
case TagValueType.CustomTagList:
//for this to work the object value must be IENumerable<string>
//for this to work the object value must be IEnumerable<string>
var stringList = convertedPropertyValue as IEnumerable<string>;
if (stringList != null)
{