vendor/contao/core-bundle/src/Resources/contao/modules/ModuleRandomImage.php line 37

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of Contao.
  5.  *
  6.  * (c) Leo Feyer
  7.  *
  8.  * @license LGPL-3.0-or-later
  9.  */
  11. namespace Contao;
  13. use Contao\Model\Collection;
  15. /**
  16.  * Front end module "random image".
  17.  */
  18. class ModuleRandomImage extends Module
  19. {
  20.     /**
  21.      * Files object
  22.      * @var Collection|FilesModel
  23.      */
  24.     protected $objFiles;
  26.     /**
  27.      * Template
  28.      * @var string
  29.      */
  30.     protected $strTemplate = 'mod_randomImage';
  32.     /**
  33.      * Check the source folder
  34.      *
  35.      * @return string
  36.      */
  37.     public function generate()
  38.     {
  39.         $this->multiSRC = StringUtil::deserialize($this->multiSRC);
  41.         if (empty($this->multiSRC) || !\is_array($this->multiSRC))
  42.         {
  43.             return '';
  44.         }
  46.         $this->objFiles = FilesModel::findMultipleByUuids($this->multiSRC);
  48.         if ($this->objFiles === null)
  49.         {
  50.             return '';
  51.         }
  53.         return parent::generate();
  54.     }
  56.     /**
  57.      * Generate the module
  58.      */
  59.     protected function compile()
  60.     {
  61.         $images = array();
  62.         $objFiles = $this->objFiles;
  64.         // Get all images
  65.         while ($objFiles->next())
  66.         {
  67.             // Continue if the files has been processed or does not exist
  68.             if (isset($images[$objFiles->path]) || !file_exists(System::getContainer()->getParameter('kernel.project_dir') . '/' . $objFiles->path))
  69.             {
  70.                 continue;
  71.             }
  73.             // Single files
  74.             if ($objFiles->type == 'file')
  75.             {
  76.                 $objFile = new File($objFiles->path);
  78.                 if (!$objFile->isImage)
  79.                 {
  80.                     continue;
  81.                 }
  83.                 // Add the image
  84.                 $images[$objFiles->path] = $objFiles->current();
  85.             }
  87.             // Folders
  88.             else
  89.             {
  90.                 $objSubfiles = FilesModel::findByPid($objFiles->uuid, array('order' => 'name'));
  92.                 if ($objSubfiles === null)
  93.                 {
  94.                     continue;
  95.                 }
  97.                 while ($objSubfiles->next())
  98.                 {
  99.                     // Skip subfolders
  100.                     if ($objSubfiles->type == 'folder')
  101.                     {
  102.                         continue;
  103.                     }
  105.                     $objFile = new File($objSubfiles->path);
  107.                     if (!$objFile->isImage)
  108.                     {
  109.                         continue;
  110.                     }
  112.                     // Add the image
  113.                     $images[$objSubfiles->path] = $objSubfiles->current();
  114.                 }
  115.             }
  116.         }
  118.         if (empty($images))
  119.         {
  120.             return;
  121.         }
  123.         $figure = System::getContainer()
  124.             ->get('contao.image.studio')
  125.             ->createFigureBuilder()
  126.             ->fromFilesModel($images[array_rand($images)])
  127.             ->setSize($this->imgSize)
  128.             ->enableLightbox((bool) $this->fullsize)
  129.             ->build();
  131.         $imageData = $figure->getLegacyTemplateData();
  132.         $imageData['figure'] = $figure;
  134.         $this->Template->setData(array_merge(
  135.             $this->Template->getData(),
  136.             $imageData,
  137.             array('caption' => $this->useCaption ? $imageData['caption'] ?? '' : null)
  138.         ));
  139.     }
  140. }
  142. class_alias(ModuleRandomImage::class, 'ModuleRandomImage');