V9: Reintroduce missing friendly get crop url extensions (#10233)

* Adds missing extension methods of `GetCropUrl` that uses the service locator og inject the required services.

* Xml docs updated
This commit is contained in:
Bjarke Berg
2021-05-06 10:06:22 +02:00
committed by GitHub
parent 0bdeda378a
commit 261730f530
2 changed files with 328 additions and 12 deletions

View File

@@ -12,7 +12,7 @@ namespace Umbraco.Extensions
public static class ImageCropperTemplateCoreExtensions
{
/// <summary>
/// Gets the ImageProcessor URL by the crop alias (from the "umbracoFile" property alias) on the IPublishedContent item
/// Gets the underlying image processing service URL by the crop alias (from the "umbracoFile" property alias) on the IPublishedContent item
/// </summary>
/// <param name="mediaItem">
/// The IPublishedContent item.
@@ -24,7 +24,7 @@ namespace Umbraco.Extensions
/// <param name="publishedValueFallback">The published value fallback.</param>
/// <param name="publishedUrlProvider">The published url provider.</param>
/// <returns>
/// The ImageProcessor.Web URL.
/// The URL of the cropped image.
/// </returns>
public static string GetCropUrl(
this IPublishedContent mediaItem,
@@ -37,7 +37,7 @@ namespace Umbraco.Extensions
}
/// <summary>
/// Gets the ImageProcessor URL by the crop alias using the specified property containing the image cropper Json data on the IPublishedContent item.
/// Gets the underlying image processing service URL by the crop alias using the specified property containing the image cropper Json data on the IPublishedContent item.
/// </summary>
/// <param name="mediaItem">
/// The IPublishedContent item.
@@ -52,7 +52,7 @@ namespace Umbraco.Extensions
/// <param name="publishedValueFallback">The published value fallback.</param>
/// <param name="publishedUrlProvider">The published url provider.</param>
/// <returns>
/// The ImageProcessor.Web URL.
/// The URL of the cropped image.
/// </returns>
public static string GetCropUrl(
this IPublishedContent mediaItem,
@@ -66,7 +66,7 @@ namespace Umbraco.Extensions
}
/// <summary>
/// Gets the ImageProcessor URL from the IPublishedContent item.
/// Gets the underlying image processing service URL from the IPublishedContent item.
/// </summary>
/// <param name="mediaItem">
/// The IPublishedContent item.
@@ -118,9 +118,8 @@ namespace Umbraco.Extensions
/// <param name="upScale">
/// If the image should be upscaled to requested dimensions
/// </param>
/// <returns>
/// The <see cref="string"/>.
/// The URL of the cropped image.
/// </returns>
public static string GetCropUrl(
this IPublishedContent mediaItem,
@@ -179,7 +178,7 @@ namespace Umbraco.Extensions
}
/// <summary>
/// Gets the ImageProcessor URL from the image path.
/// Gets the underlying image processing service URL from the image path.
/// </summary>
/// <param name="imageUrl">
/// The image URL.
@@ -215,7 +214,7 @@ namespace Umbraco.Extensions
/// 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:
/// These are any query string parameters (formatted as query strings) that the underlying image processing service supports. For example:
/// <example>
/// <![CDATA[
/// furtherOptions: "&bgcolor=fff"
@@ -229,7 +228,7 @@ namespace Umbraco.Extensions
/// If the image should be upscaled to requested dimensions
/// </param>
/// <returns>
/// The <see cref="string"/>.
/// The the URL of the cropped image.
/// </returns>
public static string GetCropUrl(
this string imageUrl,
@@ -261,7 +260,7 @@ namespace Umbraco.Extensions
}
/// <summary>
/// Gets the ImageProcessor URL from the image path.
/// Gets the underlying image processing service URL from the image path.
/// </summary>
/// <param name="imageUrl">
/// The image URL.
@@ -298,7 +297,7 @@ namespace Umbraco.Extensions
/// 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:
/// These are any query string parameters (formatted as query strings) that the underlying image processing service supports. For example:
/// <example>
/// <![CDATA[
/// furtherOptions: "&bgcolor=fff"