add parent category flare filter

Author: koertho

README.md

@@ -11,7 +11,7 @@ This bundle allows to assign nestable categories to arbitrary entities in Contao
 - conveniently add single category fields (radio button) or multiple categories fields (checkbox) via a simple function call
 - specify overridable properties in categories and compute the correct result depending on the given context easily
 - [DC_Multilingual](https://github.com/terminal42/contao-DC_Multilingual) support
-- categories filter type for [Contao Filter Bundle](https://github.com/heimrichhannot/contao-filter-bundle)
+- [Flare Bundle](https://github.com/heimrichhannot/contao-flare-bundle) support 
 
 ## Impressions
 

config/flare.yaml

@@ -0,0 +1,5 @@
+services:
+  HeimrichHannot\CategoriesBundle\Flare\:
+    resource: '../src/Flare/*'
+    autowire: true
+    autoconfigure: true

config/services.yml config/services.yamlconfig/services.yml renamed to config/services.yaml

@@ -6,6 +6,8 @@
  * @license LGPL-3.0-or-later
  */
 
+use HeimrichHannot\CategoriesBundle\Flare\FilterElement\ParentCategoryFilterElement;
+
 $GLOBALS['TL_LANG']['MSC']['categoriesBundle'] = [
     'configsAvailable' => 'Konfigurationen verfügbar',
     'primaryCategory' => 'Primäre Kategorie',
@@ -16,3 +18,6 @@
  */
 $GLOBALS['TL_LANG']['MSC']['cm_resetCategories'] = ['Alle Kategorien', 'Zeigt Nachrichten aus allen Kategorien'];
 $GLOBALS['TL_LANG']['MSC']['categoryPicker'] = 'Kategorien';
+
+$flare['filter'][ParentCategoryFilterElement::TYPE][0] = 'Elternkategorie (Kindkategorien der ausgewählten Kategorie)';
+$flare['filter'][ParentCategoryFilterElement::TYPE][1] = 'Filtert Einträge nach den Kindkategorien der ausgewählten Kategorie.';

contao/languages/de/default.php

@@ -6,6 +6,8 @@
  * @license LGPL-3.0-or-later
  */
 
+use HeimrichHannot\CategoriesBundle\Flare\FilterElement\ParentCategoryFilterElement;
+
 $GLOBALS['TL_LANG']['MSC']['categoriesBundle'] = [
     'configsAvailable' => 'Configuration available',
     'primaryCategory' => 'Primary category',
@@ -16,3 +18,6 @@
  */
 $GLOBALS['TL_LANG']['MSC']['cm_resetCategories'] = ['All categories', 'Show news from all categories'];
 $GLOBALS['TL_LANG']['MSC']['categoryPicker'] = 'Categories';
+
+$flare['filter'][ParentCategoryFilterElement::TYPE][0] = 'Parent Category (child categories of the selected category)';
+$flare['filter'][ParentCategoryFilterElement::TYPE][1] = 'Filters entries by the child categories of the selected category.';

contao/languages/en/default.php

@@ -8,22 +8,24 @@
 
 namespace HeimrichHannot\CategoriesBundle;
 
-use Symfony\Component\DependencyInjection\Extension\ExtensionInterface;
-use HeimrichHannot\CategoriesBundle\DependencyInjection\CategoriesExtension;
-use Symfony\Component\HttpKernel\Bundle\Bundle;
+use Composer\InstalledVersions;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+use Symfony\Component\HttpKernel\Bundle\AbstractBundle;
 
-class CategoriesBundle extends Bundle
+class CategoriesBundle extends AbstractBundle
 {
-    /**
-     * {@inheritdoc}
-     */
-    public function getContainerExtension(): CategoriesExtension|ExtensionInterface|null
+    public function getPath(): string
     {
-        return new CategoriesExtension();
+        return \dirname(__DIR__);
     }
 
-    public function getPath(): string
+    public function loadExtension(array $config, ContainerConfigurator $configurator, ContainerBuilder $builder): void
     {
-        return \dirname(__DIR__);
+        $configurator->import('../config/services.yaml');
+
+        if (InstalledVersions::isInstalled('heimrichhannot/contao-flare-bundle')) {
+            $configurator->import('../config/flare.yaml');
+        }
     }
 }

src/CategoriesBundle.php

@@ -8,25 +8,25 @@
 
 namespace HeimrichHannot\CategoriesBundle\DependencyInjection;
 
+use Composer\InstalledVersions;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Extension\PrependExtensionInterface;
 use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
 use Symfony\Component\DependencyInjection\Extension\Extension;
 
-class CategoriesExtension extends Extension implements PrependExtensionInterface
+class CategoriesExtension extends Extension
 {
     /**
      * {@inheritdoc}
      */
     public function load(array $configs, ContainerBuilder $container):void
-    {
-
-    }
-    public function prepend(ContainerBuilder $container): void
     {
         $loader = new YamlFileLoader($container, new FileLocator(\dirname(__DIR__) . '/../config'));
+        $loader->load('services.yaml');
 
-        $loader->load('services.yml');
+        if (InstalledVersions::isInstalled('heimrichhannot/contao-flare-bundle')) {
+            $loader->load('flare.yaml');
+        }
     }
 }

src/DependencyInjection/CategoriesExtension.php

@@ -0,0 +1,59 @@
+<?php
+
+namespace HeimrichHannot\CategoriesBundle\Flare\FilterElement;
+
+use Contao\StringUtil;
+use HeimrichHannot\CategoriesBundle\Model\CategoryModel;
+use HeimrichHannot\FlareBundle\DependencyInjection\Attribute\AsFilterElement;
+use HeimrichHannot\FlareBundle\Filter\FilterContext;
+use HeimrichHannot\FlareBundle\Filter\FilterQueryBuilder;
+use HeimrichHannot\FlareBundle\FilterElement\AbstractFilterElement;
+use HeimrichHannot\FlareBundle\Form\ChoicesBuilder;
+use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
+
+#[AsFilterElement(
+    alias: self::TYPE,
+    palette: '{fieldGeneric_legend},fieldGeneric,filterCategory;{form_legend},placeholder',
+    formType: ChoiceType::class,
+)]
+class ParentCategoryFilterElement extends AbstractFilterElement
+{
+    public const TYPE = 'parent_category';
+
+    public function __invoke(FilterContext $context, FilterQueryBuilder $qb): void
+    {
+        if (!$context->getSubmittedData()) {
+            return;
+        }
+
+        if (!$targetField = $context->getFilterModel()->fieldGeneric) {
+            $qb->abort();
+        }
+
+        $qb->where($qb->expr()->like($targetField, ':category'))
+            ->setParameter('category', '%"' . $context->getSubmittedData() . '"%');
+    }
+
+    public function getFormTypeOptions(FilterContext $context, ChoicesBuilder $choices): array
+    {
+        $options = $this->defaultFormTypeOptions(
+            $context,
+            ['placeholder' => true]
+        );
+        $options['choices'] = [];
+
+        $categoryIds = StringUtil::deserialize($context->getFilterModel()->filterCategory, true);
+
+        if (empty($categoryIds)) {
+            return $options;
+        }
+
+        $categories = CategoryModel::findByPids($categoryIds);
+
+        while ($categories->next()) {
+            $options['choices'][$categories->title] = (string) $categories->id;
+        }
+
+        return $options;
+    }
+}

src/Flare/FilterElement/ParentCategoryFilterElement.php

@@ -30,6 +30,18 @@ class CategoryModel extends AbstractModel
 {
     protected static $strTable = 'tl_category';
 
+    public static function findByPids(array $pids, array $options = []): ?Collection
+    {
+        $t = static::getTable();
+        $parents = implode(',', array_map('intval', $pids));
+
+        return static::findBy(
+            ["$t.pid IN (".$parents.")",],
+            [],
+            $options
+        );
+    }
+
     /**
      * @return CategoryModel|CategoryModel[]|Collection|null
      */