vendor/madeyourday/contao-rocksolid-slider/src/Module/Slider.php line 30

Open in your IDE?
  1. <?php
  2. /*
  3.  * Copyright MADE/YOUR/DAY OG <mail@madeyourday.net>
  4.  *
  5.  * For the full copyright and license information, please view the LICENSE
  6.  * file that was distributed with this source code.
  7.  */
  9. namespace MadeYourDay\RockSolidSlider\Module;
  11. use MadeYourDay\RockSolidSlider\Model\SlideModel;
  12. use MadeYourDay\RockSolidSlider\Model\SliderModel;
  13. use MadeYourDay\RockSolidSlider\Model\ContentModel;
  15. /**
  16.  * Slider Frontend Module
  17.  *
  18.  * @author Martin Auswöger <martin@madeyourday.net>
  19.  */
  20. class Slider extends \Module
  21. {
  22.     /**
  23.      * @var string Template
  24.      */
  25.     protected $strTemplate = 'rsts_default';
  27.     /**
  28.      * @return string
  29.      */
  30.     public function generate()
  31.     {
  32.         // Display a wildcard in the back end
  33.         if (TL_MODE === 'BE') {
  34.             $template = new \BackendTemplate('be_wildcard');
  36.             $template->wildcard = '### ROCKSOLID SLIDER ###';
  37.             $template->title = $this->name;
  38.             $template->id = $this->id;
  39.             $template->link = $this->name;
  40.             $template->href = 'contao/main.php?do=themes&amp;table=tl_module&amp;act=edit&amp;id=' . $this->id;
  42.             if ($this->objModel->rsts_id && ($slider = SliderModel::findByPk($this->objModel->rsts_id)) !== null) {
  43.                 $template->id = $slider->id;
  44.                 $template->link = $slider->name;
  45.                 $template->href = 'contao/main.php?do=rocksolid_slider&amp;table=tl_rocksolid_slide&amp;id=' . $slider->id;
  46.             }
  48.             return $template->parse();
  49.         }
  51.         if (
  52.             $this->rsts_import_settings
  53.             && $this->rsts_import_settings_from
  54.             && ($settingsModule = \ModuleModel::findByPk($this->rsts_import_settings_from))
  55.         ) {
  56.             $this->objModel->imgSize = $settingsModule->imgSize;
  57.             $this->objModel->fullsize = $settingsModule->fullsize;
  58.         }
  60.         if ($this->rsts_content_type === 'rsts_news') {
  61.             $newsModule = new SliderNews($this->objModel, $this->strColumn);
  62.             $this->newsArticles = $newsModule->getNewsArticles();
  63.             if (!count($this->newsArticles)) {
  64.                 // Return if there are no news articles
  65.                 return '';
  66.             }
  67.         }
  68.         else if ($this->rsts_content_type === 'rsts_events') {
  69.             $eventsModule = new SliderEvents($this->objModel, $this->strColumn);
  70.             $this->eventItems = $eventsModule->getEventItems();
  71.             if (!count($this->eventItems)) {
  72.                 // Return if there are no events
  73.                 return '';
  74.             }
  75.         }
  76.         else if ($this->rsts_content_type === 'rsts_settings') {
  77.             return '';
  78.         }
  79.         else if ($this->rsts_content_type === 'rsts_images' || !$this->rsts_id) {
  81.             $this->multiSRC = deserialize($this->multiSRC);
  82.             if (!is_array($this->multiSRC) || !count($this->multiSRC)) {
  83.                 // Return if there are no images
  84.                 return '';
  85.             }
  87.         }
  88.         else {
  90.             $this->slider = SliderModel::findByPk($this->rsts_id);
  92.             // Return if there is no slider
  93.             if (! $this->slider || $this->slider->id !== $this->rsts_id) {
  94.                 return '';
  95.             }
  97.             if ($this->slider->type === 'image') {
  98.                 $this->multiSRC = deserialize($this->slider->multiSRC);
  99.                 $this->orderSRC = $this->slider->orderSRC;
  100.             }
  102.         }
  104.         $this->files = \FilesModel::findMultipleByUuids($this->multiSRC);
  106.         if (
  107.             $this->rsts_import_settings
  108.             && $this->rsts_import_settings_from
  109.             && ($settingsModule = \ModuleModel::findByPk($this->rsts_import_settings_from))
  110.         ) {
  111.             $exclude = array('rsts_import_settings', 'rsts_import_settings_from', 'rsts_content_type', 'rsts_id');
  112.             $include = array('imgSize', 'fullsize');
  113.             foreach ($settingsModule->row() as $key => $value) {
  114.                 if (
  115.                     (substr($key, 0, 5) === 'rsts_' || in_array($key, $include))
  116.                     && !in_array($key, $exclude)
  117.                 ) {
  118.                     $this->arrData[$key] = $value;
  119.                 }
  120.             }
  121.             $settingsCssId = \StringUtil::deserialize($settingsModule->cssID, true);
  122.             if (!empty($settingsCssId[1])) {
  123.                 $this->arrData['cssID'][1] = (
  124.                     empty($this->arrData['cssID'][1]) ? '' : $this->arrData['cssID'][1] . ' '
  125.                 ) . $settingsCssId[1];
  126.             }
  127.         }
  129.         if ($this->rsts_template) {
  130.             $this->strTemplate = $this->rsts_template;
  131.         }
  133.         return parent::generate();
  134.     }
  136.     /**
  137.      * Generate the module
  138.      */
  139.     protected function compile()
  140.     {
  141.         global $objPage;
  143.         $images = array();
  145.         if ($this->files) {
  147.             $files = $this->files;
  148.             $filesExpaned = array();
  150.             // Get all images
  151.             while ($files->next()) {
  152.                 if ($files->type === 'file') {
  153.                     $filesExpaned[] = $files->current();
  154.                 }
  155.                 else {
  156.                     $subFiles = \FilesModel::findByPid($files->uuid);
  157.                     while ($subFiles && $subFiles->next()) {
  158.                         if ($subFiles->type === 'file'){
  159.                             $filesExpaned[] = $subFiles->current();
  160.                         }
  161.                     }
  162.                 }
  163.             }
  165.             foreach ($filesExpaned as $files) {
  167.                 // Continue if the files has been processed or does not exist
  168.                 if (isset($images[$files->path]) || ! file_exists(TL_ROOT . '/' . $files->path)) {
  169.                     continue;
  170.                 }
  172.                 $file = new \File($files->path, true);
  174.                 if (!$file->isGdImage && !$file->isImage) {
  175.                     continue;
  176.                 }
  178.                 $arrMeta = $this->getMetaData($files->meta, $objPage->language);
  180.                 // Add the image
  181.                 $images[$files->path] = array
  182.                 (
  183.                     'id'        => $files->id,
  184.                     'uuid'      => isset($files->uuid) ? $files->uuid : null,
  185.                     'name'      => $file->basename,
  186.                     'singleSRC' => $files->path,
  187.                     'alt'       => $arrMeta['alt'] ?? null,
  188.                     'title'     => $arrMeta['title'] ?? null,
  189.                     'imageUrl'  => $arrMeta['link'] ?? null,
  190.                     'caption'   => $arrMeta['caption'] ?? null,
  191.                     'fullsize'  => $this->fullsize,
  192.                 );
  194.             }
  196.             if ($this->orderSRC) {
  197.                 // Turn the order string into an array and remove all values
  198.                 $order = deserialize($this->orderSRC);
  199.                 if (!$order || !is_array($order)) {
  200.                     $order = array();
  201.                 }
  202.                 $order = array_flip($order);
  203.                 $order = array_map(function(){}, $order);
  205.                 // Move the matching elements to their position in $order
  206.                 foreach ($images as $k => $v) {
  207.                     if (array_key_exists($v['uuid'], $order)) {
  208.                         $order[$v['uuid']] = $v;
  209.                         unset($images[$k]);
  210.                     }
  211.                 }
  213.                 $order = array_merge($order, array_values($images));
  215.                 // Remove empty (unreplaced) entries
  216.                 $images = array_filter($order);
  217.                 unset($order);
  218.             }
  220.             $images = array_values($images);
  222.             foreach ($images as $key => $image) {
  223.                 $newImage = new \stdClass();
  224.                 $image['size'] = isset($this->imgSize) ? $this->imgSize : $this->size;
  225.                 $this->addImageToTemplate($newImage, $image, null, substr(md5('mod_rocksolid_slider_' . $this->id), 0, 6), \FilesModel::findByPk($image['id']));
  226.                 if ($this->rsts_navType === 'thumbs') {
  227.                     $newImage->thumb = new \stdClass;
  228.                     $image['size'] = $this->rsts_thumbs_imgSize;
  229.                     $this->addImageToTemplate($newImage->thumb, $image);
  230.                 }
  231.                 $images[$key] = $newImage;
  232.             }
  234.         }
  236.         // use custom skin if specified
  237.         if (trim($this->arrData['rsts_customSkin'])) {
  238.             $this->arrData['rsts_skin'] = trim($this->arrData['rsts_customSkin']);
  239.         }
  241.         $this->Template->images = $images;
  242.         $slides = array();
  243.         if (isset($this->newsArticles)) {
  244.             foreach ($this->newsArticles as $newsArticle) {
  245.                 $slides[] = array(
  246.                     'text' => $newsArticle,
  247.                 );
  248.             }
  249.         }
  250.         else if (isset($this->eventItems)) {
  251.             foreach ($this->eventItems as $eventItem) {
  252.                 $slides[] = array(
  253.                     'text' => $eventItem,
  254.                 );
  255.             }
  256.         }
  257.         else if (isset($this->slider->id) && $this->slider->type === 'content') {
  258.             $slides = $this->parseSlides(SlideModel::findPublishedByPid($this->slider->id));
  259.         }
  261.         $this->Template->slides = $slides;
  263.         $options = array();
  265.         // strings
  266.         foreach (array(
  267.             'type',
  268.             'direction',
  269.             'cssPrefix',
  270.             'skin',
  271.             'width',
  272.             'height',
  273.             'navType',
  274.             'scaleMode',
  275.             'imagePosition',
  276.             'deepLinkPrefix',
  277.             'thumbs_width',
  278.             'thumbs_height',
  279.             'thumbs_scaleMode',
  280.             'thumbs_imagePosition',
  281.         ) as $key) {
  282.             if (! empty($this->arrData['rsts_' . $key])) {
  283.                 $options[$key] = $this->arrData['rsts_' . $key];
  284.             }
  285.         }
  287.         // strings / boolean
  288.         foreach (array('centerContent') as $key) {
  289.             if (! empty($this->arrData['rsts_' . $key])) {
  290.                 $options[$key] = $this->arrData['rsts_' . $key];
  291.                 if ($options[$key] === 'false') {
  292.                     $options[$key] = false;
  293.                 }
  294.                 if ($options[$key] === 'true') {
  295.                     $options[$key] = true;
  296.                 }
  297.             }
  298.         }
  300.         // boolean
  301.         foreach (array(
  302.             'random',
  303.             'loop',
  304.             'videoAutoplay',
  305.             'autoplayProgress',
  306.             'pauseAutoplayOnHover',
  307.             'keyboard',
  308.             'captions',
  309.             'controls',
  310.             'thumbControls',
  311.             'combineNavItems',
  312.             'thumbs_controls',
  313.         ) as $key) {
  314.             $options[$key] = (bool) $this->arrData['rsts_' . $key];
  315.         }
  317.         // positive numbers
  318.         foreach (array(
  319.             'preloadSlides',
  320.             'duration',
  321.             'autoplay',
  322.             'autoplayRestart',
  323.             'slideMaxCount',
  324.             'slideMinSize',
  325.             'slideMaxSize',
  326.             'rowMaxCount',
  327.             'rowMinSize',
  328.             'prevNextSteps',
  329.             'visibleAreaMax',
  330.             'thumbs_duration',
  331.             'thumbs_slideMaxCount',
  332.             'thumbs_slideMinSize',
  333.             'thumbs_slideMaxSize',
  334.             'thumbs_rowMaxCount',
  335.             'thumbs_rowMinSize',
  336.             'thumbs_prevNextSteps',
  337.             'thumbs_visibleAreaMax',
  338.         ) as $key) {
  339.             if (! empty($this->arrData['rsts_' . $key]) && $this->arrData['rsts_' . $key] > 0) {
  340.                 $options[$key] = $this->arrData['rsts_' . $key] * 1;
  341.             }
  342.         }
  344.         // percentages
  345.         foreach (array('visibleArea', 'thumbs_visibleArea') as $key) {
  346.             if (!empty($this->arrData['rsts_' . $key])) {
  347.                 $options[$key] = $this->arrData['rsts_' . $key] / 100;
  348.             }
  349.         }
  351.         // percentages including zero
  352.         foreach (array('visibleAreaAlign') as $key) {
  353.             if (!empty($this->arrData['rsts_' . $key])) {
  354.                 $options[$key] = $this->arrData['rsts_' . $key] / 100;
  355.             }
  356.             else {
  357.                 $options[$key] = 0;
  358.             }
  359.         }
  361.         // ratios
  362.         foreach (array('rowSlideRatio', 'thumbs_rowSlideRatio') as $key) {
  363.             if (!empty($this->arrData['rsts_' . $key])) {
  364.                 $ratio = explode('x', $this->arrData['rsts_' . $key], 2);
  365.                 if (empty($ratio[1])) {
  366.                     $ratio = floatval($ratio[0]);
  367.                 }
  368.                 else {
  369.                     $ratio = floatval($ratio[1]) / floatval($ratio[0]);
  370.                 }
  371.                 $options[$key] = $ratio;
  372.             }
  373.         }
  375.         // gap size
  376.         foreach (array('gapSize', 'thumbs_gapSize') as $key) {
  377.             if (isset($this->arrData['rsts_' . $key]) && $this->arrData['rsts_' . $key] !== '') {
  378.                 if (substr($this->arrData['rsts_' . $key], -1) === '%') {
  379.                     $options[$key] = $this->arrData['rsts_' . $key];
  380.                 }
  381.                 else {
  382.                     $options[$key] = $this->arrData['rsts_' . $key] * 1;
  383.                 }
  384.             }
  385.         }
  387.         foreach ($options as $key => $value) {
  388.             if (substr($key, 0, 7) === 'thumbs_') {
  389.                 $options['thumbs'][substr($key, 7)] = $value;
  390.                 unset($options[$key]);
  391.             }
  392.         }
  394.         if (empty($this->arrData['rsts_thumbs']) && isset($options['thumbs'])) {
  395.             unset($options['thumbs']);
  396.         }
  398.         $this->Template->options = $options;
  400.         $assetsDir = 'bundles/rocksolidslider';
  402.         $GLOBALS['TL_JAVASCRIPT'][] = $assetsDir . '/js/rocksolid-slider.min.js|static';
  403.         $GLOBALS['TL_CSS'][] = $assetsDir . '/css/rocksolid-slider.min.css||static';
  404.         $skinPath = $assetsDir . '/css/' . (empty($this->arrData['rsts_skin']) ? 'default' : $this->arrData['rsts_skin']) . '-skin.min.css';
  405.         if (file_exists(\System::getContainer()->getParameter('contao.web_dir') . '/' . $skinPath)) {
  406.             $GLOBALS['TL_CSS'][] = $skinPath . '||static';
  407.         }
  408.     }
  410.     /**
  411.      * Parse slides
  412.      *
  413.      * @param  \Model\Collection $objSlides slides retrieved from the database
  414.      * @return array                        parsed slides
  415.      */
  416.     protected function parseSlides($objSlides)
  417.     {
  418.         global $objPage;
  420.         $slides = array();
  421.         $pids = array();
  422.         $idIndexes = array();
  424.         if (! $objSlides) {
  425.             return $slides;
  426.         }
  428.         while ($objSlides->next()) {
  430.             $slide = $objSlides->row();
  431.             $slide['text'] = '';
  432.             if ($slide['type'] === 'content') {
  433.                 $pids[] = $slide['id'];
  434.                 $idIndexes[(int)$slide['id']] = count($slides);
  435.             }
  437.             if (
  438.                 in_array($slide['type'], array('image', 'video')) &&
  439.                 trim($slide['singleSRC']) &&
  440.                 ($file = \FilesModel::findByUuid($slide['singleSRC'])) &&
  441.                 ($fileObject = new \File($file->path, true)) &&
  442.                 ($fileObject->isGdImage || $fileObject->isImage)
  443.             ) {
  444.                 $meta = $this->getMetaData($file->meta, $objPage->language);
  445.                 $slide['image'] = new \stdClass;
  446.                 $this->addImageToTemplate($slide['image'], array(
  447.                     'id' => $file->id,
  448.                     'name' => $fileObject->basename,
  449.                     'singleSRC' => $file->path,
  450.                     'alt' => $meta['alt'] ?? null,
  451.                     'title' => $meta['title'] ?? null,
  452.                     'imageUrl' => $meta['link'] ?? null,
  453.                     'caption' => $meta['caption'] ?? null,
  454.                     'size' => isset($this->imgSize) ? $this->imgSize : $this->size,
  455.                     'fullsize' => $this->fullsize,
  456.                 ), null, substr(md5('mod_rocksolid_slider_' . $this->id), 0, 6), $file);
  457.             }
  459.             if ($slide['type'] === 'video' && $slide['videoURL'] && empty($slide['image'])) {
  460.                 $slide['image'] = new \stdClass;
  461.                 if (preg_match(
  462.                     '(^
  463.                         https?://  # http or https
  464.                         (?:
  465.                             www\\.youtube\\.com/(?:watch\\?v=|v/|embed/)  # Different URL formats
  466.                             | youtu\\.be/  # Short YouTube domain
  467.                         )
  468.                         ([0-9a-z_\\-]{11})  # YouTube ID
  469.                         (?:$|&|/)  # End or separator
  470.                     )ix',
  471.                     html_entity_decode($slide['videoURL']), $matches)
  472.                 ) {
  473.                     $video = $matches[1];
  474.                     $slide['image']->src = '//img.youtube.com/vi/' . $video . '/0.jpg';
  475.                 }
  476.                 else {
  477.                     // Grey dummy image
  478.                     $slide['image']->src = 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAJCAMAAAAM9FwAAAAAA1BMVEXGxsbd/8BlAAAAFUlEQVR42s3BAQEAAACAkP6vdiO6AgCZAAG/wrlvAAAAAElFTkSuQmCC';
  479.                 }
  480.                 $slide['image']->imgSize = '';
  481.                 $slide['image']->alt = '';
  482.                 $slide['image']->title = '';
  483.                 $slide['image']->picture = array(
  484.                     'img' => array('src' => $slide['image']->src, 'srcset' => $slide['image']->src),
  485.                     'sources' => array(),
  486.                 );
  487.             }
  489.             if ($slide['type'] !== 'video' && $slide['videoURL']) {
  490.                 $slide['videoURL'] = '';
  491.             }
  493.             if ($slide['type'] === 'video' && $slide['videos']) {
  494.                 $videoFiles = deserialize($slide['videos'], true);
  495.                 $videoFiles = \FilesModel::findMultipleByUuids($videoFiles);
  496.                 $videos = array();
  497.                 foreach ($videoFiles as $file) {
  498.                     $videos[] = $file;
  499.                 }
  500.                 $slide['videos'] = $videos;
  501.             }
  502.             else {
  503.                 $slide['videos'] = null;
  504.             }
  506.             if (
  507.                 trim($slide['backgroundImage']) &&
  508.                 ($file = \FilesModel::findByUuid($slide['backgroundImage'])) &&
  509.                 ($fileObject = new \File($file->path, true)) &&
  510.                 ($fileObject->isGdImage || $fileObject->isImage)
  511.             ) {
  512.                 $meta = $this->getMetaData($file->meta, $objPage->language);
  513.                 $slide['backgroundImage'] = new \stdClass;
  514.                 $this->addImageToTemplate($slide['backgroundImage'], array(
  515.                     'id' => $file->id,
  516.                     'name' => $fileObject->basename,
  517.                     'singleSRC' => $file->path,
  518.                     'alt' => $meta['alt'] ?? null,
  519.                     'title' => $meta['title'] ?? null,
  520.                     'imageUrl' => $meta['link'] ?? null,
  521.                     'caption' => $meta['caption'] ?? null,
  522.                     'size' => $slide['backgroundImageSize'] ?? null,
  523.                 ));
  524.             }
  525.             else {
  526.                 $slide['backgroundImage'] = null;
  527.             }
  529.             if ($slide['backgroundVideos']) {
  530.                 $videoFiles = deserialize($slide['backgroundVideos'], true);
  531.                 $videoFiles = \FilesModel::findMultipleByUuids($videoFiles);
  532.                 $videos = array();
  533.                 foreach ($videoFiles as $file) {
  534.                     $videos[] = $file;
  535.                 }
  536.                 $slide['backgroundVideos'] = $videos;
  537.             }
  539.             if ($this->rsts_navType === 'thumbs') {
  540.                 $slide['thumb'] = new \stdClass;
  541.                 if (
  542.                     trim($slide['thumbImage']) &&
  543.                     ($file = \FilesModel::findByUuid($slide['thumbImage'])) &&
  544.                     ($fileObject = new \File($file->path, true)) &&
  545.                     ($fileObject->isGdImage || $fileObject->isImage)
  546.                 ) {
  547.                     $this->addImageToTemplate($slide['thumb'], array(
  548.                         'id' => $file->id,
  549.                         'name' => $fileObject->basename,
  550.                         'singleSRC' => $file->path,
  551.                         'size' => $this->rsts_thumbs_imgSize,
  552.                     ));
  553.                 }
  554.                 elseif (
  555.                     in_array($slide['type'], array('image', 'video')) &&
  556.                     trim($slide['singleSRC']) &&
  557.                     ($file = \FilesModel::findByUuid($slide['singleSRC'])) &&
  558.                     ($fileObject = new \File($file->path, true)) &&
  559.                     ($fileObject->isGdImage || $fileObject->isImage)
  560.                 ) {
  561.                     $this->addImageToTemplate($slide['thumb'], array(
  562.                         'id' => $file->id,
  563.                         'name' => $fileObject->basename,
  564.                         'singleSRC' => $file->path,
  565.                         'size' => $this->rsts_thumbs_imgSize,
  566.                     ));
  567.                 }
  568.                 elseif (!empty($slide['image']->src)) {
  569.                     $slide['thumb'] = clone $slide['image'];
  570.                 }
  571.                 elseif (!empty($slide['backgroundImage']->src)) {
  572.                     $slide['thumb'] = clone $slide['backgroundImage'];
  573.                 }
  574.             }
  576.             $slides[] = $slide;
  578.         }
  580.         if (count($pids)) {
  581.             $slideContents = ContentModel::findPublishedByPidsAndTable($pids, SlideModel::getTable());
  582.             if ($slideContents) {
  583.                 while ($slideContents->next()) {
  584.                     $slides[$idIndexes[(int)$slideContents->pid]]['text'] .= $this->getContentElement($slideContents->current());
  585.                 }
  586.             }
  587.         }
  589.         return $slides;
  590.     }
  591. }