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

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