vendor/contao/news-bundle/src/Resources/contao/modules/ModuleNews.php line 239

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\Security\ContaoCorePermissions;
  14. use Contao\Model\Collection;
  16. /**
  17.  * Parent class for news modules.
  18.  *
  19.  * @property string $news_template
  20.  * @property mixed  $news_metaFields
  21.  */
  22. abstract class ModuleNews extends Module
  23. {
  24.     /**
  25.      * Sort out protected archives
  26.      *
  27.      * @param array $arrArchives
  28.      *
  29.      * @return array
  30.      */
  31.     protected function sortOutProtected($arrArchives)
  32.     {
  33.         if (empty($arrArchives) || !\is_array($arrArchives))
  34.         {
  35.             return $arrArchives;
  36.         }
  38.         $objArchive = NewsArchiveModel::findMultipleByIds($arrArchives);
  39.         $arrArchives = array();
  41.         if ($objArchive !== null)
  42.         {
  43.             $security = System::getContainer()->get('security.helper');
  45.             while ($objArchive->next())
  46.             {
  47.                 if ($objArchive->protected && !$security->isGranted(ContaoCorePermissions::MEMBER_IN_GROUPS, StringUtil::deserialize($objArchive->groups, true)))
  48.                 {
  49.                     continue;
  50.                 }
  52.                 $arrArchives[] = $objArchive->id;
  53.             }
  54.         }
  56.         return $arrArchives;
  57.     }
  59.     /**
  60.      * Parse an item and return it as string
  61.      *
  62.      * @param NewsModel $objArticle
  63.      * @param boolean   $blnAddArchive
  64.      * @param string    $strClass
  65.      * @param integer   $intCount
  66.      *
  67.      * @return string
  68.      */
  69.     protected function parseArticle($objArticle, $blnAddArchive=false, $strClass='', $intCount=0)
  70.     {
  71.         $objTemplate = new FrontendTemplate($this->news_template ?: 'news_latest');
  72.         $objTemplate->setData($objArticle->row());
  74.         if ($objArticle->cssClass)
  75.         {
  76.             $strClass = ' ' . $objArticle->cssClass . $strClass;
  77.         }
  79.         if ($objArticle->featured)
  80.         {
  81.             $strClass = ' featured' . $strClass;
  82.         }
  84.         $objTemplate->class = $strClass;
  85.         $objTemplate->newsHeadline = $objArticle->headline;
  86.         $objTemplate->subHeadline = $objArticle->subheadline;
  87.         $objTemplate->hasSubHeadline = $objArticle->subheadline ? true : false;
  88.         $objTemplate->linkHeadline = $this->generateLink($objArticle->headline, $objArticle, $blnAddArchive);
  89.         $objTemplate->more = $this->generateLink($GLOBALS['TL_LANG']['MSC']['more'], $objArticle, $blnAddArchive, true);
  90.         $objTemplate->link = News::generateNewsUrl($objArticle, $blnAddArchive);
  91.         $objTemplate->archive = $objArticle->getRelated('pid');
  92.         $objTemplate->count = $intCount; // see #5708
  93.         $objTemplate->text = '';
  94.         $objTemplate->hasText = false;
  95.         $objTemplate->hasTeaser = false;
  96.         $objTemplate->hasReader = true;
  98.         // Clean the RTE output
  99.         if ($objArticle->teaser)
  100.         {
  101.             $objTemplate->hasTeaser = true;
  102.             $objTemplate->teaser = $objArticle->teaser;
  103.             $objTemplate->teaser = StringUtil::encodeEmail($objTemplate->teaser);
  104.         }
  106.         // Display the "read more" button for external/article links
  107.         if ($objArticle->source != 'default')
  108.         {
  109.             $objTemplate->text = true;
  110.             $objTemplate->hasText = true;
  111.             $objTemplate->hasReader = false;
  112.         }
  114.         // Compile the news text
  115.         else
  116.         {
  117.             $id = $objArticle->id;
  119.             $objTemplate->text = function () use ($id)
  120.             {
  121.                 $strText = '';
  122.                 $objElement = ContentModel::findPublishedByPidAndTable($id, 'tl_news');
  124.                 if ($objElement !== null)
  125.                 {
  126.                     while ($objElement->next())
  127.                     {
  128.                         $strText .= $this->getContentElement($objElement->current());
  129.                     }
  130.                 }
  132.                 return $strText;
  133.             };
  135.             $objTemplate->hasText = static function () use ($objArticle)
  136.             {
  137.                 return ContentModel::countPublishedByPidAndTable($objArticle->id, 'tl_news') > 0;
  138.             };
  139.         }
  141.         $arrMeta = $this->getMetaFields($objArticle);
  143.         // Add the meta information
  144.         $objTemplate->date = $arrMeta['date'] ?? null;
  145.         $objTemplate->hasMetaFields = !empty($arrMeta);
  146.         $objTemplate->numberOfComments = $arrMeta['ccount'] ?? null;
  147.         $objTemplate->commentCount = $arrMeta['comments'] ?? null;
  148.         $objTemplate->timestamp = $objArticle->date;
  149.         $objTemplate->author = $arrMeta['author'] ?? null;
  150.         $objTemplate->datetime = date('Y-m-d\TH:i:sP', $objArticle->date);
  151.         $objTemplate->addImage = false;
  152.         $objTemplate->addBefore = false;
  154.         // Add an image
  155.         if ($objArticle->addImage)
  156.         {
  157.             $imgSize = $objArticle->size ?: null;
  159.             // Override the default image size
  160.             if ($this->imgSize)
  161.             {
  162.                 $size = StringUtil::deserialize($this->imgSize);
  164.                 if ($size[0] > 0 || $size[1] > 0 || is_numeric($size[2]) || ($size[2][0] ?? null) === '_')
  165.                 {
  166.                     $imgSize = $this->imgSize;
  167.                 }
  168.             }
  170.             $figureBuilder = System::getContainer()
  171.                 ->get('contao.image.studio')
  172.                 ->createFigureBuilder()
  173.                 ->from($objArticle->singleSRC)
  174.                 ->setSize($imgSize)
  175.                 ->setMetadata($objArticle->getOverwriteMetadata())
  176.                 ->enableLightbox((bool) $objArticle->fullsize);
  178.             // If the external link is opened in a new window, open the image link in a new window as well (see #210)
  179.             if ('external' === $objTemplate->source && $objTemplate->target)
  180.             {
  181.                 $figureBuilder->setLinkAttribute('target', '_blank');
  182.             }
  184.             if (null !== ($figure = $figureBuilder->buildIfResourceExists()))
  185.             {
  186.                 // Rebuild with link to news article if none is set
  187.                 if (!$figure->getLinkHref())
  188.                 {
  189.                     $linkTitle = StringUtil::specialchars(sprintf($GLOBALS['TL_LANG']['MSC']['readMore'], $objArticle->headline), true);
  191.                     $figure = $figureBuilder
  192.                         ->setLinkHref($objTemplate->link)
  193.                         ->setLinkAttribute('title', $linkTitle)
  194.                         ->build();
  195.                 }
  197.                 $figure->applyLegacyTemplateData($objTemplate, $objArticle->imagemargin, $objArticle->floating);
  198.             }
  199.         }
  201.         $objTemplate->enclosure = array();
  203.         // Add enclosures
  204.         if ($objArticle->addEnclosure)
  205.         {
  206.             $this->addEnclosuresToTemplate($objTemplate, $objArticle->row());
  207.         }
  209.         // HOOK: add custom logic
  210.         if (isset($GLOBALS['TL_HOOKS']['parseArticles']) && \is_array($GLOBALS['TL_HOOKS']['parseArticles']))
  211.         {
  212.             foreach ($GLOBALS['TL_HOOKS']['parseArticles'] as $callback)
  213.             {
  214.                 $this->import($callback[0]);
  215.                 $this->{$callback[0]}->{$callback[1]}($objTemplate, $objArticle->row(), $this);
  216.             }
  217.         }
  219.         // Tag the news (see #2137)
  220.         if (System::getContainer()->has('fos_http_cache.http.symfony_response_tagger'))
  221.         {
  222.             $responseTagger = System::getContainer()->get('fos_http_cache.http.symfony_response_tagger');
  223.             $responseTagger->addTags(array('contao.db.tl_news.' . $objArticle->id));
  224.         }
  226.         // schema.org information
  227.         $objTemplate->getSchemaOrgData = static function () use ($objTemplate, $objArticle): array
  228.         {
  229.             $jsonLd = News::getSchemaOrgData($objArticle);
  231.             if ($objTemplate->addImage && $objTemplate->figure)
  232.             {
  233.                 $jsonLd['image'] = $objTemplate->figure->getSchemaOrgData();
  234.             }
  236.             return $jsonLd;
  237.         };
  239.         return $objTemplate->parse();
  240.     }
  242.     /**
  243.      * Parse one or more items and return them as array
  244.      *
  245.      * @param Collection $objArticles
  246.      * @param boolean    $blnAddArchive
  247.      *
  248.      * @return array
  249.      */
  250.     protected function parseArticles($objArticles, $blnAddArchive=false)
  251.     {
  252.         $limit = $objArticles->count();
  254.         if ($limit < 1)
  255.         {
  256.             return array();
  257.         }
  259.         $count = 0;
  260.         $arrArticles = array();
  261.         $uuids = array();
  263.         foreach ($objArticles as $objArticle)
  264.         {
  265.             if ($objArticle->addImage && $objArticle->singleSRC)
  266.             {
  267.                 $uuids[] = $objArticle->singleSRC;
  268.             }
  269.         }
  271.         // Preload all images in one query, so they are loaded into the model registry
  272.         FilesModel::findMultipleByUuids($uuids);
  274.         foreach ($objArticles as $objArticle)
  275.         {
  276.             $arrArticles[] = $this->parseArticle($objArticle, $blnAddArchive, ((++$count == 1) ? ' first' : '') . (($count == $limit) ? ' last' : '') . ((($count % 2) == 0) ? ' odd' : ' even'), $count);
  277.         }
  279.         return $arrArticles;
  280.     }
  282.     /**
  283.      * Return the meta fields of a news article as array
  284.      *
  285.      * @param NewsModel $objArticle
  286.      *
  287.      * @return array
  288.      */
  289.     protected function getMetaFields($objArticle)
  290.     {
  291.         $meta = StringUtil::deserialize($this->news_metaFields);
  293.         if (!\is_array($meta))
  294.         {
  295.             return array();
  296.         }
  298.         /** @var PageModel $objPage */
  299.         global $objPage;
  301.         $return = array();
  303.         foreach ($meta as $field)
  304.         {
  305.             switch ($field)
  306.             {
  307.                 case 'date':
  308.                     $return['date'] = Date::parse($objPage->datimFormat, $objArticle->date);
  309.                     break;
  311.                 case 'author':
  312.                     /** @var UserModel $objAuthor */
  313.                     if (($objAuthor = $objArticle->getRelated('author')) instanceof UserModel)
  314.                     {
  315.                         $return['author'] = $GLOBALS['TL_LANG']['MSC']['by'] . ' ' . $objAuthor->name;
  316.                         $return['authorModel'] = $objAuthor;
  317.                     }
  318.                     break;
  320.                 case 'comments':
  321.                     if ($objArticle->noComments || $objArticle->source != 'default')
  322.                     {
  323.                         break;
  324.                     }
  326.                     $bundles = System::getContainer()->getParameter('kernel.bundles');
  328.                     if (!isset($bundles['ContaoCommentsBundle']))
  329.                     {
  330.                         break;
  331.                     }
  333.                     $intTotal = CommentsModel::countPublishedBySourceAndParent('tl_news', $objArticle->id);
  334.                     $return['ccount'] = $intTotal;
  335.                     $return['comments'] = sprintf($GLOBALS['TL_LANG']['MSC']['commentCount'], $intTotal);
  336.                     break;
  337.             }
  338.         }
  340.         return $return;
  341.     }
  343.     /**
  344.      * Generate a URL and return it as string
  345.      *
  346.      * @param NewsModel $objItem
  347.      * @param boolean   $blnAddArchive
  348.      *
  349.      * @return string
  350.      *
  351.      * @deprecated Deprecated since Contao 4.1, to be removed in Contao 5.
  352.      *             Use News::generateNewsUrl() instead.
  353.      */
  354.     protected function generateNewsUrl($objItem, $blnAddArchive=false)
  355.     {
  356.         trigger_deprecation('contao/news-bundle', '4.1', 'Using "Contao\ModuleNews::generateNewsUrl()" has been deprecated and will no longer work in Contao 5.0. Use "Contao\News::generateNewsUrl()" instead.');
  358.         return News::generateNewsUrl($objItem, $blnAddArchive);
  359.     }
  361.     /**
  362.      * Generate a link and return it as string
  363.      *
  364.      * @param string    $strLink
  365.      * @param NewsModel $objArticle
  366.      * @param boolean   $blnAddArchive
  367.      * @param boolean   $blnIsReadMore
  368.      *
  369.      * @return string
  370.      */
  371.     protected function generateLink($strLink, $objArticle, $blnAddArchive=false, $blnIsReadMore=false)
  372.     {
  373.         $blnIsInternal = $objArticle->source != 'external';
  374.         $strReadMore = $blnIsInternal ? $GLOBALS['TL_LANG']['MSC']['readMore'] : $GLOBALS['TL_LANG']['MSC']['open'];
  375.         $strArticleUrl = News::generateNewsUrl($objArticle, $blnAddArchive);
  377.         return sprintf(
  378.             '<a href="%s" title="%s"%s>%s%s</a>',
  379.             $strArticleUrl,
  380.             StringUtil::specialchars(sprintf($strReadMore, $blnIsInternal ? $objArticle->headline : $strArticleUrl), true),
  381.             ($objArticle->target && !$blnIsInternal ? ' target="_blank" rel="noreferrer noopener"' : ''),
  382.             $strLink,
  383.             ($blnIsReadMore && $blnIsInternal ? '<span class="invisible"> ' . $objArticle->headline . '</span>' : '')
  384.         );
  385.     }
  386. }
  388. class_alias(ModuleNews::class, 'ModuleNews');