vendor/contao/faq-bundle/src/Resources/contao/modules/ModuleFaqReader.php line 37

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\InternalServerErrorException;
  14. use Contao\CoreBundle\Exception\PageNotFoundException;
  15. use Contao\CoreBundle\Routing\ResponseContext\HtmlHeadBag\HtmlHeadBag;
  17. /**
  18. * Class ModuleFaqReader
  19. *
  20. * @property Comments $Comments
  21. * @property string $com_template
  22. * @property array $faq_categories
  23. */
  24. class ModuleFaqReader extends Module
  25. {
  26. /**
  27. * Template
  28. * @var string
  29. */
  30. protected $strTemplate = 'mod_faqreader';
  32. /**
  33. * Display a wildcard in the back end
  34. *
  35. * @return string
  36. */
  37. public function generate()
  38. {
  39. $request = System::getContainer()->get('request_stack')->getCurrentRequest();
  41. if ($request && System::getContainer()->get('contao.routing.scope_matcher')->isBackendRequest($request))
  42. {
  43. $objTemplate = new BackendTemplate('be_wildcard');
  44. $objTemplate->wildcard = '### ' . $GLOBALS['TL_LANG']['FMD']['faqreader'][0] . ' ###';
  45. $objTemplate->title = $this->headline;
  46. $objTemplate->id = $this->id;
  47. $objTemplate->link = $this->name;
  48. $objTemplate->href = StringUtil::specialcharsUrl(System::getContainer()->get('router')->generate('contao_backend', array('do'=>'themes', 'table'=>'tl_module', 'act'=>'edit', 'id'=>$this->id)));
  50. return $objTemplate->parse();
  51. }
  53. // Set the item from the auto_item parameter
  54. if (!isset($_GET['items']) && isset($_GET['auto_item']) && Config::get('useAutoItem'))
  55. {
  56. Input::setGet('items', Input::get('auto_item'));
  57. }
  59. // Return an empty string if "items" is not set (to combine list and reader on same page)
  60. if (!Input::get('items'))
  61. {
  62. return '';
  63. }
  65. $this->faq_categories = StringUtil::deserialize($this->faq_categories);
  67. if (empty($this->faq_categories) || !\is_array($this->faq_categories))
  68. {
  69. throw new InternalServerErrorException('The FAQ reader ID ' . $this->id . ' has no categories specified.');
  70. }
  72. return parent::generate();
  73. }
  75. /**
  76. * Generate the module
  77. */
  78. protected function compile()
  79. {
  80. /** @var PageModel $objPage */
  81. global $objPage;
  83. if ($this->overviewPage)
  84. {
  85. $this->Template->referer = PageModel::findById($this->overviewPage)->getFrontendUrl();
  86. $this->Template->back = $this->customLabel ?: $GLOBALS['TL_LANG']['MSC']['faqOverview'];
  87. }
  88. else
  89. {
  90. trigger_deprecation('contao/faq-bundle', '4.13', 'If you do not select an overview page in the FAQ reader module, the "go back" link will no longer be shown in Contao 5.0.');
  92. $this->Template->back = $GLOBALS['TL_LANG']['MSC']['goBack'];
  93. $this->Template->referer = 'javascript:history.go(-1)';
  94. }
  96. $objFaq = FaqModel::findPublishedByParentAndIdOrAlias(Input::get('items'), $this->faq_categories);
  98. if (null === $objFaq)
  99. {
  100. throw new PageNotFoundException('Page not found: ' . Environment::get('uri'));
  101. }
  103. // Add the FAQ record to the template (see #221)
  104. $this->Template->faq = $objFaq->row();
  106. // Overwrite the page metadata (see #2853, #4955 and #87)
  107. $responseContext = System::getContainer()->get('contao.routing.response_context_accessor')->getResponseContext();
  109. if ($responseContext && $responseContext->has(HtmlHeadBag::class))
  110. {
  111. /** @var HtmlHeadBag $htmlHeadBag */
  112. $htmlHeadBag = $responseContext->get(HtmlHeadBag::class);
  113. $htmlDecoder = System::getContainer()->get('contao.string.html_decoder');
  115. if ($objFaq->pageTitle)
  116. {
  117. $htmlHeadBag->setTitle($objFaq->pageTitle); // Already stored decoded
  118. }
  119. elseif ($objFaq->question)
  120. {
  121. $htmlHeadBag->setTitle($htmlDecoder->inputEncodedToPlainText($objFaq->question));
  122. }
  124. if ($objFaq->description)
  125. {
  126. $htmlHeadBag->setMetaDescription($htmlDecoder->inputEncodedToPlainText($objFaq->description));
  127. }
  128. elseif ($objFaq->question)
  129. {
  130. $htmlHeadBag->setMetaDescription($htmlDecoder->inputEncodedToPlainText($objFaq->question));
  131. }
  133. if ($objFaq->robots)
  134. {
  135. $htmlHeadBag->setMetaRobots($objFaq->robots);
  136. }
  137. }
  139. $this->Template->question = $objFaq->question;
  140. $this->Template->answer = StringUtil::encodeEmail($objFaq->answer);
  141. $this->Template->addImage = false;
  142. $this->Template->before = false;
  144. // Add image
  145. if ($objFaq->addImage)
  146. {
  147. $figure = System::getContainer()
  148. ->get('contao.image.studio')
  149. ->createFigureBuilder()
  150. ->from($objFaq->singleSRC)
  151. ->setSize($objFaq->size)
  152. ->setOverwriteMetadata($objFaq->getOverwriteMetadata())
  153. ->enableLightbox((bool) $objFaq->fullsize)
  154. ->buildIfResourceExists();
  156. if (null !== $figure)
  157. {
  158. $figure->applyLegacyTemplateData($this->Template, $objFaq->imagemargin, $objFaq->floating);
  159. }
  160. }
  162. $this->Template->enclosure = array();
  164. // Add enclosure
  165. if ($objFaq->addEnclosure)
  166. {
  167. $this->addEnclosuresToTemplate($this->Template, $objFaq->row());
  168. }
  170. $strAuthor = '';
  172. /** @var UserModel $objAuthor */
  173. if (($objAuthor = $objFaq->getRelated('author')) instanceof UserModel)
  174. {
  175. $strAuthor = $objAuthor->name;
  176. }
  178. $this->Template->info = sprintf($GLOBALS['TL_LANG']['MSC']['faqCreatedBy'], Date::parse($objPage->dateFormat, $objFaq->tstamp), $strAuthor);
  180. // Tag the FAQ (see #2137)
  181. if (System::getContainer()->has('fos_http_cache.http.symfony_response_tagger'))
  182. {
  183. $responseTagger = System::getContainer()->get('fos_http_cache.http.symfony_response_tagger');
  184. $responseTagger->addTags(array('contao.db.tl_faq.' . $objFaq->id));
  185. }
  187. // schema.org information
  188. $this->Template->getSchemaOrgData = static function () use ($objFaq)
  189. {
  190. return ModuleFaq::getSchemaOrgData(array($objFaq));
  191. };
  193. $bundles = System::getContainer()->getParameter('kernel.bundles');
  195. // HOOK: comments extension required
  196. if ($objFaq->noComments || !isset($bundles['ContaoCommentsBundle']))
  197. {
  198. $this->Template->allowComments = false;
  200. return;
  201. }
  203. /** @var FaqCategoryModel $objCategory */
  204. $objCategory = $objFaq->getRelated('pid');
  205. $this->Template->allowComments = $objCategory->allowComments;
  207. // Comments are not allowed
  208. if (!$objCategory->allowComments)
  209. {
  210. return;
  211. }
  213. // Adjust the comments headline level
  214. $intHl = min((int) str_replace('h', '', $this->hl), 5);
  215. $this->Template->hlc = 'h' . ($intHl + 1);
  217. $this->import(Comments::class, 'Comments');
  218. $arrNotifies = array();
  220. // Notify the system administrator
  221. if ($objCategory->notify != 'notify_author' && isset($GLOBALS['TL_ADMIN_EMAIL']))
  222. {
  223. $arrNotifies[] = $GLOBALS['TL_ADMIN_EMAIL'];
  224. }
  226. /** @var UserModel $objAuthor */
  227. if ($objCategory->notify != 'notify_admin' && ($objAuthor = $objFaq->getRelated('author')) instanceof UserModel && $objAuthor->email)
  228. {
  229. $arrNotifies[] = $objAuthor->email;
  230. }
  232. $objConfig = new \stdClass();
  234. $objConfig->perPage = $objCategory->perPage;
  235. $objConfig->order = $objCategory->sortOrder;
  236. $objConfig->template = $this->com_template;
  237. $objConfig->requireLogin = $objCategory->requireLogin;
  238. $objConfig->disableCaptcha = $objCategory->disableCaptcha;
  239. $objConfig->bbcode = $objCategory->bbcode;
  240. $objConfig->moderate = $objCategory->moderate;
  242. $this->Comments->addCommentsToTemplate($this->Template, $objConfig, 'tl_faq', $objFaq->id, $arrNotifies);
  243. }
  244. }
  246. class_alias(ModuleFaqReader::class, 'ModuleFaqReader');