vendor/addictic/content-element-bundle/src/Resources/contao/classes/ImagesHelper.php line 135

Open in your IDE?
  1. <?php
  3. namespace Addictic\ContentElementBundle\contao\classes;
  5. use Contao\File;
  6. use Contao\FilesModel;
  7. use Contao\Image;
  8. use Contao\StringUtil;
  9. use Exception;
  10. use WebPConvert\Convert\Exceptions\ConversionFailedException;
  12. /**
  13.  * This class generate images arrays with a format based on breakpoint
  14.  *
  15.  * usage for single image:
  16.  *      $arrBreakpoints = [
  17.  *         'sm' => 576,
  18.  *         'md' => 768,
  19.  *         'lg' => 992,
  20.  *         'xl' => 1200,
  21.  *      ];
  22.  *      $objImageFile = ImagesHelper::getImageFile($uuid)
  23.  *      $arrImagesSrcset = ImagesHelper::getSrcsetImages($objImageFile, $arrBreakpoints)
  24.  *
  25.  * usage for multiple images:
  26.  *       $arrMultipleImagesSrcset = ImagesHelper::getMultipleSrcsetImages($arrUuid, $strAlt, $breakpoints)
  27.  *
  28.  * Class ImagesHelper
  29.  * @package Addictic\ContaoHelpersBundle
  30.  */
  31. class ImagesHelper
  32. {
  33.     protected static $breakpoints = [
  34.         'sm' => 576,
  35.         'md' => 768,
  36.         'lg' => 992,
  37.         'xl' => 1200,
  38.     ];
  40.     /**
  41.      * @param string|null $uuid
  42.      *
  43.      * @return FilesModel|null
  44.      */
  45.     public static function getImageFile(?string $uuid): ?FilesModel
  46.     {
  47.         if ($uuid) {
  48.             $objImageFile = FilesModel::findByUuid($uuid);
  49.             return $objImageFile;
  50.         } else return null;
  51.     }
  53.     /**
  54.      * Return image text alt or custom alt
  55.      *
  56.      * @param FilesModel $objImage
  57.      * @param string|null $customAlt
  58.      *
  59.      * @return string|null
  60.      */
  61.     public static function getImageAlt(FilesModel $objImage, ?string $customAlt = ''): ?string
  62.     {
  63.         if (!$objImage) return '';
  64.         $meta = self::getImageMetas($objImage);
  65.         if(!$meta) return '';
  66.         return $meta['alt'] ?: $customAlt;
  67.     }
  69.     /**
  70.      * Return image title
  71.      *
  72.      * @param FilesModel $objImage
  73.      *
  74.      * @return string|null
  75.      */
  76.     public static function getImageTitle(FilesModel $objImage): ?string
  77.     {
  78.         if (!$objImage) return '';
  79.         $meta = self::getImageMetas($objImage);
  80.         if(!$meta) return '';
  81.         return $meta['title'] ?: '';
  82.     }
  84.     public static function getImageMetas(FilesModel $objImage)
  85.     {
  86.         $lang = $GLOBALS['TL_LANGUAGE'];
  87.         $metas = StringUtil::deserialize($objImage->meta);
  88.         if(!$metas) return null;
  89.         if(!array_key_exists($lang, $metas)) $lang = preg_replace("/\-/", '_', $lang);
  90.         return $metas[$lang];
  91.     }
  93.     /**
  94.      * @param FilesModel $objImage
  95.      * @return array
  96.      */
  97.     public static function getImageFormat(FilesModel $objImage): array
  98.     {
  99.         if (!$objImage || !is_file($objImage->path)) return [];
  100.         list($width, $height, $type, $attr) = getimagesize($objImage->path);
  102.         $format = 'landscape';
  103.         if ($height > $width) $format = 'portrait';
  104.         if ($height === $width) $format = 'square';
  106.         return [
  107.             'width' => $width,
  108.             'height' => $height,
  109.             'type' => $type,
  110.             'attr' => $attr,
  111.             'format' => $format
  112.         ];
  113.     }
  115.     /**
  116.      * @param FilesModel $objImage
  117.      * @param int|null $width
  118.      * @param int|null $height
  119.      * @param int|null $zoomLevel
  120.      * @param string $mode
  121.      *
  122.      * @return string
  123.      * @throws Exception
  124.      */
  125.     public static function getThumbImagePath(FilesModel $objImage, ?int $width = null, ?int $height = null, ?int $zoomLevel = null, string $mode = 'proportional'): string
  126.     {
  127.         if (!$objImage) return '';
  128.         if ($objImage->extension === 'png') return $objImage->path;
  129.         $image = new Image(new File($objImage->path));
  130.         return $image
  131.             ->setTargetWidth($width)
  132.             ->setTargetHeight($height)
  133.             ->setResizeMode($mode)
  134.             ->setZoomLevel($zoomLevel)
  135.             ->executeResize()
  136.             ->getResizedPath();
  137.     }
  139.     /**
  140.      * @param FilesModel $objImage
  141.      * @param array|null $breakpoints
  142.      * @param string|null $cutomAlt
  143.      *
  144.      * @return array
  145.      * @throws ConversionFailedException
  146.      */
  147.     public static function getSrcsetImages(FilesModel $objImage, ?array $breakpoints = null, ?string $cutomAlt = ''): array
  148.     {
  149.         $arrSrcsetImages = [];
  150.         $breakpoints = $breakpoints ?: self::$breakpoints;
  152.         foreach ($breakpoints as $key => $value) {
  153.             $imagePath = self::getThumbImagePath($objImage, $value, null, null, 'proportional');
  154.             if (WebPHelper::hasWebPSupport() && file_exists($imagePath)) $imagePath = WebPHelper::getWebPImage($imagePath);
  155.             $arrSrcsetImages[$key] = $imagePath;
  156.         }
  158.         $arrSrcsetImages['default'] = $objImage->path;
  159.         $arrSrcsetImages['extension'] = $objImage->extension;
  160.         $arrSrcsetImages['alt'] = self::getImageAlt($objImage, $cutomAlt);
  161.         $arrSrcsetImages['title'] = self::getImageTitle($objImage);
  163.         return $arrSrcsetImages;
  164.     }
  166.     /**
  167.      * @param array $arrUuid
  168.      * @param array|null $breakpoints
  169.      *
  170.      * @return array
  171.      * @throws Exception
  172.      */
  173.     public static function getMultipleSrcsetImages(array $arrUuid, ?array $breakpoints = null): array
  174.     {
  175.         $arrMultipleSrcsetImage = [];
  176.         $breakpoints = $breakpoints ?: self::$breakpoints;
  178.         foreach ($arrUuid as $k => $uuid) {
  179.             $objImageFile = self::getImageFile($uuid);
  180.             if (!$objImageFile) continue;
  181.             $arrMultipleSrcsetImage[$k]['images'] = self::getSrcsetImages($objImageFile, $breakpoints);
  182.         }
  184.         return $arrMultipleSrcsetImage;
  185.     }
  186. }