Support auto-item

oveleon · Jul 24, 2023 · 80dc9b7 · 80dc9b7
1 parent 9f7faa7
commit 80dc9b7
Show file tree

Hide file tree

Showing 8 changed files with 91 additions and 9 deletions.
diff --git a/contao/dca/tl_recommendation.php b/contao/dca/tl_recommendation.php
@@ -217,6 +217,11 @@
             'eval'                    => ['doNotCopy'=>true, 'maxlength'=>255, 'tl_class'=>'w100 clr'],
             'sql'                     => "varchar(255) NOT NULL default ''"
         ],
+        'scope' => [
+            'inputType'               => 'text',
+            'filter'                  => true,
+            'sql'                     => "varchar(255) NOT NULL default ''"
+        ],
         'cssClass' => [
             'exclude'                 => true,
             'inputType'               => 'text',

diff --git a/contao/dca/tl_recommendation_archive.php b/contao/dca/tl_recommendation_archive.php
@@ -89,7 +89,7 @@
     // Palettes
     'palettes' => [
         '__selector__'                => ['protected'],
-        'default'                     => '{title_legend},title,jumpTo;{protected_legend:hide},protected'
+        'default'                     => '{title_legend},title,jumpTo,useAutoItem;{protected_legend:hide},protected'
     ],
 
     // Subpalettes
@@ -127,6 +127,12 @@
             'eval'                    => ['submitOnChange'=>true],
             'sql'                     => "char(1) NOT NULL default ''"
         ],
+        'useAutoItem' => [
+            'exclude'                 => true,
+            'filter'                  => true,
+            'inputType'               => 'checkbox',
+            'sql'                     => "char(1) NOT NULL default ''"
+        ],
         'groups' => [
             'exclude'                 => true,
             'inputType'               => 'checkbox',

diff --git a/contao/languages/de/tl_recommendation_list.xlf b/contao/languages/de/tl_recommendation_list.xlf
@@ -53,6 +53,10 @@
         <source>Rating descending</source>
         <target>Bewertung absteigend</target>
       </trans-unit>
+      <trans-unit id="tl_recommendation_list.recommendation_count">
+        <source>%s Reviews</source>
+        <target>%s Bewertungen</target>
+      </trans-unit>
     </body>
   </file>
 </xliff>
diff --git a/contao/languages/en/tl_recommendation_list.xlf b/contao/languages/en/tl_recommendation_list.xlf
@@ -40,6 +40,9 @@
       <trans-unit id="tl_recommendation_list.order_rating_desc">
         <source>Rating descending</source>
       </trans-unit>
+      <trans-unit id="tl_recommendation_list.recommendation_count">
+        <source>%s Reviews</source>
+      </trans-unit>
     </body>
   </file>
 </xliff>
diff --git a/contao/modules/ModuleRecommendation.php b/contao/modules/ModuleRecommendation.php
@@ -185,15 +185,12 @@ protected function parseRecommendations(Collection $objRecommendations): array
         $count = 0;
         $arrRecommendations = [];
 
-        while ($objRecommendations->next())
+        foreach ($objRecommendations as $recommendation)
         {
-            /** @var RecommendationModel $objRecommendation */
-            $objRecommendation = $objRecommendations->current();
-
             /** @var RecommendationArchiveModel $objRecommendationArchive */
-            $objRecommendationArchive = $objRecommendation->getRelated('pid');
+            $objRecommendationArchive = $recommendation->getRelated('pid');
 
-            $arrRecommendations[] = $this->parseRecommendation($objRecommendation, $objRecommendationArchive, ((++$count == 1) ? ' first' : '') . (($count == $limit) ? ' last' : '') . ((($count % 2) == 0) ? ' odd' : ' even'), $count);
+            $arrRecommendations[] = $this->parseRecommendation($recommendation, $objRecommendationArchive, ((++$count == 1) ? ' first' : '') . (($count == $limit) ? ' last' : '') . ((($count % 2) == 0) ? ' odd' : ' even'), $count);
         }
 
         return $arrRecommendations;

diff --git a/contao/modules/ModuleRecommendationForm.php b/contao/modules/ModuleRecommendationForm.php
@@ -95,6 +95,10 @@ protected function compile(): void
             return;
         }
 
+        // Get archive record
+        $archive = RecommendationArchiveModel::findMultipleByIds($this->recommendation_archives);
+        $archive = $archive[0] ?? null;
+
         // Form fields
         $arrFields = [
             'author' => [
@@ -142,6 +146,16 @@ protected function compile(): void
             ],
         ];
 
+        // Add scope for auto alias archives
+        if($archive && $archive->useAutoItem)
+        {
+            $arrFields['scope'] = [
+                'name'      => 'scope',
+                'inputType' => 'hidden',
+                'value'     => Input::get('auto_item')
+            ];
+        }
+
         // Captcha
         if (!$this->recommendation_disableCaptcha)
         {
@@ -266,6 +280,7 @@ protected function compile(): void
                 'time' => $time,
                 'text' => $this->convertLineFeeds($strText),
                 'rating' => $arrWidgets['rating']->value,
+                'scope' => $arrWidgets['scope']->value ?? '',
                 'published' => $this->recommendation_moderate ? '' : 1
             ];
 

diff --git a/contao/modules/ModuleRecommendationList.php b/contao/modules/ModuleRecommendationList.php
@@ -10,13 +10,15 @@
 
 use Contao\BackendTemplate;
 use Contao\Config;
+use Contao\Controller;
 use Contao\CoreBundle\Exception\PageNotFoundException;
 use Contao\Environment;
 use Contao\Input;
 use Contao\Model\Collection;
 use Contao\Pagination;
 use Contao\StringUtil;
 use Contao\System;
+use Oveleon\ContaoRecommendationBundle\Model\RecommendationArchiveModel;
 use Oveleon\ContaoRecommendationBundle\Model\RecommendationModel;
 
 /**
@@ -162,13 +164,34 @@ protected function compile()
 
         $objRecommendations = $this->fetchItems($this->recommendation_archives, $blnFeatured, ($limit ?: 0), $offset, $minRating);
 
+        // Add summary details
+        $this->Template->totalCount = $intTotal;
+        $this->addSummary($objRecommendations);
+
         // Add recommendations
         if ($objRecommendations !== null)
         {
             $this->Template->recommendations = $this->parseRecommendations($objRecommendations);
         }
     }
 
+    protected function addSummary($objRecommendations): void
+    {
+        Controller::loadLanguageFile('tl_recommendation_list');
+
+        $ratings = $objRecommendations->fetchEach('rating');
+        $grouped = \array_count_values($ratings);
+        $average = 0;
+
+        \array_walk($grouped, static function ($count, $number) use (&$average){
+            $average += ($number * $count);
+        });
+
+        $this->Template->average = $average / $this->Template->totalCount;
+        $this->Template->averageRound = ceil($this->Template->average);
+        $this->Template->countLabel = sprintf($GLOBALS['TL_LANG']['tl_recommendation_list']['recommendation_count'], $this->Template->totalCount);
+    }
+
     /**
      * Count the total matching items
      *
@@ -196,7 +219,8 @@ protected function countItems($recommendationArchives, $blnFeatured, $minRating)
             }
         }
 
-        return RecommendationModel::countPublishedByPids($recommendationArchives, $blnFeatured, $minRating);
+        //return RecommendationModel::countPublishedByPids($recommendationArchives, $blnFeatured, $minRating);
+        return $this->fetchItems($recommendationArchives, $blnFeatured, 0, 0, $minRating)?->count() ?? 0;
     }
 
     /**
@@ -247,7 +271,34 @@ protected function fetchItems($recommendationArchives, $blnFeatured, $limit, $of
                 $order .= "$t.date DESC";
         }
 
-        return RecommendationModel::findPublishedByPids($recommendationArchives, $blnFeatured, $limit, $offset, $minRating, ['order'=>$order]);
+        // Get archives
+        $archives = RecommendationArchiveModel::findMultipleByIds($recommendationArchives);
+        $archives = array_combine(
+            $archives->fetchEach('id'),
+            $archives->fetchAll()
+        );
+
+        // Fetch items
+        $items = [];
+
+        // Get auto item
+        $autoItem = Input::get('auto_item');
+
+        foreach (RecommendationModel::findPublishedByPids($recommendationArchives, $blnFeatured, $limit, $offset, $minRating, ['order'=>$order]) ?? [] as $item)
+        {
+            if($archives[$item->pid]['useAutoItem'] ?? null)
+            {
+                // Add only if the scope match to the current auto_item
+                if($autoItem === $item->scope)
+                {
+                    $items[] = $item;
+                }
+            }else{
+                $items[] = $item;
+            }
+        }
+
+        return new Collection($items, $t);
     }
 }
 

diff --git a/src/Model/RecommendationArchiveModel.php b/src/Model/RecommendationArchiveModel.php
@@ -19,6 +19,7 @@
  * @property string  $title
  * @property integer $jumpTo
  * @property boolean $protected
+ * @property boolean $useAutoItem
  * @property string  $groups
  *
  * @method static RecommendationArchiveModel|null findById($id, array $opt=array())