Allow configuration via PHP attribute (Case 191330) (#43)

Also:

- Deprecate the use of the annotation
- Drop support for PHP 7

Author: relthyg

.github/workflows/depedencies.yml

@@ -1,12 +1,11 @@
 on: [push]
 name: Dependencies
 env:
-  PHP_VERSION: 7.2
-  PHP_8_VERSION: 8.1
+  PHP_VERSION: 8.1
 
 jobs:
   composer-require-checker:
-    name: Check missing composer requirements (PHP 7.2)
+    name: Check missing composer requirements (PHP 8.1)
     runs-on: ubuntu-22.04
     steps:
       -   uses: actions/checkout@v4
@@ -33,36 +32,5 @@ jobs:
       -   run: |
             composer install --no-interaction --no-scripts --no-progress --no-suggest
             composer show
-      -   name: ComposerRequireChecker
-          uses: docker://webfactory/composer-require-checker:3.2.0
-  
-  composer-require-checker_PHP81:
-    name: Check missing composer requirements (PHP 8.1)
-    runs-on: ubuntu-22.04
-    steps:
-      -   uses: actions/checkout@v4
-      -   name: Configure Composer
-          run: |
-            mkdir -p ~/.composer/cache
-      -   name: Konfiguriere PHP-Version und -Einstellungen im Worker-Node
-          uses: shivammathur/setup-php@v2
-          with:
-            php-version: ${{ env.PHP_8_VERSION }}
-            coverage: none
-            tools: composer:v2
-            ini-values: variables_order=EGPCS
-            # Falls spezielle Extensions installiert werden müssen:
-            # extensions: intl, mbstring
-      -   name: Cache Composer Dependencies
-          uses: actions/cache@v4
-          with:
-            path: vendor/
-            key: composer-${{ env.PHP_8_VERSION }}-${{ hashFiles('composer.*') }}
-            restore-keys: |
-              composer-${{ env.PHP_8_VERSION }}-${{ github.ref }}
-              composer-${{ env.PHP_8_VERSION }}-
-      -   run: |
-            composer install --no-interaction --no-scripts --no-progress --no-suggest
-            composer show
       -   name: ComposerRequireChecker
           uses: docker://ghcr.io/webfactory/composer-require-checker:4.6.0

.github/workflows/tests.yml

@@ -2,13 +2,12 @@ on: [push]
 name: Tests
 env:
   APP_ENV: test
-  PHP_VERSION: 7.2
-  PHP_8_VERSION: 8.1
+  PHP_VERSION: 8.1
   TEMP: ${{ github.workspace }}/tmp
 
 jobs:
   PHPUnit:
-    name: PHPUnit (PHP 7.2)
+    name: PHPUnit (PHP 8.1)
     runs-on: ubuntu-22.04
     steps:
       -   uses: actions/checkout@v4
@@ -37,34 +36,3 @@ jobs:
             composer install --no-interaction --no-scripts --no-progress --no-suggest
             composer show
       -   run: vendor/bin/phpunit -vvv
-
-  PHPUnit_PHP81:
-    name: PHPUnit (PHP 8.1)
-    runs-on: ubuntu-22.04
-    steps:
-      -   uses: actions/checkout@v4
-      -   name: Configure Composer
-          run: |
-            mkdir -p ~/.composer/cache
-      -   run: mkdir --mode=777 -p $GITHUB_WORKSPACE/{tmp,logs}
-      -   name: Konfiguriere PHP-Version und -Einstellungen im Worker-Node
-          uses: shivammathur/setup-php@v2
-          with:
-            php-version: ${{ env.PHP_8_VERSION }}
-            coverage: none
-            tools: composer:v2
-            ini-values: variables_order=EGPCS
-            # Falls spezielle Extensions installiert werden müssen:
-            # extensions: intl, mbstring
-      -   name: Cache Composer Dependencies
-          uses: actions/cache@v4
-          with:
-            path: vendor/
-            key: composer-${{ env.PHP_8_VERSION }}-${{ hashFiles('composer.*') }}
-            restore-keys: |
-              composer-${{ env.PHP_8_VERSION }}-${{ github.ref }}
-              composer-${{ env.PHP_8_VERSION }}-
-      -   run: |
-            composer install --no-interaction --no-scripts --no-progress --no-suggest
-            composer show
-      -   run: vendor/bin/phpunit -vvv

README.md

@@ -46,27 +46,20 @@ grade on a scale, based on which the visibility of the object will be determined
 **Currently, only entities that have a visibility column configured will be filtered at all.**
 
 All you need to configure on your entity is *which* of its fields will be the one with the visibility information.
-You can do that by Adding the `VisibilityColumn()` annotation to that field.
+You can do that by Adding the `VisibilityColumn` attribute to that field.
 
 ```php
 
 use Doctrine\ORM\Mapping as ORM;
-use Webfactory\VisibilityFilterBundle\Annotation\VisibilityColumn;
+use Webfactory\VisibilityFilterBundle\Attribute\VisibilityColumn;
 
-/**
- * @ORM\Entity()
- */
+ #[ORM\Entity()]
 class EntityWithVisibilityColumn
 {
     // ...
-    /**
-     * @VisibilityColumn()
-     *
-     * @ORM\Column(type="string")
-     *
-     * @var string
-     */
-    private $visibilityColumn;
+     #[ORM\Column(type: "string")]
+     #[VisibilityColumn]
+    private string $visibilityColumn;
     // ...
 }
 ```

UPGRADING.md

@@ -0,0 +1,7 @@
+# Upgrade notes for `webfactory/visibility-filter-bundle`
+
+## 1.5.0
+
+* The `\Webfactory\VisibilityFilterBundle\Annotation\VisibilityColumn` annotation has been deprecated. Use the
+  `\Webfactory\VisibilityFilterBundle\Attribute\VisibilityColumn` attribute for configuration instead.
+* Support for PHP 7 has been dropped.

composer.json

@@ -13,12 +13,13 @@
         }
     },
     "require": {
-        "php": "^7.2|^8.1",
+        "php": "^8.1",
         "doctrine/annotations": "^1.12",
         "doctrine/doctrine-bundle": "^1.12.13|^2.0",
         "doctrine/orm": "^2.7.2",
         "symfony/config": "^5.4|^6.4",
         "symfony/dependency-injection": "^5.4|^6.4",
+        "symfony/deprecation-contracts": "^3.6.0",
         "symfony/event-dispatcher": "^5.4|^6.4",
         "symfony/http-kernel": "^5.4|^6.4"
     },

src/Annotation/VisibilityColumn.php

@@ -13,7 +13,19 @@
  *
  * @Annotation
  * @Target("PROPERTY")
+ *
+ * @deprecated, to be replaced by attribute-based configuration
  */
 final class VisibilityColumn
 {
+    public function __construct(array $parameters)
+    {
+        trigger_deprecation(
+            'webfactory/visibility-filter-bundle',
+            '1.5.0',
+            'The %s annotation has been deprecated, use the %s attribute instead.',
+            __CLASS__,
+            \Webfactory\VisibilityFilterBundle\Attribute\VisibilityColumn::class
+        );
+    }
 }

src/Attribute/VisibilityColumn.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Webfactory\VisibilityFilterBundle\Attribute;
+
+use Attribute;
+use Webfactory\VisibilityFilterBundle\Filter\Strategy\FilterStrategy;
+
+/**
+ * This attribute marks a field of an entity as the field containing visibility information (e.g. "y" for visible,
+ * "n" for invisible, or a more complicated system). If the VisibilityFilterBundle is set up, it will be interpreted
+ * by an implementation of @see FilterStrategy.
+ *
+ * For more information on visibility filtering, consider reading the README.md file of this bundle.
+ */
+#[Attribute(Attribute::TARGET_PROPERTY)]
+final class VisibilityColumn
+{
+}

src/Filter/VisibilityColumnRetriever.php

@@ -40,7 +40,19 @@ private function getVisibilityProperty(ClassMetadata $classMetadata): ?Reflectio
         $visibilityProperty = null;
 
         foreach ($classMetadata->getReflectionClass()->getProperties() as $property) {
+            if (\PHP_MAJOR_VERSION >= 8) {
+                if (0 < \count($property->getAttributes(\Webfactory\VisibilityFilterBundle\Attribute\VisibilityColumn::class))) {
+                    $visibilityProperty = $property;
+                }
+            }
+
             if (null !== $this->annotationReader->getPropertyAnnotation($property, VisibilityColumn::class)) {
+                trigger_deprecation(
+                    'webfactory/visibility-filter-bundle',
+                    '1.5.0',
+                    'Configuring webfactory/visibility-filter-bundle with annotations is deprecated, use attributes instead.'
+                );
+
                 if (null !== $visibilityProperty) {
                     throw new RuntimeException('More than 1 visibility column configured for '.$classMetadata->getName().'. You must only configure 1 visibility column per entity.');
                 }