Merge pull request #4 from nuxtifyts/feature/cipher-targets

Added cipher targets

Author: Fa-BRAIK

.github/workflows/pr-label-check.yml

@@ -12,18 +12,7 @@ jobs:
         uses: actions/github-script@v6
         with:
           script: |
-            const labels = context.payload.pull_request.labels;
+            const labels = context.payload.pull_request?.labels || [];
             if (labels.length === 0) {
               throw new Error('This pull request must have at least one label.');
             }
-      - name: Comment on missing labels
-        if: failure()
-        uses: actions/github-script@v6
-        with:
-            script: |
-              github.issues.createComment({
-                issue_number: context.issue.number,
-                owner: context.repo.owner,
-                repo: context.repo.repo,
-                body: 'This pull request must have at least one label.'
-              })

composer.json

@@ -10,7 +10,8 @@
         }
     ],
     "require": {
-        "php": "~8.4"
+        "php": "~8.4",
+        "ext-openssl": "*"
     },
     "require-dev": {
         "phpstan/phpstan": "^2.0",

composer.lock

@@ -4,6 +4,7 @@ Property Attributes
 In order to provide more functionality to your DTOs, you can use the following attributes:
 - [Computed](#Computed) - To define a property that is computed from other properties.
 - [Aliases](#Aliases) - To define aliases for a property.
+- [CipherTarget](#CipherTarget) - To define a property that should be encrypted/decrypted.
 
 Computed
 -
@@ -46,10 +47,65 @@ final readonly class Person extends Data
     public function __construct(
         #[Aliases('first_name')]
         public string $firstName,
-        #[Aliases('last_name')]
+        #[Aliases('last_name', 'family_name')]
         public string $lastName   
     ) {}
 }
 ```
 
 This will make it possible to hydrate properties from multiple array keys.
+
+CipherTarget
+-
+
+Sometimes, we may need to specify that some properties are considered sensitive, and should be
+handled carefully, especially when saving it. 
+
+For this we can use encryption/decryption using the `CipherTarget` attribute.
+
+```php
+use Nuxtifyts\PhpDto\Data;
+use Nuxtifyts\PhpDto\Attributes\Property\Types\ArrayOfData;
+use Nuxtifyts\PhpDto\Attributes\Property\CipherTarget;
+
+final readonly class User extends Data
+{
+    /** 
+     * @param list<UserConfigData> $userConfigs
+     */
+    public function __construct(
+        #[ArrayOfData(UserConfigData::class)]
+        #[CipherTarget(
+            secret: 'user-configs-secret-key', // By default, it uses the class name
+            encoded: true // By default, it does not perform encoding
+        )]
+        public array $userConfigs
+    ) {}
+}
+
+```
+
+it is also possible to specify a custom DataCipher for the property,
+the new class should implement the `Nuxtifyts\PhpDto\DataCipher` interface.
+
+```php
+
+use Nuxtifyts\PhpDto\DataCiphers\DataCipher;
+
+class CustomDataCipher implements DataCipher
+{
+    // Implement the interface
+}
+```
+
+Then you can specify the custom DataCipher in the `CipherTarget` attribute.
+
+```php
+public function __construct(
+    #[CipherTarget(
+        dataCipherClass: CustomDataCipher::class,
+    )]
+    public UserConfigData $userConfig
+) {}
+```
+

docs/PropertyAttributes.md

@@ -8,7 +8,7 @@
 class Aliases
 {
     /** @var list<string> */
-    private(set) array $aliases;
+    protected(set) array $aliases;
 
     public function __construct(
         string $alias,

src/Attributes/Property/Aliases.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Nuxtifyts\PhpDto\Attributes\Property;
+
+use Attribute;
+use Nuxtifyts\PhpDto\DataCiphers\DataCipher;
+
+#[Attribute(Attribute::TARGET_PROPERTY)]
+class CipherTarget
+{
+    /**
+     * @param class-string<DataCipher> $dataCipherClass
+     */
+    public function __construct(
+        protected(set) string $dataCipherClass = DataCipher::class,
+        protected(set) string $secret = '',
+        protected(set) bool $encoded = false
+    ) {
+    }
+}

src/Attributes/Property/CipherTarget.php

@@ -11,13 +11,13 @@
 class ArrayOfBackedEnums
 {
     /** @var array<string, ReflectionEnum<BackedEnum>> */
-    private static array $_enumReflections = [];
+    protected static array $_enumReflections = [];
 
     /** @var list<class-string<BackedEnum>> $enums */
-    private(set) array $enums;
+    protected(set) array $enums;
 
     /** @var array<string, ReflectionEnum<BackedEnum>> */
-    private(set) array $resolvedBackedEnumReflections = [];
+    protected(set) array $resolvedBackedEnumReflections = [];
 
     /**
      * @param class-string<BackedEnum>|list<class-string<BackedEnum>> $enums

src/Attributes/Property/Types/ArrayOfBackedEnums.php

@@ -13,13 +13,13 @@
 class ArrayOfData
 {
     /** @var array<string, ReflectionClass<Data>> */
-    private static array $_dataReflections = [];
+    protected static array $_dataReflections = [];
 
     /** @var list<class-string<Data>> */
-    private(set) array $dataClasses;
+    protected(set) array $dataClasses;
 
     /** @var array<string, ReflectionClass<Data>> */
-    private(set) array $resolvedDataReflections = [];
+    protected(set) array $resolvedDataReflections = [];
 
     /**
      * @param class-string<Data>|list<class-string<Data>> $dataClasses

src/Attributes/Property/Types/ArrayOfData.php

@@ -14,13 +14,13 @@
 class ArrayOfDateTimes
 {
     /** @var array<string, ReflectionClass<DateTime|DateTimeImmutable>> */
-    private static array $_dateTimeReflections = [];
+    protected static array $_dateTimeReflections = [];
 
     /** @var list<class-string<DateTime|DateTimeImmutable>> */
-    private(set) array $dateTimes;
+    protected(set) array $dateTimes;
 
     /** @var array<string, ReflectionClass<DateTime|DateTimeImmutable>> */
-    private(set) array $resolvedDateTimeReflections = [];
+    protected(set) array $resolvedDateTimeReflections = [];
 
     /**
      * @param class-string<DateTime|DateTimeImmutable>|list<class-string<DateTime|DateTimeImmutable>> $dateTimes

src/Attributes/Property/Types/ArrayOfDateTimes.php

@@ -10,7 +10,7 @@
 class ArrayOfScalarTypes
 {
     /** @var list<Type> $types */
-    private(set) array $types;
+    protected(set) array $types;
 
     /**
      * @param Type|list<Type> $types