Merge pull request #20 from river0825/T2267-feature-user-auto-transform

feat(customizable): add autoTransform functionality to parseValue methods

Author: river0825

Dockerfile

@@ -1,5 +1,5 @@
 ARG PHP_EXTENSIONS="pdo_sqlite intl"
-FROM thecodingmachine/php:8.0-v4-slim-apache AS php
+FROM thecodingmachine/php:8.1-v4-slim-apache AS php
 
 USER root
 
@@ -16,4 +16,4 @@ RUN sudo mv phive.phar /usr/local/bin/phive
 
 USER docker
 
-RUN phive install --force-accept-unsigned --trust-gpg-keys 67F861C3D889C656 phpDocumentor
+RUN echo 'y' | phive install --force-accept-unsigned --trust-gpg-keys 67F861C3D889C656 phpDocumentor

docker-compose.yml

@@ -1,5 +1,3 @@
-version: '3.4'
-
 services:
   php:
     build: .

src/Concerns/Customizable.php

@@ -18,6 +18,11 @@ trait Customizable
 {
     protected array $validatedCustomFieldValues = [];
 
+    protected function isAutoTransform(): bool
+    {
+        return false;
+    }
+
     /**
      * Boot Model Observer.
      */
@@ -51,7 +56,7 @@ public function validateCustomFields(): void
             return;
         }
         $customFieldsRules = $customFields->flatMap(function (CustomField $field) {
-            return $field->getValidationRule();
+            return $field->getValidationRule($this->isAutoTransform());
         })->all();
         $validator = Validator::make($unvalidatedCustomFields, $customFieldsRules);
         $this->validatedCustomFieldValues = $validator->validate();
@@ -130,7 +135,7 @@ public function loadCustomFieldValues(): void
 
         $this->customFieldValues->each(function (CustomFieldValue $customFieldValue) {
             $attribute = "custom_{$customFieldValue->customField->key}";
-            $this->setAttribute($attribute, $customFieldValue->customField->parseValue($customFieldValue->value));
+            $this->setAttribute($attribute, $customFieldValue->customField->parseValue($customFieldValue->value, $this->isAutoTransform()));
         });
     }
 

src/Models/BooleanCustomField.php

@@ -8,7 +8,7 @@ class BooleanCustomField extends CustomField
 {
     use HasParent;
 
-    public function getValidationRule(): array
+    public function getValidationRule($autoTransform = false): array
     {
         $rules = ['boolean'];
         $rules[] = $this->required ? 'required' : 'nullable';
@@ -17,7 +17,7 @@ public function getValidationRule(): array
         ];
     }
 
-    public function parseValue($value): bool
+    public function parseValue($value, $autoTransform = false): bool
     {
         return filter_var($value, FILTER_VALIDATE_BOOLEAN);
     }

src/Models/CustomField.php

@@ -64,12 +64,12 @@ public function values(): HasMany
         return $this->hasMany(CustomFieldValue::class);
     }
 
-    public function getValidationRule(): array
+    public function getValidationRule($autoTransform = false): array
     {
         return [];
     }
 
-    public function parseValue($value): mixed
+    public function parseValue($value, $autoTransform = false): mixed
     {
         return $value;
     }

src/Models/DateTimeCustomField.php

@@ -9,15 +9,15 @@ class DateTimeCustomField extends CustomField
 {
     use HasParent;
 
-    public function getValidationRule(): array
+    public function getValidationRule($autoTransform = false): array
     {
         $rules = ['date'];
         $rules[] = $this->required ? 'required' : 'nullable';
         return [
             $this->key => $rules,
         ];
     }
-    public function parseValue($value): string
+    public function parseValue($value, $autoTransform = false): string
     {
         return Carbon::parse($value)->toDateTimeString();
     }

src/Models/FloatCustomField.php

@@ -8,7 +8,7 @@ class FloatCustomField extends CustomField
 {
     use HasParent;
 
-    public function getValidationRule(): array
+    public function getValidationRule($autoTransform = false): array
     {
         $rules = ['numeric'];
         $rules[] = $this->required ? 'required' : 'nullable';
@@ -17,9 +17,8 @@ public function getValidationRule(): array
         ];
     }
 
-    public function parseValue($value): float
+    public function parseValue($value, $autoTransform = false): float
     {
         return (float) $value;
     }
-
 }

src/Models/IntegerCustomField.php

@@ -8,7 +8,7 @@ class IntegerCustomField extends CustomField
 {
     use HasParent;
 
-    public function getValidationRule(): array
+    public function getValidationRule($autoTransform = false): array
     {
         $rules = ['integer'];
         $rules[] = $this->required ? 'required' : 'nullable';
@@ -17,9 +17,8 @@ public function getValidationRule(): array
         ];
     }
 
-    public function parseValue($value): int
+    public function parseValue($value, $autoTransform = false): int
     {
         return (int) $value;
     }
-
 }

src/Models/SelectCustomField.php

@@ -9,7 +9,7 @@ class SelectCustomField extends CustomField
 {
     use HasParent;
 
-    public function getValidationRule(): array
+    public function getValidationRule($autoTransform = false): array
     {
         $options = $this->available_options->pluck('value')->toArray();
         $rules = [Rule::in($options)];
@@ -18,7 +18,7 @@ public function getValidationRule(): array
             $this->key => $rules,
         ];
     }
-    public function parseValue($value): string
+    public function parseValue($value, $autoTransform = false): string
     {
         return $value;
     }

src/Models/TextCustomField.php

@@ -8,17 +8,24 @@ class TextCustomField extends CustomField
 {
     use HasParent;
 
-    public function getValidationRule(): array
+    public function getValidationRule($autoTransform = false): array
     {
-        $rules = ['string'];
+        if (!$autoTransform) {
+            $rules = ['string'];
+        }
+
         $rules[] = $this->required ? 'required' : 'nullable';
         return [
             $this->key => $rules,
         ];
     }
 
-    public function parseValue($value): string
+    public function parseValue($value, $autoTransform = false): string
     {
+        if ($autoTransform) {
+            return (string) $value;
+        }
+
         return $value;
     }
 }