Merge pull request #90 from cergey-obr/attribute-support

Added support for php attributes, new loader

.github/workflows/run-tests.yml

@@ -17,7 +17,7 @@ jobs:
 
     strategy:
       matrix:
-        php: [7.4, 8.0, 8.1]
+        php: [8.0, 8.1]
         dependency-version: [prefer-lowest, prefer-stable]
 
     name: P${{ matrix.php }} - ${{ matrix.dependency-version }}

README.md

@@ -12,6 +12,8 @@ Use composer to add DMS\Filter to your app
 
 ## Usage
 
+### Annotation way
+
 Your Entity:
 
 ```php
@@ -81,6 +83,60 @@ Filtering:
 
 Full example: https://gist.github.com/1098352
 
+### Attribute way
+
+Your Entity:
+
+```php
+<?php
+
+namespace App\Entity;
+
+//Import Attributes
+use DMS\Filter\Rules as Filter;
+
+class User
+{
+    #[Filter\StripTags]
+    #[Filter\Trim]
+    #[Filter\StripNewlines]
+    public string $name;
+
+    #[Filter\StripTags]
+    #[Filter\Trim]
+    #[Filter\StripNewlines]
+    public string $email;
+}
+?>
+```
+
+Filtering:
+```php
+<?php
+    //Load AttributeLoader
+    $loader = new Mapping\Loader\AttributeLoader();
+    $this->loader = $loader;
+
+    //Get a MetadataFactory
+    $metadataFactory = new Mapping\ClassMetadataFactory($loader);
+
+    //Get a Filter
+    $filter = new DMS\Filter\Filter($metadataFactory);
+
+
+    //Get your Entity
+    $user = new App\Entity\User();
+    $user->name = "My <b>name</b>";
+    $user->email = " [email protected]";
+
+    //Filter you entity
+    $filter->filter($user);
+
+    echo $user->name; //"My name"
+    echo $user->email; //"[email protected]"
+?>
+```
+
 ## Dependencies
 
 This package relies on these external libraries:

composer.json

@@ -14,7 +14,7 @@
     ],
 
     "require": {
-        "php": "^7.4 || ~8.0 || ~8.1",
+        "php": "~8.0 || ~8.1",
         "doctrine/annotations": "^1.13",
         "laminas/laminas-zendframework-bridge": "^1.0"
     },

src/DMS/Filter/Mapping/Loader/AttributeLoader.php

@@ -0,0 +1,32 @@
+<?php
+declare(strict_types=1);
+
+namespace DMS\Filter\Mapping\Loader;
+
+use DMS\Filter\Mapping\ClassMetadataInterface;
+use DMS\Filter\Rules\Rule;
+use ReflectionAttribute;
+use ReflectionProperty;
+
+class AttributeLoader implements LoaderInterface
+{
+    public function loadClassMetadata(ClassMetadataInterface $metadata): bool
+    {
+        foreach ($metadata->getReflectionClass()->getProperties() as $property) {
+            $this->readProperty($property, $metadata);
+        }
+
+        return true;
+    }
+
+    private function readProperty(ReflectionProperty $property, ClassMetadataInterface $metadata): void
+    {
+        if ($property->getDeclaringClass()->getName() !== $metadata->getClassName()) {
+            return;
+        }
+
+        foreach ($property->getAttributes(Rule::class, ReflectionAttribute::IS_INSTANCEOF) as $attribute) {
+            $metadata->addPropertyRule($property->getName(), $attribute->newInstance());
+        }
+    }
+}

src/DMS/Filter/Rules/Alnum.php

@@ -8,6 +8,7 @@
  *
  * @Annotation
  */
+#[\Attribute]
 class Alnum extends RegExp
 {
     /**

src/DMS/Filter/Rules/Alpha.php

@@ -8,6 +8,7 @@
  *
  * @Annotation
  */
+#[\Attribute]
 class Alpha extends RegExp
 {
     /**

src/DMS/Filter/Rules/BooleanScalar.php

@@ -8,6 +8,7 @@
  *
  * @Annotation
  */
+#[\Attribute]
 class BooleanScalar extends Rule
 {
 }

src/DMS/Filter/Rules/Callback.php

@@ -14,6 +14,7 @@
  *
  * @Annotation
  */
+#[\Attribute]
 class Callback extends Rule
 {
     public const SELF_METHOD_TYPE = 'self_method';

src/DMS/Filter/Rules/Digits.php

@@ -8,6 +8,7 @@
  *
  * @Annotation
  */
+#[\Attribute]
 class Digits extends RegExp
 {
     /**

src/DMS/Filter/Rules/FloatScalar.php

@@ -9,6 +9,7 @@
  *
  * @Annotation
  */
+#[\Attribute]
 class FloatScalar extends Rule
 {
 }

src/DMS/Filter/Rules/HtmlEntities.php

@@ -10,6 +10,7 @@
  *
  * @Annotation
  */
+#[\Attribute]
 class HtmlEntities extends Rule
 {
     /**

src/DMS/Filter/Rules/IntScalar.php

@@ -9,6 +9,7 @@
  *
  * @Annotation
  */
+#[\Attribute]
 class IntScalar extends Rule
 {
 }

src/DMS/Filter/Rules/Laminas.php

@@ -10,6 +10,7 @@
  *
  * @Annotation
  */
+#[\Attribute]
 class Laminas extends Rule
 {
     /**

src/DMS/Filter/Rules/PregReplace.php

@@ -10,6 +10,7 @@
  *
  * @Annotation
  */
+#[\Attribute]
 class PregReplace extends Rule
 {
     /**

src/DMS/Filter/Rules/RegExp.php

@@ -10,6 +10,7 @@
  *
  * @Annotation
  */
+#[\Attribute]
 class RegExp extends Rule
 {
     /**

src/DMS/Filter/Rules/StripNewlines.php

@@ -8,6 +8,7 @@
  *
  * @Annotation
  */
+#[\Attribute]
 class StripNewlines extends Rule
 {
 }

src/DMS/Filter/Rules/StripTags.php

@@ -8,6 +8,7 @@
  *
  * @Annotation
  */
+#[\Attribute]
 class StripTags extends Rule
 {
     /**

src/DMS/Filter/Rules/ToLower.php

@@ -8,6 +8,7 @@
  *
  * @Annotation
  */
+#[\Attribute]
 class ToLower extends Rule
 {
     /**

src/DMS/Filter/Rules/ToUpper.php

@@ -8,6 +8,7 @@
  *
  * @Annotation
  */
+#[\Attribute]
 class ToUpper extends Rule
 {
     /**

src/DMS/Filter/Rules/Trim.php

@@ -8,6 +8,7 @@
  *
  * @Annotation
  */
+#[\Attribute]
 class Trim extends Rule
 {
     /**

src/DMS/Filter/Rules/Zend.php

@@ -12,6 +12,7 @@
  *
  * @Annotation
  */
+#[\Attribute]
 class Zend extends Rule
 {
     /**