vendor/contao/faq-bundle/src/Resources/contao/modules/ModuleFaqList.php line 173

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. /**
  14. * Class ModuleFaqList
  15. *
  16. * @property array $faq_categories
  17. * @property int $faq_readerModule
  18. */
  19. class ModuleFaqList extends Module
  20. {
  21. /**
  22. * Template
  23. * @var string
  24. */
  25. protected $strTemplate = 'mod_faqlist';
  27. /**
  28. * Target pages
  29. * @var array
  30. */
  31. protected $arrTargets = array();
  33. /**
  34. * Display a wildcard in the back end
  35. *
  36. * @return string
  37. */
  38. public function generate()
  39. {
  40. $request = System::getContainer()->get('request_stack')->getCurrentRequest();
  42. if ($request && System::getContainer()->get('contao.routing.scope_matcher')->isBackendRequest($request))
  43. {
  44. $objTemplate = new BackendTemplate('be_wildcard');
  45. $objTemplate->wildcard = '### ' . $GLOBALS['TL_LANG']['FMD']['faqlist'][0] . ' ###';
  46. $objTemplate->title = $this->headline;
  47. $objTemplate->id = $this->id;
  48. $objTemplate->link = $this->name;
  49. $objTemplate->href = StringUtil::specialcharsUrl(System::getContainer()->get('router')->generate('contao_backend', array('do'=>'themes', 'table'=>'tl_module', 'act'=>'edit', 'id'=>$this->id)));
  51. return $objTemplate->parse();
  52. }
  54. $this->faq_categories = StringUtil::deserialize($this->faq_categories);
  56. // Return if there are no categories
  57. if (empty($this->faq_categories) || !\is_array($this->faq_categories))
  58. {
  59. return '';
  60. }
  62. // Show the FAQ reader if an item has been selected
  63. if ($this->faq_readerModule > 0 && (isset($_GET['items']) || (Config::get('useAutoItem') && isset($_GET['auto_item']))))
  64. {
  65. return $this->getFrontendModule($this->faq_readerModule, $this->strColumn);
  66. }
  68. // Tag the FAQ categories (see #2137)
  69. if (System::getContainer()->has('fos_http_cache.http.symfony_response_tagger'))
  70. {
  71. $responseTagger = System::getContainer()->get('fos_http_cache.http.symfony_response_tagger');
  72. $responseTagger->addTags(array_map(static function ($id) { return 'contao.db.tl_faq_category.' . $id; }, $this->faq_categories));
  73. }
  75. return parent::generate();
  76. }
  78. /**
  79. * Generate the module
  80. */
  81. protected function compile()
  82. {
  83. $objFaq = FaqModel::findPublishedByPids($this->faq_categories);
  85. if ($objFaq === null)
  86. {
  87. $this->Template->faq = array();
  89. return;
  90. }
  92. $tags = array();
  93. $arrFaq = array_fill_keys($this->faq_categories, array());
  95. // Add FAQs
  96. while ($objFaq->next())
  97. {
  98. $arrTemp = $objFaq->row();
  99. $arrTemp['title'] = StringUtil::specialchars($objFaq->question, true);
  100. $arrTemp['href'] = $this->generateFaqLink($objFaq);
  102. /** @var FaqCategoryModel $objPid */
  103. $objPid = $objFaq->getRelated('pid');
  105. if (empty($arrFaq[$objFaq->pid]))
  106. {
  107. $arrFaq[$objFaq->pid] = $objPid->row();
  108. }
  110. $arrFaq[$objFaq->pid]['items'][] = $arrTemp;
  112. $tags[] = 'contao.db.tl_faq.' . $objFaq->id;
  113. }
  115. // Tag the FAQs (see #2137)
  116. if (System::getContainer()->has('fos_http_cache.http.symfony_response_tagger'))
  117. {
  118. $responseTagger = System::getContainer()->get('fos_http_cache.http.symfony_response_tagger');
  119. $responseTagger->addTags($tags);
  120. }
  122. $arrFaq = array_values(array_filter($arrFaq));
  124. $cat_count = 0;
  125. $cat_limit = \count($arrFaq);
  127. // Add classes
  128. foreach ($arrFaq as $k=>$v)
  129. {
  130. $count = 0;
  131. $limit = \count($v['items']);
  133. for ($i=0; $i<$limit; $i++)
  134. {
  135. $arrFaq[$k]['items'][$i]['class'] = trim(((++$count == 1) ? ' first' : '') . (($count >= $limit) ? ' last' : '') . ((($count % 2) == 0) ? ' odd' : ' even'));
  136. }
  138. $arrFaq[$k]['class'] = trim(((++$cat_count == 1) ? ' first' : '') . (($cat_count >= $cat_limit) ? ' last' : '') . ((($cat_count % 2) == 0) ? ' odd' : ' even'));
  139. }
  141. $this->Template->faq = $arrFaq;
  142. }
  144. /**
  145. * Create links and remember pages that have been processed
  146. *
  147. * @param FaqModel $objFaq
  148. *
  149. * @return string
  150. *
  151. * @throws \Exception
  152. */
  153. protected function generateFaqLink($objFaq)
  154. {
  155. /** @var FaqCategoryModel $objCategory */
  156. $objCategory = $objFaq->getRelated('pid');
  157. $jumpTo = (int) $objCategory->jumpTo;
  159. // A jumpTo page is not mandatory for FAQ categories (see #6226) but required for the FAQ list module
  160. if ($jumpTo < 1)
  161. {
  162. throw new \Exception("FAQ categories without redirect page cannot be used in an FAQ list");
  163. }
  165. // Get the URL from the jumpTo page of the category
  166. if (!isset($this->arrTargets[$jumpTo]))
  167. {
  168. $this->arrTargets[$jumpTo] = StringUtil::ampersand(Environment::get('request'));
  170. if ($jumpTo > 0 && ($objTarget = PageModel::findByPk($jumpTo)) !== null)
  171. {
  172. /** @var PageModel $objTarget */
  173. $this->arrTargets[$jumpTo] = StringUtil::ampersand($objTarget->getFrontendUrl(Config::get('useAutoItem') ? '/%s' : '/items/%s'));
  174. }
  175. }
  177. return sprintf(preg_replace('/%(?!s)/', '%%', $this->arrTargets[$jumpTo]), ($objFaq->alias ?: $objFaq->id));
  178. }
  179. }
  181. class_alias(ModuleFaqList::class, 'ModuleFaqList');