vendor/contao/calendar-bundle/src/Resources/contao/modules/ModuleEventlist.php line 48

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\CoreBundle\Exception\PageNotFoundException;
  15. /**
  16.  * Front end module "event list".
  17.  *
  18.  * @property bool   $cal_noSpan
  19.  * @property string $cal_template
  20.  * @property int    $cal_limit
  21.  * @property string $cal_order
  22.  * @property array  $cal_calendar
  23.  * @property string $cal_format
  24.  * @property bool   $cal_ignoreDynamic
  25.  * @property int    $cal_readerModule
  26.  * @property bool   $cal_hideRunning
  27.  * @property string $cal_featured
  28.  */
  29. class ModuleEventlist extends Events
  30. {
  31.     /**
  32.      * Current date object
  33.      * @var Date
  34.      */
  35.     protected $Date;
  37.     /**
  38.      * Template
  39.      * @var string
  40.      */
  41.     protected $strTemplate = 'mod_eventlist';
  43.     /**
  44.      * Display a wildcard in the back end
  45.      *
  46.      * @return string
  47.      */
  48.     public function generate()
  49.     {
  50.         $request = System::getContainer()->get('request_stack')->getCurrentRequest();
  52.         if ($request && System::getContainer()->get('contao.routing.scope_matcher')->isBackendRequest($request))
  53.         {
  54.             $objTemplate = new BackendTemplate('be_wildcard');
  55.             $objTemplate->wildcard = '### ' . $GLOBALS['TL_LANG']['FMD']['eventlist'][0] . ' ###';
  56.             $objTemplate->title = $this->headline;
  57.             $objTemplate->id = $this->id;
  58.             $objTemplate->link = $this->name;
  59.             $objTemplate->href = StringUtil::specialcharsUrl(System::getContainer()->get('router')->generate('contao_backend', array('do'=>'themes', 'table'=>'tl_module', 'act'=>'edit', 'id'=>$this->id)));
  61.             return $objTemplate->parse();
  62.         }
  64.         $this->cal_calendar = $this->sortOutProtected(StringUtil::deserialize($this->cal_calendar, true));
  66.         // Return if there are no calendars
  67.         if (empty($this->cal_calendar) || !\is_array($this->cal_calendar))
  68.         {
  69.             return '';
  70.         }
  72.         // Show the event reader if an item has been selected
  73.         if ($this->cal_readerModule > 0  && (isset($_GET['events']) || (Config::get('useAutoItem') && isset($_GET['auto_item']))))
  74.         {
  75.             return $this->getFrontendModule($this->cal_readerModule, $this->strColumn);
  76.         }
  78.         // Tag the calendars (see #2137)
  79.         if (System::getContainer()->has('fos_http_cache.http.symfony_response_tagger'))
  80.         {
  81.             $responseTagger = System::getContainer()->get('fos_http_cache.http.symfony_response_tagger');
  82.             $responseTagger->addTags(array_map(static function ($id) { return 'contao.db.tl_calendar.' . $id; }, $this->cal_calendar));
  83.         }
  85.         return parent::generate();
  86.     }
  88.     /**
  89.      * Generate the module
  90.      */
  91.     protected function compile()
  92.     {
  93.         /** @var PageModel $objPage */
  94.         global $objPage;
  96.         $blnClearInput = false;
  98.         $intYear = (int) Input::get('year');
  99.         $intMonth = (int) Input::get('month');
  100.         $intDay = (int) Input::get('day');
  102.         // Handle featured events
  103.         $blnFeatured = null;
  105.         if ($this->cal_featured == 'featured')
  106.         {
  107.             $blnFeatured = true;
  108.         }
  109.         elseif ($this->cal_featured == 'unfeatured')
  110.         {
  111.             $blnFeatured = false;
  112.         }
  114.         // Jump to the current period
  115.         if (!isset($_GET['year']) && !isset($_GET['month']) && !isset($_GET['day']))
  116.         {
  117.             switch ($this->cal_format)
  118.             {
  119.                 case 'cal_year':
  120.                     $intYear = date('Y');
  121.                     break;
  123.                 case 'cal_month':
  124.                     $intMonth = date('Ym');
  125.                     break;
  127.                 case 'cal_day':
  128.                     $intDay = date('Ymd');
  129.                     break;
  130.             }
  132.             $blnClearInput = true;
  133.         }
  135.         $blnDynamicFormat = (!$this->cal_ignoreDynamic && \in_array($this->cal_format, array('cal_day', 'cal_month', 'cal_year')));
  137.         // Create the date object
  138.         try
  139.         {
  140.             if ($blnDynamicFormat && $intYear)
  141.             {
  142.                 $this->Date = new Date($intYear, 'Y');
  143.                 $this->cal_format = 'cal_year';
  144.                 $this->headline .= ' ' . date('Y', $this->Date->tstamp);
  145.             }
  146.             elseif ($blnDynamicFormat && $intMonth)
  147.             {
  148.                 $this->Date = new Date($intMonth, 'Ym');
  149.                 $this->cal_format = 'cal_month';
  150.                 $this->headline .= ' ' . Date::parse('F Y', $this->Date->tstamp);
  151.             }
  152.             elseif ($blnDynamicFormat && $intDay)
  153.             {
  154.                 $this->Date = new Date($intDay, 'Ymd');
  155.                 $this->cal_format = 'cal_day';
  156.                 $this->headline .= ' ' . Date::parse($objPage->dateFormat, $this->Date->tstamp);
  157.             }
  158.             else
  159.             {
  160.                 $this->Date = new Date();
  161.             }
  162.         }
  163.         catch (\OutOfBoundsException $e)
  164.         {
  165.             throw new PageNotFoundException('Page not found: ' . Environment::get('uri'));
  166.         }
  168.         list($intStart, $intEnd, $strEmpty) = $this->getDatesFromFormat($this->Date, $this->cal_format);
  170.         // Get all events
  171.         $arrAllEvents = $this->getAllEvents($this->cal_calendar, $intStart, $intEnd, $blnFeatured);
  173.         $sort = ($this->cal_order == 'descending') ? 'krsort' : 'ksort';
  175.         // Sort the days
  176.         $sort($arrAllEvents);
  178.         // Sort the events
  179.         foreach (array_keys($arrAllEvents) as $key)
  180.         {
  181.             $sort($arrAllEvents[$key]);
  182.         }
  184.         $intCount = 0;
  185.         $arrEvents = array();
  187.         // Remove events outside the scope
  188.         foreach ($arrAllEvents as $days)
  189.         {
  190.             foreach ($days as $day=>$events)
  191.             {
  192.                 // Skip events before the start day if the "shortened view" option is not set.
  193.                 // Events after the end day are filtered in the Events::addEvent() method (see #8782).
  194.                 if (!$this->cal_noSpan && $day < $intStart)
  195.                 {
  196.                     continue;
  197.                 }
  199.                 foreach ($events as $event)
  200.                 {
  201.                     // Use repeatEnd if > 0 (see #8447)
  202.                     if ($event['startTime'] > $intEnd || ($event['repeatEnd'] ?: $event['endTime']) < $intStart)
  203.                     {
  204.                         continue;
  205.                     }
  207.                     // Hide running events
  208.                     if ($this->cal_hideRunning && $event['begin'] < $intStart)
  209.                     {
  210.                         continue;
  211.                     }
  213.                     // Skip occurrences in the past
  214.                     if ($event['repeatEnd'] && $event['end'] < $intStart)
  215.                     {
  216.                         continue;
  217.                     }
  219.                     // Hide running non-recurring events (see #30)
  220.                     if ($this->cal_hideRunning && !$event['recurring'] && $event['startTime'] < time())
  221.                     {
  222.                         continue;
  223.                     }
  225.                     $event['firstDay'] = $GLOBALS['TL_LANG']['DAYS'][date('w', (int) $day)];
  226.                     $event['firstDate'] = Date::parse($objPage->dateFormat, $day);
  227.                     $event['count'] = ++$intCount; // see #74
  229.                     $arrEvents[] = $event;
  230.                 }
  231.             }
  232.         }
  234.         unset($arrAllEvents);
  235.         $total = \count($arrEvents);
  236.         $limit = $total;
  237.         $offset = 0;
  239.         // Overall limit
  240.         if ($this->cal_limit > 0)
  241.         {
  242.             $total = min($this->cal_limit, $total);
  243.             $limit = $total;
  244.         }
  246.         // Pagination
  247.         if ($this->perPage > 0)
  248.         {
  249.             $id = 'page_e' . $this->id;
  250.             $page = Input::get($id) ?? 1;
  252.             // Do not index or cache the page if the page number is outside the range
  253.             if ($page < 1 || $page > max(ceil($total/$this->perPage), 1))
  254.             {
  255.                 throw new PageNotFoundException('Page not found: ' . Environment::get('uri'));
  256.             }
  258.             $offset = ($page - 1) * $this->perPage;
  259.             $limit = min($this->perPage + $offset, $total);
  261.             $objPagination = new Pagination($total, $this->perPage, Config::get('maxPaginationLinks'), $id);
  262.             $this->Template->pagination = $objPagination->generate("\n  ");
  263.         }
  265.         $strMonth = '';
  266.         $strDate = '';
  267.         $strEvents = '';
  268.         $dayCount = 0;
  269.         $eventCount = 0;
  270.         $headerCount = 0;
  272.         $uuids = array();
  274.         for ($i=$offset; $i<$limit; $i++)
  275.         {
  276.             if ($arrEvents[$i]['addImage'] && $arrEvents[$i]['singleSRC'])
  277.             {
  278.                 $uuids[] = $arrEvents[$i]['singleSRC'];
  279.             }
  280.         }
  282.         // Preload all images in one query, so they are loaded into the model registry
  283.         FilesModel::findMultipleByUuids($uuids);
  285.         // Parse events
  286.         for ($i=$offset; $i<$limit; $i++)
  287.         {
  288.             $event = $arrEvents[$i];
  289.             $blnIsLastEvent = false;
  291.             // Last event on the current day
  292.             if (($i+1) == $limit || !isset($arrEvents[($i+1)]['firstDate']) || $event['firstDate'] != $arrEvents[($i+1)]['firstDate'])
  293.             {
  294.                 $blnIsLastEvent = true;
  295.             }
  297.             $objTemplate = new FrontendTemplate($this->cal_template ?: 'event_list');
  298.             $objTemplate->setData($event);
  300.             // Month header
  301.             if ($strMonth != $event['month'])
  302.             {
  303.                 $objTemplate->newMonth = true;
  304.                 $strMonth = $event['month'];
  305.             }
  307.             // Day header
  308.             if ($strDate != $event['firstDate'])
  309.             {
  310.                 $headerCount = 0;
  311.                 $objTemplate->header = true;
  312.                 $objTemplate->classHeader = ((($dayCount % 2) == 0) ? ' even' : ' odd') . (($dayCount == 0) ? ' first' : '') . (($event['firstDate'] == $arrEvents[($limit-1)]['firstDate']) ? ' last' : '');
  313.                 $strDate = $event['firstDate'];
  315.                 ++$dayCount;
  316.             }
  318.             // Show the teaser text of redirect events (see #6315)
  319.             if (\is_bool($event['details']) && $event['source'] == 'default')
  320.             {
  321.                 $objTemplate->hasDetails = false;
  322.             }
  324.             $objTemplate->hasReader = $event['source'] == 'default';
  326.             // Add the template variables
  327.             $objTemplate->classList = $event['class'] . ((($headerCount % 2) == 0) ? ' even' : ' odd') . (($headerCount == 0) ? ' first' : '') . ($blnIsLastEvent ? ' last' : '') . ' cal_' . $event['parent'];
  328.             $objTemplate->classUpcoming = $event['class'] . ((($eventCount % 2) == 0) ? ' even' : ' odd') . (($eventCount == 0) ? ' first' : '') . ((($offset + $eventCount + 1) >= $limit) ? ' last' : '') . ' cal_' . $event['parent'];
  329.             $objTemplate->readMore = StringUtil::specialchars(sprintf($GLOBALS['TL_LANG']['MSC']['readMore'], $event['title']));
  330.             $objTemplate->more = $GLOBALS['TL_LANG']['MSC']['more'];
  331.             $objTemplate->locationLabel = $GLOBALS['TL_LANG']['MSC']['location'];
  333.             // Short view
  334.             if ($this->cal_noSpan)
  335.             {
  336.                 $objTemplate->day = $event['day'];
  337.                 $objTemplate->date = $event['date'];
  338.             }
  339.             else
  340.             {
  341.                 $objTemplate->day = $event['firstDay'];
  342.                 $objTemplate->date = $event['firstDate'];
  343.             }
  345.             $objTemplate->addImage = false;
  346.             $objTemplate->addBefore = false;
  348.             // Add an image
  349.             if ($event['addImage'])
  350.             {
  351.                 /** @var CalendarEventsModel $eventModel */
  352.                 $eventModel = CalendarEventsModel::findByPk($event['id']);
  353.                 $imgSize = $eventModel->size ?: null;
  355.                 // Override the default image size
  356.                 if ($this->imgSize)
  357.                 {
  358.                     $size = StringUtil::deserialize($this->imgSize);
  360.                     if ($size[0] > 0 || $size[1] > 0 || is_numeric($size[2]) || ($size[2][0] ?? null) === '_')
  361.                     {
  362.                         $imgSize = $this->imgSize;
  363.                     }
  364.                 }
  366.                 $figureBuilder = System::getContainer()->get('contao.image.studio')->createFigureBuilder();
  368.                 $figure = $figureBuilder
  369.                     ->from($event['singleSRC'])
  370.                     ->setSize($imgSize)
  371.                     ->setMetadata($eventModel->getOverwriteMetadata())
  372.                     ->enableLightbox((bool) $eventModel->fullsize)
  373.                     ->buildIfResourceExists();
  375.                 if (null !== $figure)
  376.                 {
  377.                     // Rebuild with link to event if none is set
  378.                     if (!$figure->getLinkHref())
  379.                     {
  380.                         $figure = $figureBuilder
  381.                             ->setLinkHref($event['href'])
  382.                             ->setLinkAttribute('title', $objTemplate->readMore)
  383.                             ->build();
  384.                     }
  386.                     $figure->applyLegacyTemplateData($objTemplate, $eventModel->imagemargin, $eventModel->floating);
  387.                 }
  388.             }
  390.             $objTemplate->enclosure = array();
  392.             // Add enclosure
  393.             if ($event['addEnclosure'])
  394.             {
  395.                 $this->addEnclosuresToTemplate($objTemplate, $event);
  396.             }
  398.             // schema.org information
  399.             $objTemplate->getSchemaOrgData = static function () use ($objTemplate, $event): array
  400.             {
  401.                 $jsonLd = Events::getSchemaOrgData((new CalendarEventsModel())->setRow($event));
  403.                 if ($objTemplate->addImage && $objTemplate->figure)
  404.                 {
  405.                     $jsonLd['image'] = $objTemplate->figure->getSchemaOrgData();
  406.                 }
  408.                 return $jsonLd;
  409.             };
  411.             $strEvents .= $objTemplate->parse();
  413.             ++$eventCount;
  414.             ++$headerCount;
  415.         }
  417.         // No events found
  418.         if (!$strEvents)
  419.         {
  420.             $strEvents = "\n" . '<div class="empty">' . $strEmpty . '</div>' . "\n";
  421.         }
  423.         // See #3672
  424.         $this->Template->headline = $this->headline;
  425.         $this->Template->events = $strEvents;
  426.         $this->Template->eventCount = $eventCount;
  428.         // Clear the $_GET array (see #2445)
  429.         if ($blnClearInput)
  430.         {
  431.             Input::setGet('year', null);
  432.             Input::setGet('month', null);
  433.             Input::setGet('day', null);
  434.         }
  435.     }
  436. }
  438. class_alias(ModuleEventlist::class, 'ModuleEventlist');