vendor/bugbuster/contao-banner-bundle/src/Resources/contao/classes/BannerSingle.php line 341

Open in your IDE?
  1. <?php
  2. /**
  3.  * Extension for Contao Open Source CMS, Copyright (C) 2005-2022 Leo Feyer
  4.  *
  5.  * BannerSingle - Frontend Helper Class
  6.  *
  7.  * @copyright  Glen Langer 2022 <http://contao.ninja>
  8.  * @author     Glen Langer (BugBuster)
  9.  * @licence    LGPL
  10.  * @filesource
  11.  * @see           https://github.com/BugBuster1701/contao-banner-bundle
  12.  */
  14. namespace BugBuster\Banner;
  16. use BugBuster\Banner\BannerCount;
  17. use BugBuster\Banner\BannerExternal;
  18. use BugBuster\Banner\BannerImage;
  19. use BugBuster\Banner\BannerInternal;
  20. use BugBuster\Banner\BannerLog;
  21. use BugBuster\Banner\BannerLogic;
  22. use BugBuster\Banner\BannerText;
  23. use Contao\FrontendTemplate;
  25. /**
  26.  * Class BannerSingle
  27.  *
  28.  * @copyright  Glen Langer 2022 <http://contao.ninja>
  29.  * @author     Glen Langer (BugBuster)
  30.  * @license    LGPL
  31.  */
  32. class BannerSingle extends \Contao\Frontend
  33. {
  34.     /**
  35.      * Banner intern
  36.      * @var string
  37.      */
  38.     public const BANNER_TYPE_INTERN = 'banner_image';
  40.     /**
  41.      * Banner extern
  42.      * @var string
  43.      */
  44.     public const BANNER_TYPE_EXTERN = 'banner_image_extern';
  46.     /**
  47.      * Banner text
  48.      * @var string
  49.      */
  50.     public const BANNER_TYPE_TEXT   = 'banner_text';
  52.     protected $arrCategoryValues = [];
  53.     protected $BannerImage;
  54.     protected $banner_template;
  55.     protected $strTemplate;
  56.     protected $Template;
  57.     protected $arrAllBannersBasic;
  59.     public function __construct($arrCategoryValues, $banner_template, $strTemplate, $objTemplate, $arrAllBannersBasic)
  60.     {
  61.         $this->arrCategoryValues  = $arrCategoryValues;
  62.         $this->banner_template    = $banner_template;
  63.         $this->strTemplate        = $strTemplate;
  64.         $this->Template           = $objTemplate;
  65.         $this->arrAllBannersBasic = $arrAllBannersBasic;
  67.         // Static URLs Controller::setStaticUrls
  68.         $this->setStaticUrls();
  69.     }
  71.     /**
  72.      * Get default banner or empty banner in $this->Template->banners
  73.      *
  74.      * @return $this->strTemplate
  75.      */
  76.     public function getDefaultBanner($banner_hideempty, $module_id)
  77.     {
  78.         $arrImageSize = [];
  79.         //CSS-ID/Klasse(n) je Banner, für den wrapper
  80.         $banner_cssID   = '';
  81.         $banner_class   = ' banner_default';
  83.         //BannerDefault gewünscht und vorhanden?
  84.         if ($this->arrCategoryValues['banner_default'] == '1'
  85.             && \strlen($this->arrCategoryValues['banner_default_image']) > 0
  86.         ) {
  87.             //Template setzen
  88.             if (($this->banner_template != $this->strTemplate)
  89.               && ($this->banner_template != '')) {
  90.                 $this->strTemplate = $this->banner_template;
  91.                 $this->Template = new FrontendTemplate($this->strTemplate);
  92.             }
  94.             $banner_default_target = ($this->arrCategoryValues['banner_default_target'] == '1') ? '' : ' target="_blank"';
  96.             //BannerImage Class
  97.             $this->BannerImage = new BannerImage();
  99.             //Banner Art bestimmen
  100.             $arrImageSize = $this->BannerImage->getBannerImageSize($this->arrCategoryValues['banner_default_image'], self::BANNER_TYPE_INTERN);
  101.             // 1 = GIF, 2 = JPG/JPEG, 3 = PNG
  102.             // 4 = SWF, 13 = SWC (zip-like swf file)
  103.             // 5 = PSD, 6 = BMP, 7 = TIFF(intel byte order), 8 = TIFF(motorola byte order)
  104.             // 9 = JPC, 10 = JP2, 11 = JPX, 12 = JB2, 13 = SWC, 14 = IFF
  105.             // 18 = WEBP
  107.             //fake the Picture::create
  108.             $picture['img']   =
  109.             [
  110.                 'src'    => $this->urlEncode($this->arrCategoryValues['banner_default_image']),
  111.                 'width'  => $arrImageSize[0],
  112.                 'height' => $arrImageSize[1],
  113.                 'srcset' => $this->urlEncode($this->arrCategoryValues['banner_default_image'])
  114.             ];
  115.             $picture['alt']   = \Contao\StringUtil::specialchars(\Contao\StringUtil::ampersand($this->arrCategoryValues['banner_default_name']));
  116.             $picture['title'] = '';
  118.             BannerLog::writeLog(__METHOD__, __LINE__, 'Fake Picture: '. print_r($picture, true));
  120.             switch ($arrImageSize[2]) {
  121.                 case 1:// GIF
  122.                 case 2:// JPG
  123.                 case 3:// PNG
  124.                 case 18: // WEBP
  125.                     $arrBanners[] =
  126.                                     [
  127.                                     'banner_key'     => 'defbid',
  128.                                     'banner_wrap_id'    => $banner_cssID,
  129.                                     'banner_wrap_class' => $banner_class,
  130.                                     'banner_id'      => $this->arrCategoryValues['id'],
  131.                                     'banner_name'    => \Contao\StringUtil::specialchars(\Contao\StringUtil::ampersand($this->arrCategoryValues['banner_default_name'])),
  132.                                     'banner_url'     => $this->arrCategoryValues['banner_default_url'],
  133.                                     'banner_target'  => $banner_default_target,
  134.                                     'banner_comment' => \Contao\StringUtil::specialchars(\Contao\StringUtil::ampersand($this->arrCategoryValues['banner_default_name'])),
  135.                                     'src'            => $this->urlEncode($this->arrCategoryValues['banner_default_image']),
  136.                                     'alt'            => \Contao\StringUtil::specialchars(\Contao\StringUtil::ampersand($this->arrCategoryValues['banner_default_name'])),
  137.                                     'size'              => '',
  138.                                     'banner_pic'     => true,
  139.                                     'banner_flash'   => false,
  140.                                     'banner_text'    => false,
  141.                                     'banner_video'   => false,
  142.                                     'banner_empty'   => false,    // issues 733
  143.                                     'picture'        => $picture
  144.                                     ];
  145.                     break;
  146.             }
  147.             $arrResults[] = $arrBanners[0];
  148.             $this->Template->banners = $arrResults;
  149.             $this->Template->bmid = "bmid".$module_id;
  151.             return $this->Template;
  152.         }
  153.         //Kein BannerDefault
  154.         $NoBannerFound = ($GLOBALS['TL_LANG']['MSC']['tl_banner']['noBanner']) ? $GLOBALS['TL_LANG']['MSC']['tl_banner']['noBanner'] : 'no banner, no default banner';
  155.         $arrBanners[] =
  156.                         [
  157.                             'banner_key'  => 'bid',
  158.                             'banner_wrap_id'    => $banner_cssID,
  159.                             'banner_wrap_class' => $banner_class,
  160.                             'banner_id'   => 0,
  161.                             'banner_name' => \Contao\StringUtil::specialchars(\Contao\StringUtil::ampersand($NoBannerFound)),
  162.                             'banner_url'  => '',
  163.                             'banner_target'  => '',
  164.                             'banner_comment' => '',
  165.                             'src'             => '',
  166.                             'alt'             => '',
  167.                             'size'             => '',
  168.                             'banner_pic'     => false,
  169.                             'banner_flash'  => false,
  170.                             'banner_text'   => false,
  171.                             'banner_video'  => false,
  172.                             'banner_empty'  => true    // issues 733
  173.                         ];
  174.         $arrResults[] = $arrBanners[0];
  175.         //Ausblenden wenn leer?
  176.         if ($banner_hideempty == 1) {
  177.             // auf Leer umschalten
  178.             $this->strTemplate='mod_banner_empty';
  179.             $this->Template->arrCategoryValues = $this->arrCategoryValues; // #7 / #176 (Banner)
  180.             $this->Template = new FrontendTemplate($this->strTemplate);
  181.             BannerLog::writeLog(__METHOD__, __LINE__, 'Kein BannerDefault, umschalten auf leeres Template');
  182.         }
  183.         $this->Template->banners = $arrResults;
  184.         $this->Template->bmid = "bmid".$module_id;
  186.         return $this->Template;
  187.     }
  189.     /**
  190.      * Get First View Banner
  191.      *
  192.      * @return internal Value in $this->strTemplate
  193.      */
  194.     public function getSingleBannerFirst($module_id)
  195.     {
  196.         $arrBanners = [];
  197.         $arrResults = [];
  198.         $FileSrc = '';
  200.         //first aktiv banner in category
  201.         //$this->arrAllBannersBasic den ersten Datensatz über die ID nutzen
  202.         //seltsamerweise kommt reference Fehler bei Kombination in einer Anweisung, daher getrennt
  203.         $banner_keys = array_keys($this->arrAllBannersBasic);
  204.         $banner_id   = array_shift($banner_keys);
  205.         $objBanners  = \Contao\Database::getInstance()
  206.                             ->prepare(
  207.                                 "SELECT
  208.                                             TLB.*
  209.                                        FROM
  210.                                             tl_banner AS TLB
  211.                                        WHERE
  212.                                             TLB.`id`=?"
  213.                             )
  214.                             ->limit(1)
  215.                             ->execute($banner_id);
  216.         $intRows = $objBanners->numRows;
  217.         //Banner vorhanden?
  218.         if ($intRows > 0) {
  219.             $objBanners->next();
  220.             BannerHelper::$arrBannerSeen[] = $objBanners->id;
  221.             //CSS-ID/Klasse(n) je Banner, für den wrapper
  222.             $banner_cssID   = '';
  223.             $banner_class   = '';
  224.             $banner_classes = '';
  225.             $_cssID = \Contao\StringUtil::deserialize($objBanners->banner_cssid);
  226.             if (\is_array($_cssID)) {
  227.                 if ($_cssID[0] != '') {
  228.                     $banner_cssID   = ' id="banner_'.$_cssID[0].'"';
  229.                 }
  230.                 if ($_cssID[1] != '') {
  231.                     $banner_classes = explode(" ", $_cssID[1]);
  232.                     foreach ($banner_classes as $banner_classone) {
  233.                         $banner_class .= ' banner_'.$banner_classone;
  234.                     }
  235.                 }
  236.             }
  238.             switch ($objBanners->banner_type) {
  239.                 case self::BANNER_TYPE_INTERN:
  240.                     $objBannerInternal = new BannerInternal($objBanners, $banner_cssID, $banner_class);
  241.                     $objImageData = $objBannerInternal->generateImageData();
  243.                     $FileSrc = $objImageData->FileSrc;
  244.                     $picture = $objImageData->Picture;
  245.                     $arrImageSize = $objImageData->ImageSize;
  247.                     $arrBanners = $objBannerInternal->generateTemplateData($arrImageSize, $FileSrc, $picture);
  249.                     //anderes Template?
  250.                     if (($this->banner_template != $this->strTemplate)
  251.                         && ($this->banner_template != '')
  252.                     ) {
  253.                         $this->strTemplate = $this->banner_template;
  254.                         $this->Template = new FrontendTemplate($this->strTemplate);
  255.                     }
  256.                     $this->setStatViewUpdate($arrBanners, $module_id, $objBanners->banner_useragent);
  257.                     $this->Template->banners = $arrBanners;
  258.                     $this->Template->bmid = "bmid".$module_id;
  260.                     return $this->Template;
  262.                     break;
  263.                 case self::BANNER_TYPE_EXTERN:
  264.                     $objBannerExternal = new BannerExternal($objBanners, $banner_cssID, $banner_class);
  265.                     $objImageData = $objBannerExternal->generateImageData();
  267.                     $FileSrc = $objImageData->FileSrc;
  268.                     $picture = $objImageData->Picture;
  269.                     $arrImageSize = $objImageData->ImageSize;
  271.                     $arrBanners = $objBannerExternal->generateTemplateData($arrImageSize, $FileSrc, $picture);
  273.                     //anderes Template?
  274.                     if (($this->banner_template != $this->strTemplate)
  275.                         && ($this->banner_template != '')
  276.                     ) {
  277.                         $this->strTemplate = $this->banner_template;
  278.                         $this->Template = new FrontendTemplate($this->strTemplate);
  279.                     }
  280.                     $this->setStatViewUpdate($arrBanners, $module_id, $objBanners->banner_useragent);
  281.                     $this->Template->banners = $arrBanners;
  282.                     $this->Template->bmid = "bmid".$module_id;
  284.                     return $this->Template;
  286.                     break;
  287.                 case self::BANNER_TYPE_TEXT:
  288.                     $arrImageSize = false;
  289.                     break;
  290.             }
  292.             // Text Banner
  293.             if ($objBanners->banner_type == 'banner_text') {
  294.                 $objBannerText = new BannerText($objBanners, $banner_cssID, $banner_class);
  295.                 $arrBanners = $objBannerText->generateTemplateData();
  297.                 //anderes Template?
  298.                 if (($this->banner_template != $this->strTemplate)
  299.                  && ($this->banner_template != '')
  300.                 ) {
  301.                     $this->strTemplate = $this->banner_template;
  302.                     $this->Template = new FrontendTemplate($this->strTemplate);
  303.                 }
  304.                 $arrResults[] = $arrBanners[0];
  305.                 $this->Template->banners = $arrResults;
  306.                 $this->Template->bmid = "bmid".$module_id;
  308.                 $this->setStatViewUpdate($arrResults, $module_id, $objBanners->banner_useragent);
  310.                 return $this->Template;
  311.             }
  313.             // Video Banner
  314.             if ($objBanners->banner_type === BannerVideo::BANNER_TYPE_VIDEO) {
  315.                 $objBannerVideo = new BannerVideo($objBanners, $banner_cssID, $banner_class);
  316.                 $arrBanners = $objBannerVideo->generateTemplateData();
  318.                 //anderes Template?
  319.                 if (($this->banner_template != $this->strTemplate)
  320.                     && ($this->banner_template != '')
  321.                 ) {
  322.                     $this->strTemplate = $this->banner_template;
  323.                     $this->Template = new FrontendTemplate($this->strTemplate);
  324.                 }
  325.                 $arrResults[] = $arrBanners[0];
  326.                 $this->Template->banners = $arrResults;
  327.                 $this->Template->bmid = "bmid".$module_id;
  329.                 $this->setStatViewUpdate($arrResults, $module_id, $objBanners->banner_useragent);
  331.                 return $this->Template;
  332.             }
  333.         }//Banner vorhanden
  334.         //falls $arrImageSize = false  und kein Text Banner
  335.         $this->Template->banners = $arrBanners; // leeres array
  336.         $this->Template->bmid = "bmid".$module_id;
  338.         return $this->Template;
  339.     }
  341.     public function getSingleBanner($module_id)
  342.     {
  343.         $objBannerLogic = new BannerLogic();
  345.         //RandomBlocker entfernen falls möglich und nötig
  346.         if (\count($this->arrAllBannersBasic) >1) { // einer muss ja übrig bleiben
  347.             $intRandomBlockerID = $objBannerLogic->getRandomBlockerId($module_id);
  348.             if (isset($this->arrAllBannersBasic[$intRandomBlockerID])) {
  349.                 unset($this->arrAllBannersBasic[$intRandomBlockerID]);
  350.             }
  351.         }
  353.         //Gewichtung nach vorhandenen Wichtungen
  354.         $SingleBannerWeighting = $objBannerLogic->getSingleWeighting($this->arrAllBannersBasic);
  356.         //alle Basic Daten durchgehen und die löschen die nicht der Wichtung entsprechen
  357.         foreach ($this->arrAllBannersBasic as $key => $val) {
  358.             if ($val != $SingleBannerWeighting) {
  359.                 unset($this->arrAllBannersBasic[$key]);
  360.             }
  361.         }
  362.         reset($this->arrAllBannersBasic); //sicher ist sicher
  364.         //Zufallszahl
  365.         //array_shuffle und array_rand zu "ungenau"
  366.         $intShowBanner =  mt_rand(1, \count($this->arrAllBannersBasic));
  367.         $banner_keys = array_keys($this->arrAllBannersBasic);
  368.         for ($xx=1;$xx<=$intShowBanner;$xx++) {
  369.             $banner_id   = array_shift($banner_keys);
  370.         }
  372.         //Random Blocker setzen
  373.         $objBannerLogic->setRandomBlockerId($banner_id, $module_id);
  375.         $objBanners  = \Contao\Database::getInstance()
  376.                             ->prepare(
  377.                                 "SELECT
  378.                                             TLB.*
  379.                                        FROM
  380.                                             tl_banner AS TLB
  381.                                        WHERE
  382.                                             TLB.`id`=?"
  383.                             )
  384.                             ->limit(1)
  385.                             ->execute($banner_id);
  386.         $intRows = $objBanners->numRows;
  387.         //Banner vorhanden?
  388.         if ($intRows > 0) {
  389.             $objBanners->next();
  390.             BannerHelper::$arrBannerSeen[] = $objBanners->id;
  391.             //CSS-ID/Klasse(n) je Banner, für den wrapper
  392.             $banner_cssID   = '';
  393.             $banner_class   = '';
  394.             $banner_classes = '';
  395.             $_cssID = \Contao\StringUtil::deserialize($objBanners->banner_cssid);
  396.             if (\is_array($_cssID)) {
  397.                 if ($_cssID[0] != '') {
  398.                     $banner_cssID   = ' id="banner_'.$_cssID[0].'"';
  399.                 }
  400.                 if ($_cssID[1] != '') {
  401.                     $banner_classes = explode(" ", $_cssID[1]);
  402.                     foreach ($banner_classes as $banner_classone) {
  403.                         $banner_class .= ' banner_'.$banner_classone;
  404.                     }
  405.                 }
  406.             }
  408.             switch ($objBanners->banner_type) {
  409.                 case self::BANNER_TYPE_INTERN:
  410.                     $objBannerInternal = new BannerInternal($objBanners, $banner_cssID, $banner_class);
  411.                     $objImageData = $objBannerInternal->generateImageData();
  413.                     $FileSrc = $objImageData->FileSrc;
  414.                     $picture = $objImageData->Picture;
  415.                     $arrImageSize = $objImageData->ImageSize;
  417.                     $arrBanners = $objBannerInternal->generateTemplateData($arrImageSize, $FileSrc, $picture);
  419.                     //anderes Template?
  420.                     if (($this->banner_template != $this->strTemplate)
  421.                         && ($this->banner_template != '')
  422.                     ) {
  423.                         $this->strTemplate = $this->banner_template;
  424.                         $this->Template = new FrontendTemplate($this->strTemplate);
  425.                     }
  426.                     $this->setStatViewUpdate($arrBanners, $module_id, $objBanners->banner_useragent);
  427.                     $this->Template->banners = $arrBanners;
  428.                     $this->Template->bmid = "bmid".$module_id;
  430.                     return $this->Template;
  432.                     break;
  433.                 case self::BANNER_TYPE_EXTERN:
  434.                     $objBannerExternal = new BannerExternal($objBanners, $banner_cssID, $banner_class);
  435.                     $objImageData = $objBannerExternal->generateImageData();
  437.                     $FileSrc = $objImageData->FileSrc;
  438.                     $picture = $objImageData->Picture;
  439.                     $arrImageSize = $objImageData->ImageSize;
  441.                     $arrBanners = $objBannerExternal->generateTemplateData($arrImageSize, $FileSrc, $picture);
  443.                     //anderes Template?
  444.                     if (($this->banner_template != $this->strTemplate)
  445.                         && ($this->banner_template != '')
  446.                     ) {
  447.                         $this->strTemplate = $this->banner_template;
  448.                         $this->Template = new FrontendTemplate($this->strTemplate);
  449.                     }
  450.                     $this->setStatViewUpdate($arrBanners, $module_id, $objBanners->banner_useragent);
  451.                     $this->Template->banners = $arrBanners;
  452.                     $this->Template->bmid = "bmid".$module_id;
  454.                     return $this->Template;
  455.                     break;
  456.                 case self::BANNER_TYPE_TEXT:
  457.                     $arrImageSize = false;
  458.                     break;
  459.             }
  461.             // Text Banner
  462.             if ($objBanners->banner_type == 'banner_text') {
  463.                 $objBannerText = new BannerText($objBanners, $banner_cssID, $banner_class);
  464.                 $arrBanners = $objBannerText->generateTemplateData();
  466.                 //anderes Template?
  467.                 if (($this->banner_template != $this->strTemplate)
  468.                  && ($this->banner_template != '')
  469.                 ) {
  470.                     $this->strTemplate = $this->banner_template;
  471.                     $this->Template = new FrontendTemplate($this->strTemplate);
  472.                 }
  473.                 $arrResults[] = $arrBanners[0];
  474.                 $this->Template->banners = $arrResults;
  475.                 $this->Template->bmid = "bmid".$module_id;
  477.                 $this->setStatViewUpdate($arrResults, $module_id, $objBanners->banner_useragent);
  479.                 return $this->Template;
  480.             }
  482.             // Video Banner
  483.             if ($objBanners->banner_type === BannerVideo::BANNER_TYPE_VIDEO) {
  484.                 $objBannerVideo = new BannerVideo($objBanners, $banner_cssID, $banner_class);
  485.                 $arrBanners = $objBannerVideo->generateTemplateData();
  487.                 //anderes Template?
  488.                 if (($this->banner_template != $this->strTemplate)
  489.                     && ($this->banner_template != '')
  490.                 ) {
  491.                     $this->strTemplate = $this->banner_template;
  492.                     $this->Template = new FrontendTemplate($this->strTemplate);
  493.                 }
  494.                 $arrResults[] = $arrBanners[0];
  495.                 $this->Template->banners = $arrResults;
  496.                 $this->Template->bmid = "bmid".$module_id;
  498.                 $this->setStatViewUpdate($arrResults, $module_id, $objBanners->banner_useragent);
  500.                 return $this->Template;
  501.             }
  502.         }//Banner vorhanden
  503.         //falls $arrImageSize = false  und kein Text Banner
  504.         $this->Template->banners = []; // leeres array
  505.         $this->Template->bmid = "bmid".$module_id;
  507.         return $this->Template;
  508.     }
  510.     protected function setStatViewUpdate($arrBannerData, $module_id, $banner_useragent)
  511.     {
  512.         $objBannerCount = new BannerCount($arrBannerData, $banner_useragent, $module_id);
  513.         $objBannerCount->setStatViewUpdate();
  514.         unset($objBannerCount);
  515.     }
  516. }