Update BannerHelper.php with better deprecation information (#42282)

Update BannerHelper.php with better deprecation information
joomla · Nov 13, 2023 · cddc400 · cddc400
1 parent 4dd90b4
commit cddc400
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/components/com_banners/src/Helper/BannerHelper.php b/components/com_banners/src/Helper/BannerHelper.php
@@ -18,6 +18,8 @@
  * Banner Helper Class
  *
  * @since  1.6
+ *
+ * @deprecated  5.1 will be removed in 7.0
  */
 abstract class BannerHelper
 {
@@ -31,7 +33,9 @@ abstract class BannerHelper
      * @since   1.6
      *
      * @deprecated  5.1 will be removed in 7.0
-     *              Use MediaHelper::isImage($url) instead
+     *              When testing the image file, use Joomla\CMS\Helper\MediaHelper::isImage($url) for pixel-based image files
+     *              in combination with Joomla\CMS\Helper\MediaHelper::getMimeType($url) === 'image/svg+xml' for vector based image files
+     *              Be aware that the image url should first be sanitized with the helper function Joomla\CMS\HTML\HTMLHelper::cleanImageURL($imageurl)
      */
     public static function isImage($url)
     {