Merge tag '2.2.0'

Stable release 2.2.0
This brings full Contao 4.9 support.

Additionally there have been performance improvements
and various bugfixes.

- The optional custom icons are g-rendered as 16x16px thumbnails.
- If the checkboxes are readonly, they are displayed in the list view, but have no toggle function
- Widget as readonly now works correctly in the input mask

Author: baumannsven

.check-author.yml

@@ -8,3 +8,8 @@ mapping:
   'Andreas Isaak <info@andreas-isaak.de>': 'Andreas Isaak <andy.jared@googlemail.com>'
   'Stefan Heimes <stefan_heimes@hotmail.com>': 'Stefan heimes <stefan_heimes@hotmail.com>'
   'Christopher Boelter <c.boelter@cogizz.de>': 'cogizz <c.boelter@cogizz.de>'
+  'Ingolf Steinhardt <info@e-spin.de>':
+    - 'xantippe <info@e-spin.de>'
+    - 'zonky2 <info@e-spin.de>'
+    - 'zonky <gitlab@e-spin.de>'
+    - 'e-spin <gitlab@e-spin.de>'

.github/workflows/diagnostics.yml

@@ -0,0 +1,52 @@
+name: MetaModels attribute_checkbox
+
+on:
+  push:
+    branches-ignore:
+      - '**-translation'
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        php: [7.4]
+        contao: [~4.9.0]
+
+    steps:
+      - name: PHP ${{ matrix.php }} ${{ matrix.contao }} Pull source
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      # see https://github.com/shivammathur/setup-php
+      - name: PHP ${{ matrix.php }} ${{ matrix.contao }} Setup PHP.
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          coverage: none
+
+      - name: PHP ${{ matrix.php }} ${{ matrix.contao }} Cache composer cache directory
+        uses: actions/cache@v1
+        env:
+          cache-name: composer-cache-dir
+        with:
+          path: ~/.cache/composer
+          key: ${{ runner.os }}-build-${{ env.cache-name }}
+
+      - name: PHP ${{ matrix.php }} ${{ matrix.contao }} Cache vendor directory
+        uses: actions/cache@v1
+        env:
+          cache-name: composer-vendor
+        with:
+          path: vendor
+          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/composer.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-build-${{ env.cache-name }}-
+
+      - name: PHP ${{ matrix.php }} ${{ matrix.contao }} Install composer dependencies
+        run: composer update --prefer-dist --no-interaction --no-suggest
+
+      - name: PHP ${{ matrix.php }} ${{ matrix.contao }} Run tests
+        run: ant -keep-going

.gitignore

@@ -2,7 +2,7 @@
 .DS_Store
 Thumbs.db
 
-# IDEs 
+# IDEs
 .buildpath
 .project
 .settings/
@@ -15,4 +15,6 @@ nbproject/
 vendor/
 
 # build
-build/
+build/
+composer.lock
+.phpunit.result.cache

.travis.yml

@@ -1,4 +1,4 @@
-[![Build Status](https://travis-ci.org/MetaModels/attribute_checkbox.svg)](https://travis-ci.org/MetaModels/attribute_checkbox)
+[![Build Status](https://github.com/MetaModels/attribute_checkbox/actions/workflows/diagnostics.yml/badge.svg)](https://github.com/MetaModels/attribute_checkbox/actions)
 [![Latest Version tagged](http://img.shields.io/github/tag/MetaModels/attribute_checkbox.svg)](https://github.com/MetaModels/attribute_checkbox/tags)
 [![Latest Version on Packagist](http://img.shields.io/packagist/v/MetaModels/attribute_checkbox.svg)](https://packagist.org/packages/MetaModels/attribute_checkbox)
 [![Installations via composer per month](http://img.shields.io/packagist/dm/MetaModels/attribute_checkbox.svg)](https://packagist.org/packages/MetaModels/attribute_checkbox)

README.md

@@ -9,13 +9,13 @@
     "nontranslatable"
   ],
   "type": "contao-bundle",
-  "homepage": "http://now.metamodel.me/",
+  "homepage": "https://now.metamodel.me/",
   "license": "LGPL-3.0-or-later",
   "authors": [
     {
       "name": "Christian Schiffler",
       "email": "c.schiffler@cyberspectrum.de",
-      "homepage": "http://www.cyberspectrum.de",
+      "homepage": "https://www.cyberspectrum.de",
       "role": "Developer"
     },
     {
@@ -27,17 +27,17 @@
   "support": {
     "email": "mail@metamodel.me",
     "issues": "https://github.com/MetaModels/attribute_checkbox/issues",
-    "wiki": "http://de.contaowiki.org/MetaModels",
+    "wiki": "https://de.contaowiki.org/MetaModels",
     "irc": "irc://irc.freenode.org/contao.mm",
     "source": "https://github.com/MetaModels/attribute_checkbox"
   },
   "require": {
-    "php": "^7.1",
-    "contao-community-alliance/dc-general": "^2.1.0",
-    "contao/core-bundle": "^4.4.8",
-    "metamodels/core": "^2.1",
-    "symfony/dependency-injection": "^3.3 || ^4.0",
-    "symfony/http-kernel": "^3.3 || ^4.0"
+    "php": "^7.4",
+    "contao-community-alliance/dc-general": "^2.2",
+    "contao/core-bundle": "^4.9.0, <4.13.0",
+    "metamodels/core": "^2.2",
+    "symfony/dependency-injection": "^4.4.6",
+    "symfony/http-kernel": "^4.4.13"
   },
   "require-dev": {
     "contao/manager-plugin": "^2.1",
@@ -60,10 +60,14 @@
   "extra": {
     "contao-manager-plugin": "MetaModels\\AttributeCheckboxBundle\\ContaoManager\\Plugin",
     "branch-alias": {
-      "dev-master": "2.1.x-dev"
+      "dev-feature/2.2.0": "2.2.x-dev"
     }
   },
   "config": {
+    "allow-plugins": {
+      "contao-components/installer": false,
+      "contao/manager-plugin": false
+    },
     "sort-packages": true
   }
 }

composer.json

@@ -3,7 +3,7 @@
 /**
  * This file is part of MetaModels/attribute_checkbox.
  *
- * (c) 2012-2019 The MetaModels team.
+ * (c) 2012-2020 The MetaModels team.
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
@@ -15,7 +15,8 @@
  * @author     Christopher Boelter <c.boelter@cogizz.de>
  * @author     Sven Baumann <baumann.sv@gmail.com>
  * @author     David Molineus <david.molineus@netzmacht.de>
- * @copyright  2012-2019 The MetaModels team.
+ * @author     Ingolf Steinhardt <info@e-spin.de>
+ * @copyright  2012-2020 The MetaModels team.
  * @license    https://github.com/MetaModels/attribute_checkbox/blob/master/LICENSE LGPL-3.0-or-later
  * @filesource
  */
@@ -31,6 +32,7 @@
 use ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\ToggleCommandInterface;
 use MetaModels\Attribute\IAttribute;
 use MetaModels\AttributeCheckboxBundle\Attribute\Checkbox;
+use MetaModels\CoreBundle\Assets\IconBuilder;
 use MetaModels\DcGeneral\Events\MetaModel\BuildMetaModelOperationsEvent;
 
 /**
@@ -45,14 +47,24 @@ class BuildMetaModelOperationsListener
      */
     private $scopeMatcher;
 
+    /**
+     * The icon builder.
+     *
+     * @var IconBuilder
+     */
+    private $iconBuilder;
+
     /**
      * CreatePropertyConditionListener constructor.
      *
      * @param RequestScopeDeterminator $scopeMatcher Request scope determinator.
+     *
+     * @param IconBuilder              $iconBuilder  The icon builder.
      */
-    public function __construct(RequestScopeDeterminator $scopeMatcher)
+    public function __construct(RequestScopeDeterminator $scopeMatcher, IconBuilder $iconBuilder)
     {
         $this->scopeMatcher = $scopeMatcher;
+        $this->iconBuilder  = $iconBuilder;
     }
 
     /**
@@ -66,7 +78,7 @@ public function __construct(RequestScopeDeterminator $scopeMatcher)
      * @SuppressWarnings(PHPMD.Superglobals)
      * @SuppressWarnings(PHPMD.CamelCaseVariableName)
      */
-    private function buildCommand($attribute, array $propertyData)
+    private function buildCommand(Checkbox $attribute, array $propertyData)
     {
         if ($attribute->get('check_listview') == 1) {
             $commandName = 'listviewtoggle_' . $attribute->getColName();
@@ -82,16 +94,18 @@ private function buildCommand($attribute, array $propertyData)
                 $attribute->getName()
             )
         );
+
         $extra           = $toggle->getExtra();
         $extra['icon']   = 'visible.svg';
         $objIconEnabled  = FilesModel::findByUuid($attribute->get('check_listviewicon'));
         $objIconDisabled = FilesModel::findByUuid($attribute->get('check_listviewicondisabled'));
 
-        if ($attribute->get('check_listview') == 1 && $objIconEnabled->path && $objIconDisabled->path) {
-            $extra['icon']          = $objIconEnabled->path;
-            $extra['icon_disabled'] = $objIconDisabled->path;
-        } else {
-            $extra['icon'] = 'visible.svg';
+        if ($attribute->get('check_listview') == 1 && $objIconEnabled->path) {
+            $extra['icon'] = $this->iconBuilder->getBackendIcon($objIconEnabled->path);
+        }
+
+        if ($attribute->get('check_listview') == 1 && $objIconDisabled->path) {
+            $extra['icon_disabled'] = $this->iconBuilder->getBackendIcon($objIconDisabled->path);
         }
 
         $toggle->setToggleProperty($attribute->getColName());
@@ -114,7 +128,7 @@ private function buildCommand($attribute, array $propertyData)
      *
      * @return Contao2BackendViewDefinition
      */
-    protected function createBackendViewDefinition($container)
+    protected function createBackendViewDefinition(ContainerInterface $container)
     {
         if ($container->hasDefinition(Contao2BackendViewDefinitionInterface::NAME)) {
             $view = $container->getDefinition(Contao2BackendViewDefinitionInterface::NAME);
@@ -142,9 +156,12 @@ public function handle(BuildMetaModelOperationsEvent $event)
             return;
         }
         $allProps   = $event->getScreen()['properties'];
-        $properties = \array_map(function ($property) {
-            return ($property['col_name'] ?? null);
-        }, $allProps);
+        $properties = \array_map(
+            function ($property) {
+                return ($property['col_name'] ?? null);
+            },
+            $allProps
+        );
         foreach ($event->getMetaModel()->getAttributes() as $attribute) {
             if (!$this->wantToAdd($attribute, $properties)) {
                 continue;
@@ -153,6 +170,7 @@ public function handle(BuildMetaModelOperationsEvent $event)
             foreach ($allProps as $prop) {
                 if ($prop['col_name'] === $attribute->getColName()) {
                     $info = $prop;
+                    break;
                 }
             }
 
@@ -181,10 +199,10 @@ public function handle(BuildMetaModelOperationsEvent $event)
      *
      * @return bool
      */
-    private function wantToAdd($attribute, array $properties): bool
+    private function wantToAdd(IAttribute $attribute, array $properties): bool
     {
         return ($attribute instanceof Checkbox)
-            && (($attribute->get('check_publish') === '1') || ($attribute->get('check_listview') === '1'))
-            && (\in_array($attribute->getColName(), $properties, true));
+               && (($attribute->get('check_publish') === '1') || ($attribute->get('check_listview') === '1'))
+               && (\in_array($attribute->getColName(), $properties, true));
     }
 }

src/EventListener/BuildMetaModelOperationsListener.php

@@ -3,7 +3,7 @@
 /**
  * This file is part of MetaModels/attribute_checkbox.
  *
- * (c) 2012-2019 The MetaModels team.
+ * (c) 2012-2022 The MetaModels team.
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
@@ -13,7 +13,8 @@
  * @package    MetaModels/attribute_checkbox
  * @author     Christian Schiffler <c.schiffler@cyberspectrum.de>
  * @author     David Molineus <david.molineus@netzmacht.de>
- * @copyright  2012-2019 The MetaModels team.
+ * @author     Ingolf Steinhardt <info@e-spin.de>
+ * @copyright  2012-2022 The MetaModels team.
  * @license    https://github.com/MetaModels/attribute_checkbox/blob/master/LICENSE LGPL-3.0-or-later
  * @filesource
  */
@@ -26,6 +27,8 @@
 
 /**
  * Handles rendering of model from tl_metamodel_filtersetting.
+ *
+ * @SuppressWarnings(PHPMD.LongClassName)
  */
 class PublishedFilterSettingTypeRendererListener extends AbstractFilterSettingTypeRenderer
 {