Make deleted value configurable for SoftDeleteableFilter.php

Author: bartholdbos

src/Mapping/Annotation/SoftDeleteable.php

@@ -35,12 +35,12 @@ final class SoftDeleteable implements GedmoAnnotation
 
     public bool $hardDelete = true;
 
-    public $deletedValue = null;
+    public ?string $deletedValue = null;
 
     /**
      * @param array<string, mixed> $data
      */
-    public function __construct(array $data = [], string $fieldName = 'deletedAt', bool $timeAware = false, bool $hardDelete = true, $deletedValue = null)
+    public function __construct(array $data = [], string $fieldName = 'deletedAt', bool $timeAware = false, bool $hardDelete = true, ?string $deletedValue = null)
     {
         if ([] !== $data) {
             Deprecation::trigger(

src/SoftDeleteable/Mapping/Driver/Attribute.php

@@ -64,6 +64,10 @@ public function readExtendedMetadata($meta, array &$config)
             }
 
             if (isset($annot->deletedValue)) {
+                if (!is_string($annot->deletedValue)) {
+                    throw new InvalidMappingException('deletedValue must be string. '.gettype($annot->deletedValue).' provided.');
+                }
+
                 $config['deletedValue'] = $annot->deletedValue;
             }
         }

src/SoftDeleteable/Mapping/Driver/Xml.php

@@ -58,6 +58,11 @@ public function readExtendedMetadata($meta, array &$config)
                 if ($this->_isAttributeSet($xml->{'soft-deleteable'}, 'hard-delete')) {
                     $config['hardDelete'] = $this->_getBooleanAttribute($xml->{'soft-deleteable'}, 'hard-delete');
                 }
+
+                $config['deletedValue'] = null;
+                if ($this->_isAttributeSet($xml->{'soft-deleteable'}, 'deleted-value')) {
+                    $config['deletedValue'] = $this->_getAttribute($xml->{'soft-deleteable'}, 'deleted-value');
+                }
             }
         }
 

src/SoftDeleteable/Mapping/Driver/Yaml.php

@@ -70,6 +70,14 @@ public function readExtendedMetadata($meta, array &$config)
                     }
                     $config['hardDelete'] = $classMapping['soft_deleteable']['hard_delete'];
                 }
+
+                $config['deletedValue'] = null;
+                if (isset($classMapping['soft_deleteable']['deleted_value'])) {
+                    if (!is_string($classMapping['soft_deleteable']['deleted_value'])) {
+                        throw new InvalidMappingException('deletedValue must be string. ' . gettype($classMapping['soft_deleteable']['deleted_value']) . ' provided.');
+                    }
+                    $config['deletedValue'] = $classMapping['soft_deleteable']['deleted_value'];
+                }
             }
         }