Refactored to support attributes and drop annotation support

README.md

@@ -139,15 +139,13 @@ In this example, it's assumed that the `Product` table has a column called `comp
 
 ```php
 use Doctrine\ORM\Mapping as ORM;
-use Rentpost\Doctrine\MultiTenancy\Annotation\MultiTenancy;
+use Rentpost\Doctrine\MultiTenancy\Attribute\MultiTenancy;
+
+#[ORM\Entity]
+#[MultiTenancy(filters: [
+    new MultiTenancy\Filter(where: '$this.company_id = {companyId}'),
+])]
 
-/**
- * @ORM\Entity
- *
- * @MultiTenancy(filters={
- *      @MultiTenancy\Filter(where="$this.company_id = {companyId}")
- * })
- */
 class Product
 {
   // Whatever
@@ -162,7 +160,7 @@ In the second filter, the `product` table doesn't have access to the necessary i
 
 ```php
 use Doctrine\ORM\Mapping as ORM;
-use Rentpost\Doctrine\MultiTenancy\Annotation\MultiTenancy;
+use Rentpost\Doctrine\MultiTenancy\Attribute\MultiTenancy;
 
 /**
  * @ORM\Entity

src/Attribute/MultiTenancy.php

@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Rentpost\Doctrine\MultiTenancy\Attribute;
+
+use Attribute;
+
+/**
+ * Attribute service for Multi-tenancy
+ *
+ * @author Jacob Thomason <[email protected]>
+ */
+#[Attribute(Attribute::TARGET_CLASS)]
+final class MultiTenancy
+{
+
+    /**
+     * Constructor
+     *
+     * @param MultiTenancy\Filter[] $filters
+     */
+    public function __construct(protected array $filters = [], protected bool $enable = true) {}
+
+
+    /**
+     * Checks if MultiTenancy is enabled
+     */
+    public function isEnabled(): bool
+    {
+        return $this->enable;
+    }
+
+
+    /**
+     * Gets the filters associated with this attribute
+     *
+     * @return MultiTenancy\Filter[]
+     */
+    public function getFilters(): array
+    {
+        return $this->filters;
+    }
+}

src/Attribute/MultiTenancy/Filter.php

@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Rentpost\Doctrine\MultiTenancy\Attribute\MultiTenancy;
+
+use Attribute;
+
+/**
+ * Attribute service for Multi-tenancy filters
+ *
+ * @author Jacob Thomason <[email protected]>
+ */
+#[Attribute(Attribute::TARGET_CLASS|Attribute::IS_REPEATABLE)]
+final class Filter
+{
+
+    /**
+     * Constructor
+     *
+     * @param string[] $context
+     */
+    public function __construct(protected array $context = [], protected string $where = '') {}
+
+
+    /**
+     * Gets the filter context
+     *
+     * @return string[]
+     */
+    public function getContext(): array
+    {
+        return $this->context;
+    }
+
+
+    /**
+     * Gets the SQL where clause
+     */
+    public function getWhereClause(): string
+    {
+        return $this->where;
+    }
+}

src/AnnotationException.php → src/AttributeException.php

@@ -5,10 +5,10 @@
 namespace Rentpost\Doctrine\MultiTenancy;
 
 /**
- * Throw this exception when there is an issue with the MultiTenancy annotation.
+ * Throw this exception when there is an issue with the MultiTenancy attribute.
  *
  * @author Jacob Thomason <[email protected]>
  */
-class AnnotationException extends \Exception
+class AttributeException extends \Exception
 {
 }

src/Filter.php

@@ -4,12 +4,11 @@
 
 namespace Rentpost\Doctrine\MultiTenancy;
 
-use Doctrine\Common\Annotations\AnnotationReader;
 use Doctrine\Common\Annotations\Reader;
 use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\ORM\Mapping\ClassMetadata;
 use Doctrine\ORM\Query\Filter\SQLFilter;
-use Rentpost\Doctrine\MultiTenancy\Annotation\MultiTenancy;
+use Rentpost\Doctrine\MultiTenancy\Attribute\MultiTenancy;
 
 /**
  * Multi-tenancy filter to handle filtering by the company
@@ -21,17 +20,8 @@ class Filter extends SQLFilter
 
     protected ?Listener $listener = null;
     protected ?EntityManagerInterface $entityManager = null;
-    protected ?Reader $annotationReader = null;
 
 
-    /**
-     * Gets the annotation reader
-     */
-    protected function getAnnotationReader(): Reader
-    {
-        return $this->annotationReader ?: new AnnotationReader();
-    }
-
 
     /**
      * Gets the EntityManager.
@@ -188,35 +178,37 @@ public function setAnnotationReader(Reader $annotationReader): void
      */
     public function addFilterConstraint(ClassMetadata $targetEntity, $targetTableAlias)
     {
-        // Get our multi-tenancy annotation from the class
-        $multiTenancy = $this->getAnnotationReader()->getClassAnnotation(
-            $targetEntity->reflClass,
-            MultiTenancy::class,
-        );
+        $attributes = $targetEntity->reflClass->getAttributes(MultiTenancy::class);
 
-        // We get null if the annotation hasn't been defined. That's an issue since, for security
-        // reasons, we want to ensure that the entity has explicitly been disabled for multi-tenancy.
-        if (!$multiTenancy instanceof MultiTenancy) {
-            throw new \LogicException(sprintf(
-                '%s must have the MultiTenancy annotation added to the class docblock.',
+        // If no attributes have been defined, this is an issue. For security reasons, we want
+        // to ensure that the entity has explicitly been disabled for multi-tenancy.
+        if (count($attributes) === 0) {
+            throw new AttributeException(sprintf(
+                '%s must have the MultiTenancy attribute added to the class docblock.',
                 $targetEntity->rootEntityName,
             ));
         }
 
+        $multiTenancy = $attributes[0]->newInstance();
+        assert($multiTenancy instanceof MultiTenancy);
+
         if (!$multiTenancy->isEnabled()) {
             return '';
         }
 
         $filters = $multiTenancy->getFilters();
         if (!$filters) {
-            throw new \LogicException(sprintf(
+            throw new AttributeException(sprintf(
                 '%s is enabled for MultiTenancy, but there were not any added filters.',
                 $targetEntity->rootEntityName,
             ));
         }
 
         $defaultMap = $this->getDefaultMap($targetTableAlias);
-        [$identifiers, $values] = $this->getMergedMaps($defaultMap, ...$this->getValueHolderIdentifiersAndValues());
+        [$identifiers, $values] = $this->getMergedMaps(
+            $defaultMap,
+            ...$this->getValueHolderIdentifiersAndValues(),
+        );
 
         $whereClauses = [];
         foreach ($filters as $filter) {