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

Moved needed extension methods for the Gallery snippet..

Browse Source
This commit is contained in:
Bjarke Berg
2020-08-04 14:12:22 +02:00
parent 6dd896ea01
commit 38ee3c322d
9 changed files with 364 additions and 356 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
src/Umbraco.Core/PublishedElementExtensions.cs
View File

@@ -1,6 +1,8 @@
using System.Collections.Generic;
using System;
using System.Collections.Generic;
using System.Linq;
using Umbraco.Core.Models.PublishedContent;
using Umbraco.Web.Routing;
namespace Umbraco.Core
{
@@ -175,5 +177,30 @@ namespace Umbraco.Core
}
#endregion
#region MediaUrl
/// <summary>
/// Gets the url for a media.
/// </summary>
/// <param name="content">The content item.</param>
/// <param name="publishedUrlProvider">The published url provider.</param>
/// <param name="culture">The culture (use current culture by default).</param>
/// <param name="mode">The url mode (use site configuration by default).</param>
/// <param name="propertyAlias">The alias of the property (use 'umbracoFile' by default).</param>
/// <returns>The url for the media.</returns>
/// <remarks>
/// <para>The value of this property is contextual. It depends on the 'current' request uri,
/// if any. In addition, when the content type is multi-lingual, this is the url for the
/// specified culture. Otherwise, it is the invariant url.</para>
/// </remarks>
public static string MediaUrl(this IPublishedContent content, IPublishedUrlProvider publishedUrlProvider, string culture = null, UrlMode mode = UrlMode.Default, string propertyAlias = Constants.Conventions.Media.File)
{
if (publishedUrlProvider == null) throw new ArgumentNullException(nameof(publishedUrlProvider));
return publishedUrlProvider.GetMediaUrl(content, mode, culture, propertyAlias);
}
#endregion
}
}

103
src/Umbraco.Tests/PropertyEditors/ImageCropperTest.cs → src/Umbraco.Tests.UnitTests/Umbraco.Web.Common/ImageCropperTest.cs
View File

@@ -1,29 +1,14 @@
using System;
using System.Globalization;
using Moq;
using System.Globalization;
using Newtonsoft.Json;
using NUnit.Framework;
using Newtonsoft.Json.Linq;
using Umbraco.Core;
using Umbraco.Core.Composing;
using Umbraco.Core.Configuration.UmbracoSettings;
using Umbraco.Core.IO;
using Umbraco.Core.Logging;
using Umbraco.Core.Models;
using Umbraco.Core.Models.PublishedContent;
using Umbraco.Core.PropertyEditors;
using Umbraco.Core.PropertyEditors.ValueConverters;
using Umbraco.Core.Services;
using Umbraco.Core.Strings;
using Umbraco.Tests.Components;
using Umbraco.Tests.TestHelpers;
using Umbraco.Web.Models;
using Umbraco.Web;
using Umbraco.Web.PropertyEditors;
using System.Text;
using Current = Umbraco.Web.Composing.Current;
using Umbraco.Core.Cache;
using Umbraco.Core.Media;
using Umbraco.Extensions;
namespace Umbraco.Tests.PropertyEditors
{
@@ -67,48 +52,48 @@ namespace Umbraco.Tests.PropertyEditors
Assert.AreEqual(cropperValue, obj);
}
[TestCase(CropperJson1, CropperJson1, true)]
[TestCase(CropperJson1, CropperJson2, false)]
public void CanConvertImageCropperPropertyEditor(string val1, string val2, bool expected)
{
try
{
var container = TestHelper.GetRegister();
var composition = new Composition(container, TestHelper.GetMockedTypeLoader(), Mock.Of<IProfilingLogger>(), ComponentTests.MockRuntimeState(RuntimeLevel.Run), TestHelper.GetConfigs(), TestHelper.IOHelper, AppCaches.NoCache);
composition.WithCollectionBuilder<PropertyValueConverterCollectionBuilder>();
Current.Factory = composition.CreateFactory();
var logger = Mock.Of<ILogger>();
var scheme = Mock.Of<IMediaPathScheme>();
var shortStringHelper = Mock.Of<IShortStringHelper>();
var mediaFileSystem = new MediaFileSystem(Mock.Of<IFileSystem>(), scheme, logger, shortStringHelper);
var dataTypeService = new TestObjects.TestDataTypeService(
new DataType(new ImageCropperPropertyEditor(Mock.Of<ILogger>(), mediaFileSystem, Mock.Of<IContentSettings>(), Mock.Of<IDataTypeService>(), Mock.Of<ILocalizationService>(), TestHelper.IOHelper, TestHelper.ShortStringHelper, Mock.Of<ILocalizedTextService>())) { Id = 1 });
var factory = new PublishedContentTypeFactory(Mock.Of<IPublishedModelFactory>(), new PropertyValueConverterCollection(Array.Empty<IPropertyValueConverter>()), dataTypeService);
var converter = new ImageCropperValueConverter();
var result = converter.ConvertSourceToIntermediate(null, factory.CreatePropertyType("test", 1), val1, false); // does not use type for conversion
var resultShouldMatch = val2.DeserializeImageCropperValue();
if (expected)
{
Assert.AreEqual(resultShouldMatch, result);
}
else
{
Assert.AreNotEqual(resultShouldMatch, result);
}
}
finally
{
Current.Reset();
}
}
// [TestCase(CropperJson1, CropperJson1, true)]
// [TestCase(CropperJson1, CropperJson2, false)]
// public void CanConvertImageCropperPropertyEditor(string val1, string val2, bool expected)
// {
// try
// {
// var container = TestHelper.GetRegister();
// var composition = new Composition(container, TestHelper.GetMockedTypeLoader(), Mock.Of<IProfilingLogger>(), ComponentTests.MockRuntimeState(RuntimeLevel.Run), TestHelper.GetConfigs(), TestHelper.IOHelper, AppCaches.NoCache);
//
// composition.WithCollectionBuilder<PropertyValueConverterCollectionBuilder>();
//
// Current.Factory = composition.CreateFactory();
//
// var logger = Mock.Of<ILogger>();
// var scheme = Mock.Of<IMediaPathScheme>();
// var shortStringHelper = Mock.Of<IShortStringHelper>();
//
// var mediaFileSystem = new MediaFileSystem(Mock.Of<IFileSystem>(), scheme, logger, shortStringHelper);
//
// var dataTypeService = new TestObjects.TestDataTypeService(
// new DataType(new ImageCropperPropertyEditor(Mock.Of<ILogger>(), mediaFileSystem, Mock.Of<IContentSettings>(), Mock.Of<IDataTypeService>(), Mock.Of<ILocalizationService>(), TestHelper.IOHelper, TestHelper.ShortStringHelper, Mock.Of<ILocalizedTextService>())) { Id = 1 });
//
// var factory = new PublishedContentTypeFactory(Mock.Of<IPublishedModelFactory>(), new PropertyValueConverterCollection(Array.Empty<IPropertyValueConverter>()), dataTypeService);
//
// var converter = new ImageCropperValueConverter();
// var result = converter.ConvertSourceToIntermediate(null, factory.CreatePropertyType("test", 1), val1, false); // does not use type for conversion
//
// var resultShouldMatch = val2.DeserializeImageCropperValue();
// if (expected)
// {
// Assert.AreEqual(resultShouldMatch, result);
// }
// else
// {
// Assert.AreNotEqual(resultShouldMatch, result);
// }
// }
// finally
// {
// Current.Reset();
// }
// }
[Test]
public void GetCropUrl_CropAliasTest()

1
src/Umbraco.Tests/Umbraco.Tests.csproj
View File

@@ -303,7 +303,6 @@
<Compile Include="Persistence\Repositories\TagRepositoryTest.cs" />
<Compile Include="Persistence\Repositories\NotificationsRepositoryTest.cs" />
<Compile Include="Persistence\Repositories\TemplateRepositoryTest.cs" />
<Compile Include="PropertyEditors\ImageCropperTest.cs" />
<Compile Include="PublishedContent\PublishedContentExtensionTests.cs" />
<Compile Include="PropertyEditors\ColorListValidatorTest.cs" />
<Compile Include="PropertyEditors\MultiValuePropertyEditorTests.cs" />

38
src/Umbraco.Web/ImageCropperTemplateCoreExtensions.cs → src/Umbraco.Web.Common/Extensions/ImageCropperTemplateCoreExtensions.cs
View File

@@ -7,8 +7,9 @@ using Umbraco.Core.Models.PublishedContent;
using Umbraco.Core.PropertyEditors.ValueConverters;
using Umbraco.Web.Models;
using Umbraco.Core.Media;
using Umbraco.Web.Routing;
namespace Umbraco.Web
namespace Umbraco.Extensions
{
public static class ImageCropperTemplateCoreExtensions
{
@@ -21,12 +22,20 @@ namespace Umbraco.Web
/// <param name="cropAlias">
/// The crop alias e.g. thumbnail
/// </param>
/// <param name="imageUrlGenerator">The image url generator.</param>
/// <param name="publishedValueFallback">The published value fallback.</param>
/// <param name="publishedUrlProvider">The published url provider.</param>
/// <returns>
/// The ImageProcessor.Web Url.
/// </returns>
public static string GetCropUrl(this IPublishedContent mediaItem, string cropAlias, IImageUrlGenerator imageUrlGenerator)
public static string GetCropUrl(
this IPublishedContent mediaItem,
string cropAlias,
IImageUrlGenerator imageUrlGenerator,
IPublishedValueFallback publishedValueFallback,
IPublishedUrlProvider publishedUrlProvider)
{
return mediaItem.GetCropUrl(imageUrlGenerator, cropAlias: cropAlias, useCropDimensions: true);
return mediaItem.GetCropUrl(imageUrlGenerator, publishedValueFallback, publishedUrlProvider, cropAlias: cropAlias, useCropDimensions: true);
}
/// <summary>
@@ -41,12 +50,21 @@ namespace Umbraco.Web
/// <param name="cropAlias">
/// The crop alias e.g. thumbnail
/// </param>
/// <param name="imageUrlGenerator">The image url generator.</param>
/// <param name="publishedValueFallback">The published value fallback.</param>
/// <param name="publishedUrlProvider">The published url provider.</param>
/// <returns>
/// The ImageProcessor.Web Url.
/// </returns>
public static string GetCropUrl(this IPublishedContent mediaItem, string propertyAlias, string cropAlias, IImageUrlGenerator imageUrlGenerator)
public static string GetCropUrl(
this IPublishedContent mediaItem,
string propertyAlias,
string cropAlias,
IImageUrlGenerator imageUrlGenerator,
IPublishedValueFallback publishedValueFallback,
IPublishedUrlProvider publishedUrlProvider)
{
return mediaItem.GetCropUrl(imageUrlGenerator, propertyAlias: propertyAlias, cropAlias: cropAlias, useCropDimensions: true);
return mediaItem.GetCropUrl( imageUrlGenerator, publishedValueFallback, publishedUrlProvider, propertyAlias: propertyAlias, cropAlias: cropAlias, useCropDimensions: true);
}
/// <summary>
@@ -55,6 +73,9 @@ namespace Umbraco.Web
/// <param name="mediaItem">
/// The IPublishedContent item.
/// </param>
/// <param name="imageUrlGenerator">The image url generator.</param>
/// <param name="publishedValueFallback">The published value fallback.</param>
/// <param name="publishedUrlProvider">The published url provider.</param>
/// <param name="width">
/// The width of the output image.
/// </param>
@@ -99,12 +120,15 @@ namespace Umbraco.Web
/// <param name="upScale">
/// If the image should be upscaled to requested dimensions
/// </param>
/// <returns>
/// The <see cref="string"/>.
/// </returns>
public static string GetCropUrl(
this IPublishedContent mediaItem,
IImageUrlGenerator imageUrlGenerator,
IPublishedValueFallback publishedValueFallback,
IPublishedUrlProvider publishedUrlProvider,
int? width = null,
int? height = null,
string propertyAlias = Constants.Conventions.Media.File,
@@ -126,10 +150,10 @@ namespace Umbraco.Web
if (mediaItem.HasProperty(propertyAlias) == false || mediaItem.HasValue(propertyAlias) == false)
return string.Empty;
var mediaItemUrl = mediaItem.MediaUrl(propertyAlias: propertyAlias);
var mediaItemUrl = mediaItem.MediaUrl(publishedUrlProvider, propertyAlias: propertyAlias);
//get the default obj from the value converter
var cropperValue = mediaItem.Value(propertyAlias);
var cropperValue = mediaItem.Value(publishedValueFallback, propertyAlias);
//is it strongly typed?
var stronglyTyped = cropperValue as ImageCropperValue;

4
src/Umbraco.Web/ImageCropperTemplateExtensions.cs → src/Umbraco.Web.Common/Extensions/ImageCropperTemplateExtensions.cs
View File

@@ -1,11 +1,11 @@
using System;
using System.Globalization;
using Newtonsoft.Json;
using Umbraco.Composing;
using Umbraco.Core;
using Umbraco.Web.Composing;
using Umbraco.Core.PropertyEditors.ValueConverters;
namespace Umbraco.Web
namespace Umbraco.Extensions
{
/// <summary>
/// Provides extension methods for getting ImageProcessor Url from the core Image Cropper property editor

26
src/Umbraco.Web.UI.NetCore/Umbraco/PartialViewMacros/Templates/Gallery.cshtml
View File

@@ -2,12 +2,15 @@
@using Umbraco.Web
@using Umbraco.Core
@using Umbraco.Core.Media
@using Umbraco.Extensions
@using Umbraco.Web.Routing
@inherits Umbraco.Web.Common.Macros.PartialViewMacroPage
@inject IPublishedValueFallback PublishedValueFallback
@inject IPublishedContentQuery PublishedContentQuery
@inject IVariationContextAccessor VariationContextAccessor
@inject IPublishedUrlProvider PublishedUrlProvider
@inject IImageUrlGenerator ImageUrlGenerator
@*
Macro to display a gallery of images from the Media section.
Works with either a 'Single Media Picker' or a 'Multiple Media Picker' macro parameter (see below).
@@ -34,25 +37,22 @@
@* a single image *@
if (media.IsDocumentType("Image"))
{
Render(media);
<div class="col-xs-6 col-md-3">
<a href="@media.Url(PublishedUrlProvider)" class="thumbnail">
<img src="@media.GetCropUrl(ImageUrlGenerator, PublishedValueFallback, PublishedUrlProvider, width: 200, height: 200)" alt="@media.Name"/>
</a>
</div>
}
@* a folder with images under it *@
foreach (var image in media.Children(VariationContextAccessor))
{
Render(image);
<div class="col-xs-6 col-md-3">
<a href="@image.Url(PublishedUrlProvider)" class="thumbnail">
<img src="@image.GetCropUrl(ImageUrlGenerator, PublishedValueFallback, PublishedUrlProvider, width: 200, height: 200)" alt="@image.Name"/>
</a>
</div>
}
}
</div>
}
@{
void Render(IPublishedContent item)
{
/*@<div class="col-xs-6 col-md-3">
<a href="@item.Url(PublishedUrlProvider)" class="thumbnail">
<img src="@(item.GetCropUrl(ImageUrlGenerator, width: 200, height: 200))" alt="@item.Name" />
</a>
</div>;*/
}
}

25
src/Umbraco.Web/PublishedElementExtensions.cs
View File

@@ -97,31 +97,6 @@ namespace Umbraco.Web
#endregion
#region MediaUrl
/// <summary>
/// Gets the url for a media.
/// </summary>
/// <param name="content">The content item.</param>
/// <param name="culture">The culture (use current culture by default).</param>
/// <param name="mode">The url mode (use site configuration by default).</param>
/// <param name="propertyAlias">The alias of the property (use 'umbracoFile' by default).</param>
/// <returns>The url for the media.</returns>
/// <remarks>
/// <para>The value of this property is contextual. It depends on the 'current' request uri,
/// if any. In addition, when the content type is multi-lingual, this is the url for the
/// specified culture. Otherwise, it is the invariant url.</para>
/// </remarks>
public static string MediaUrl(this IPublishedContent content, string culture = null, UrlMode mode = UrlMode.Default, string propertyAlias = Constants.Conventions.Media.File)
{
var publishedUrlProvider = Current.PublishedUrlProvider;
if (publishedUrlProvider== null)
throw new InvalidOperationException("Cannot resolve a Url when Current.PublishedUrlProvider is null.");
return publishedUrlProvider.GetMediaUrl(content, mode, culture, propertyAlias);
}
#endregion
}
}

2
src/Umbraco.Web/Umbraco.Web.csproj
View File

@@ -162,7 +162,6 @@
<Compile Include="Models\NoNodesViewModel.cs" />
<Compile Include="Mvc\RenderNoContentController.cs" />
<Compile Include="HttpContextAccessorExtensions.cs" />
<Compile Include="ImageCropperTemplateCoreExtensions.cs" />
<Compile Include="Logging\OwinLogger.cs" />
<Compile Include="Logging\OwinLoggerFactory.cs" />
<Compile Include="Logging\WebProfiler.cs" />
@@ -284,7 +283,6 @@
<Compile Include="Mvc\MinifyJavaScriptResultAttribute.cs" />
<Compile Include="Mvc\EnsurePublishedContentRequestAttribute.cs" />
<Compile Include="Mvc\UmbracoViewPage.cs" />
<Compile Include="ImageCropperTemplateExtensions.cs" />
<Compile Include="Mvc\UmbracoVirtualNodeRouteHandler.cs" />
<Compile Include="Security\AppBuilderExtensions.cs" />
<Compile Include="Security\AuthenticationOptionsExtensions.cs" />

492
src/Umbraco.Web/UrlHelperRenderExtensions.cs
View File

@@ -21,252 +21,252 @@ namespace Umbraco.Web
private static readonly IHtmlString EmptyHtmlString = new HtmlString(string.Empty);
#region GetCropUrl
/// <summary>
/// Gets the ImageProcessor Url of a media item by the crop alias (using default media item property alias of "umbracoFile")
/// </summary>
/// <param name="urlHelper"></param>
/// <param name="mediaItem">
/// The IPublishedContent item.
/// </param>
/// <param name="cropAlias">
/// The crop alias e.g. thumbnail
/// </param>
/// <param name="htmlEncode">
/// Whether to HTML encode this URL - default is true - w3c standards require HTML attributes to be HTML encoded but this can be
/// set to false if using the result of this method for CSS.
/// </param>
/// <returns></returns>
public static IHtmlString GetCropUrl(this UrlHelper urlHelper, IPublishedContent mediaItem, IImageUrlGenerator imageUrlGenerator, string cropAlias, bool htmlEncode = true)
{
if (mediaItem == null) return EmptyHtmlString;
var url = mediaItem.GetCropUrl(imageUrlGenerator, cropAlias: cropAlias, useCropDimensions: true);
return htmlEncode ? new HtmlString(HttpUtility.HtmlEncode(url)) : new HtmlString(url);
}
/// <summary>
/// Gets the ImageProcessor Url by the crop alias using the specified property containing the image cropper Json data on the IPublishedContent item.
/// </summary>
/// <param name="urlHelper"></param>
/// <param name="mediaItem">
/// The IPublishedContent item.
/// </param>
/// <param name="propertyAlias">
/// The property alias of the property containing the Json data e.g. umbracoFile
/// </param>
/// <param name="cropAlias">
/// The crop alias e.g. thumbnail
/// </param>
/// <param name="htmlEncode">
/// Whether to HTML encode this URL - default is true - w3c standards require HTML attributes to be HTML encoded but this can be
/// set to false if using the result of this method for CSS.
/// </param>
/// <returns>
/// The ImageProcessor.Web Url.
/// </returns>
public static IHtmlString GetCropUrl(this UrlHelper urlHelper, IPublishedContent mediaItem, string propertyAlias, string cropAlias, IImageUrlGenerator imageUrlGenerator, bool htmlEncode = true)
{
if (mediaItem == null) return EmptyHtmlString;
var url = mediaItem.GetCropUrl(imageUrlGenerator, propertyAlias: propertyAlias, cropAlias: cropAlias, useCropDimensions: true);
return htmlEncode ? new HtmlString(HttpUtility.HtmlEncode(url)) : new HtmlString(url);
}
/// <summary>
/// Gets the ImageProcessor Url from the image path.
/// </summary>
/// <param name="mediaItem">
/// The IPublishedContent item.
/// </param>
/// <param name="width">
/// The width of the output image.
/// </param>
/// <param name="height">
/// The height of the output image.
/// </param>
/// <param name="propertyAlias">
/// Property alias of the property containing the Json data.
/// </param>
/// <param name="cropAlias">
/// The crop alias.
/// </param>
/// <param name="quality">
/// Quality percentage of the output image.
/// </param>
/// <param name="imageCropMode">
/// The image crop mode.
/// </param>
/// <param name="imageCropAnchor">
/// The image crop anchor.
/// </param>
/// <param name="preferFocalPoint">
/// Use focal point to generate an output image using the focal point instead of the predefined crop if there is one
/// </param>
/// <param name="useCropDimensions">
/// Use crop dimensions to have the output image sized according to the predefined crop sizes, this will override the width and height parameters
/// </param>
/// <param name="cacheBuster">
/// Add a serialized date of the last edit of the item to ensure client cache refresh when updated
/// </param>
/// <param name="furtherOptions">
/// These are any query string parameters (formatted as query strings) that ImageProcessor supports. For example:
/// <example>
/// <![CDATA[
/// furtherOptions: "&bgcolor=fff"
/// ]]>
/// </example>
/// </param>
/// <param name="ratioMode">
/// Use a dimension as a ratio
/// </param>
/// <param name="upScale">
/// If the image should be upscaled to requested dimensions
/// </param>
/// <param name="urlHelper"></param>
/// <param name="htmlEncode">
/// Whether to HTML encode this URL - default is true - w3c standards require HTML attributes to be HTML encoded but this can be
/// set to false if using the result of this method for CSS.
/// </param>
/// <returns>
/// The <see cref="string"/>.
/// </returns>
public static IHtmlString GetCropUrl(this UrlHelper urlHelper,
IPublishedContent mediaItem,
IImageUrlGenerator imageUrlGenerator,
int? width = null,
int? height = null,
string propertyAlias = Umbraco.Core.Constants.Conventions.Media.File,
string cropAlias = null,
int? quality = null,
ImageCropMode? imageCropMode = null,
ImageCropAnchor? imageCropAnchor = null,
bool preferFocalPoint = false,
bool useCropDimensions = false,
bool cacheBuster = true,
string furtherOptions = null,
ImageCropRatioMode? ratioMode = null,
bool upScale = true,
bool htmlEncode = true)
{
if (mediaItem == null) return EmptyHtmlString;
var url = mediaItem.GetCropUrl(imageUrlGenerator, width, height, propertyAlias, cropAlias, quality, imageCropMode,
imageCropAnchor, preferFocalPoint, useCropDimensions, cacheBuster, furtherOptions, ratioMode,
upScale);
return htmlEncode ? new HtmlString(HttpUtility.HtmlEncode(url)) : new HtmlString(url);
}
/// <summary>
/// Gets the ImageProcessor Url from the image path.
/// </summary>
/// <param name="imageUrl">
/// The image url.
/// </param>
/// <param name="width">
/// The width of the output image.
/// </param>
/// <param name="height">
/// The height of the output image.
/// </param>
/// <param name="imageCropperValue">
/// The Json data from the Umbraco Core Image Cropper property editor
/// </param>
/// <param name="cropAlias">
/// The crop alias.
/// </param>
/// <param name="quality">
/// Quality percentage of the output image.
/// </param>
/// <param name="imageCropMode">
/// The image crop mode.
/// </param>
/// <param name="imageCropAnchor">
/// The image crop anchor.
/// </param>
/// <param name="preferFocalPoint">
/// Use focal point to generate an output image using the focal point instead of the predefined crop if there is one
/// </param>
/// <param name="useCropDimensions">
/// Use crop dimensions to have the output image sized according to the predefined crop sizes, this will override the width and height parameters
/// </param>
/// <param name="cacheBusterValue">
/// Add a serialized date of the last edit of the item to ensure client cache refresh when updated
/// </param>
/// <param name="furtherOptions">
/// These are any query string parameters (formatted as query strings) that ImageProcessor supports. For example:
/// <example>
/// <![CDATA[
/// furtherOptions: "&bgcolor=fff"
/// ]]>
/// </example>
/// </param>
/// <param name="ratioMode">
/// Use a dimension as a ratio
/// </param>
/// <param name="upScale">
/// If the image should be upscaled to requested dimensions
/// </param>
/// <param name="urlHelper"></param>
/// <param name="htmlEncode">
/// Whether to HTML encode this URL - default is true - w3c standards require HTML attributes to be HTML encoded but this can be
/// set to false if using the result of this method for CSS.
/// </param>
/// <returns>
/// The <see cref="string"/>.
/// </returns>
public static IHtmlString GetCropUrl(this UrlHelper urlHelper,
string imageUrl,
IImageUrlGenerator imageUrlGenerator,
int? width = null,
int? height = null,
string imageCropperValue = null,
string cropAlias = null,
int? quality = null,
ImageCropMode? imageCropMode = null,
ImageCropAnchor? imageCropAnchor = null,
bool preferFocalPoint = false,
bool useCropDimensions = false,
string cacheBusterValue = null,
string furtherOptions = null,
ImageCropRatioMode? ratioMode = null,
bool upScale = true,
bool htmlEncode = true)
{
var url = imageUrl.GetCropUrl(imageUrlGenerator, width, height, imageCropperValue, cropAlias, quality, imageCropMode,
imageCropAnchor, preferFocalPoint, useCropDimensions, cacheBusterValue, furtherOptions, ratioMode,
upScale);
return htmlEncode ? new HtmlString(HttpUtility.HtmlEncode(url)) : new HtmlString(url);
}
public static IHtmlString GetCropUrl(this UrlHelper urlHelper,
ImageCropperValue imageCropperValue,
IImageUrlGenerator imageUrlGenerator,
int? width = null,
int? height = null,
string cropAlias = null,
int? quality = null,
ImageCropMode? imageCropMode = null,
ImageCropAnchor? imageCropAnchor = null,
bool preferFocalPoint = false,
bool useCropDimensions = false,
string cacheBusterValue = null,
string furtherOptions = null,
ImageCropRatioMode? ratioMode = null,
bool upScale = true,
bool htmlEncode = true)
{
if (imageCropperValue == null) return EmptyHtmlString;
var imageUrl = imageCropperValue.Src;
var url = imageUrl.GetCropUrl(imageUrlGenerator, imageCropperValue, width, height, cropAlias, quality, imageCropMode,
imageCropAnchor, preferFocalPoint, useCropDimensions, cacheBusterValue, furtherOptions, ratioMode,
upScale);
return htmlEncode ? new HtmlString(HttpUtility.HtmlEncode(url)) : new HtmlString(url);
}
#endregion
// #region GetCropUrl
//
// /// <summary>
// /// Gets the ImageProcessor Url of a media item by the crop alias (using default media item property alias of "umbracoFile")
// /// </summary>
// /// <param name="urlHelper"></param>
// /// <param name="mediaItem">
// /// The IPublishedContent item.
// /// </param>
// /// <param name="cropAlias">
// /// The crop alias e.g. thumbnail
// /// </param>
// /// <param name="htmlEncode">
// /// Whether to HTML encode this URL - default is true - w3c standards require HTML attributes to be HTML encoded but this can be
// /// set to false if using the result of this method for CSS.
// /// </param>
// /// <returns></returns>
// public static IHtmlString GetCropUrl(this UrlHelper urlHelper, IPublishedContent mediaItem, IImageUrlGenerator imageUrlGenerator, string cropAlias, bool htmlEncode = true)
// {
// if (mediaItem == null) return EmptyHtmlString;
//
// var url = mediaItem.GetCropUrl(imageUrlGenerator, cropAlias: cropAlias, useCropDimensions: true);
// return htmlEncode ? new HtmlString(HttpUtility.HtmlEncode(url)) : new HtmlString(url);
// }
//
// /// <summary>
// /// Gets the ImageProcessor Url by the crop alias using the specified property containing the image cropper Json data on the IPublishedContent item.
// /// </summary>
// /// <param name="urlHelper"></param>
// /// <param name="mediaItem">
// /// The IPublishedContent item.
// /// </param>
// /// <param name="propertyAlias">
// /// The property alias of the property containing the Json data e.g. umbracoFile
// /// </param>
// /// <param name="cropAlias">
// /// The crop alias e.g. thumbnail
// /// </param>
// /// <param name="htmlEncode">
// /// Whether to HTML encode this URL - default is true - w3c standards require HTML attributes to be HTML encoded but this can be
// /// set to false if using the result of this method for CSS.
// /// </param>
// /// <returns>
// /// The ImageProcessor.Web Url.
// /// </returns>
// public static IHtmlString GetCropUrl(this UrlHelper urlHelper, IPublishedContent mediaItem, string propertyAlias, string cropAlias, IImageUrlGenerator imageUrlGenerator, bool htmlEncode = true)
// {
// if (mediaItem == null) return EmptyHtmlString;
//
// var url = mediaItem.GetCropUrl(imageUrlGenerator, propertyAlias: propertyAlias, cropAlias: cropAlias, useCropDimensions: true);
// return htmlEncode ? new HtmlString(HttpUtility.HtmlEncode(url)) : new HtmlString(url);
// }
//
// /// <summary>
// /// Gets the ImageProcessor Url from the image path.
// /// </summary>
// /// <param name="mediaItem">
// /// The IPublishedContent item.
// /// </param>
// /// <param name="width">
// /// The width of the output image.
// /// </param>
// /// <param name="height">
// /// The height of the output image.
// /// </param>
// /// <param name="propertyAlias">
// /// Property alias of the property containing the Json data.
// /// </param>
// /// <param name="cropAlias">
// /// The crop alias.
// /// </param>
// /// <param name="quality">
// /// Quality percentage of the output image.
// /// </param>
// /// <param name="imageCropMode">
// /// The image crop mode.
// /// </param>
// /// <param name="imageCropAnchor">
// /// The image crop anchor.
// /// </param>
// /// <param name="preferFocalPoint">
// /// Use focal point to generate an output image using the focal point instead of the predefined crop if there is one
// /// </param>
// /// <param name="useCropDimensions">
// /// Use crop dimensions to have the output image sized according to the predefined crop sizes, this will override the width and height parameters
// /// </param>
// /// <param name="cacheBuster">
// /// Add a serialized date of the last edit of the item to ensure client cache refresh when updated
// /// </param>
// /// <param name="furtherOptions">
// /// These are any query string parameters (formatted as query strings) that ImageProcessor supports. For example:
// /// <example>
// /// <![CDATA[
// /// furtherOptions: "&bgcolor=fff"
// /// ]]>
// /// </example>
// /// </param>
// /// <param name="ratioMode">
// /// Use a dimension as a ratio
// /// </param>
// /// <param name="upScale">
// /// If the image should be upscaled to requested dimensions
// /// </param>
// /// <param name="urlHelper"></param>
// /// <param name="htmlEncode">
// /// Whether to HTML encode this URL - default is true - w3c standards require HTML attributes to be HTML encoded but this can be
// /// set to false if using the result of this method for CSS.
// /// </param>
// /// <returns>
// /// The <see cref="string"/>.
// /// </returns>
// public static IHtmlString GetCropUrl(this UrlHelper urlHelper,
// IPublishedContent mediaItem,
// IImageUrlGenerator imageUrlGenerator,
// int? width = null,
// int? height = null,
// string propertyAlias = Umbraco.Core.Constants.Conventions.Media.File,
// string cropAlias = null,
// int? quality = null,
// ImageCropMode? imageCropMode = null,
// ImageCropAnchor? imageCropAnchor = null,
// bool preferFocalPoint = false,
// bool useCropDimensions = false,
// bool cacheBuster = true,
// string furtherOptions = null,
// ImageCropRatioMode? ratioMode = null,
// bool upScale = true,
// bool htmlEncode = true)
// {
// if (mediaItem == null) return EmptyHtmlString;
//
// var url = mediaItem.GetCropUrl(imageUrlGenerator, width, height, propertyAlias, cropAlias, quality, imageCropMode,
// imageCropAnchor, preferFocalPoint, useCropDimensions, cacheBuster, furtherOptions, ratioMode,
// upScale);
// return htmlEncode ? new HtmlString(HttpUtility.HtmlEncode(url)) : new HtmlString(url);
// }
//
// /// <summary>
// /// Gets the ImageProcessor Url from the image path.
// /// </summary>
// /// <param name="imageUrl">
// /// The image url.
// /// </param>
// /// <param name="width">
// /// The width of the output image.
// /// </param>
// /// <param name="height">
// /// The height of the output image.
// /// </param>
// /// <param name="imageCropperValue">
// /// The Json data from the Umbraco Core Image Cropper property editor
// /// </param>
// /// <param name="cropAlias">
// /// The crop alias.
// /// </param>
// /// <param name="quality">
// /// Quality percentage of the output image.
// /// </param>
// /// <param name="imageCropMode">
// /// The image crop mode.
// /// </param>
// /// <param name="imageCropAnchor">
// /// The image crop anchor.
// /// </param>
// /// <param name="preferFocalPoint">
// /// Use focal point to generate an output image using the focal point instead of the predefined crop if there is one
// /// </param>
// /// <param name="useCropDimensions">
// /// Use crop dimensions to have the output image sized according to the predefined crop sizes, this will override the width and height parameters
// /// </param>
// /// <param name="cacheBusterValue">
// /// Add a serialized date of the last edit of the item to ensure client cache refresh when updated
// /// </param>
// /// <param name="furtherOptions">
// /// These are any query string parameters (formatted as query strings) that ImageProcessor supports. For example:
// /// <example>
// /// <![CDATA[
// /// furtherOptions: "&bgcolor=fff"
// /// ]]>
// /// </example>
// /// </param>
// /// <param name="ratioMode">
// /// Use a dimension as a ratio
// /// </param>
// /// <param name="upScale">
// /// If the image should be upscaled to requested dimensions
// /// </param>
// /// <param name="urlHelper"></param>
// /// <param name="htmlEncode">
// /// Whether to HTML encode this URL - default is true - w3c standards require HTML attributes to be HTML encoded but this can be
// /// set to false if using the result of this method for CSS.
// /// </param>
// /// <returns>
// /// The <see cref="string"/>.
// /// </returns>
// public static IHtmlString GetCropUrl(this UrlHelper urlHelper,
// string imageUrl,
// IImageUrlGenerator imageUrlGenerator,
// int? width = null,
// int? height = null,
// string imageCropperValue = null,
// string cropAlias = null,
// int? quality = null,
// ImageCropMode? imageCropMode = null,
// ImageCropAnchor? imageCropAnchor = null,
// bool preferFocalPoint = false,
// bool useCropDimensions = false,
// string cacheBusterValue = null,
// string furtherOptions = null,
// ImageCropRatioMode? ratioMode = null,
// bool upScale = true,
// bool htmlEncode = true)
// {
// var url = imageUrl.GetCropUrl(imageUrlGenerator, width, height, imageCropperValue, cropAlias, quality, imageCropMode,
// imageCropAnchor, preferFocalPoint, useCropDimensions, cacheBusterValue, furtherOptions, ratioMode,
// upScale);
// return htmlEncode ? new HtmlString(HttpUtility.HtmlEncode(url)) : new HtmlString(url);
// }
//
// public static IHtmlString GetCropUrl(this UrlHelper urlHelper,
// ImageCropperValue imageCropperValue,
// IImageUrlGenerator imageUrlGenerator,
// int? width = null,
// int? height = null,
// string cropAlias = null,
// int? quality = null,
// ImageCropMode? imageCropMode = null,
// ImageCropAnchor? imageCropAnchor = null,
// bool preferFocalPoint = false,
// bool useCropDimensions = false,
// string cacheBusterValue = null,
// string furtherOptions = null,
// ImageCropRatioMode? ratioMode = null,
// bool upScale = true,
// bool htmlEncode = true)
// {
// if (imageCropperValue == null) return EmptyHtmlString;
//
// var imageUrl = imageCropperValue.Src;
// var url = imageUrl.GetCropUrl(imageUrlGenerator, imageCropperValue, width, height, cropAlias, quality, imageCropMode,
// imageCropAnchor, preferFocalPoint, useCropDimensions, cacheBusterValue, furtherOptions, ratioMode,
// upScale);
// return htmlEncode ? new HtmlString(HttpUtility.HtmlEncode(url)) : new HtmlString(url);
// }
//
// #endregion
/// <summary>
/// Generates a URL based on the current Umbraco URL with a custom query string that will route to the specified SurfaceController