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 ?string $deletedValue = null;
+    public ?string $nonDeletedColumnValue = null;
 
     /**
      * @param array<string, mixed> $data
      */
-    public function __construct(array $data = [], string $fieldName = 'deletedAt', bool $timeAware = false, bool $hardDelete = true, ?string $deletedValue = null)
+    public function __construct(array $data = [], string $fieldName = 'deletedAt', bool $timeAware = false, bool $hardDelete = true, ?string $nonDeletedColumnValue = null)
     {
         if ([] !== $data) {
             Deprecation::trigger(
@@ -55,14 +55,14 @@ public function __construct(array $data = [], string $fieldName = 'deletedAt', b
             $this->fieldName = $this->getAttributeValue($data, 'fieldName', $args, 1, $fieldName);
             $this->timeAware = $this->getAttributeValue($data, 'timeAware', $args, 2, $timeAware);
             $this->hardDelete = $this->getAttributeValue($data, 'hardDelete', $args, 3, $hardDelete);
-            $this->deletedValue = $this->getAttributeValue($data, 'deletedValue', $args, 4, $deletedValue);
+            $this->nonDeletedColumnValue = $this->getAttributeValue($data, 'nonDeletedColumnValue', $args, 4, $nonDeletedColumnValue);
 
             return;
         }
 
         $this->fieldName = $fieldName;
         $this->timeAware = $timeAware;
         $this->hardDelete = $hardDelete;
-        $this->deletedValue = $deletedValue;
+        $this->nonDeletedColumnValue = $nonDeletedColumnValue;
     }
 }

src/SoftDeleteable/Filter/SoftDeleteableFilter.php

@@ -70,7 +70,7 @@ public function addFilterConstraint(ClassMetadata $targetEntity, $targetTableAli
 
         $column = $quoteStrategy->getColumnName($config['fieldName'], $targetEntity, $platform);
 
-        $addCondSql = $targetTableAlias.'.'.$column.' '.(isset($config['deletedValue']) ? '= '.$config['deletedValue'] : 'IS NULL');
+        $addCondSql = $targetTableAlias.'.'.$column.' '.(isset($config['nonDeletedColumnValue']) ? '= '.$config['nonDeletedColumnValue'] : 'IS NULL');
         if (isset($config['timeAware']) && $config['timeAware']) {
             $addCondSql = "({$addCondSql} OR {$targetTableAlias}.{$column} > {$platform->getCurrentTimestampSQL()})";
         }

src/SoftDeleteable/Mapping/Driver/Attribute.php

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

src/SoftDeleteable/Mapping/Driver/Xml.php

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

src/SoftDeleteable/Mapping/Driver/Yaml.php

@@ -71,12 +71,12 @@ public function readExtendedMetadata($meta, array &$config)
                     $config['hardDelete'] = $classMapping['soft_deleteable']['hard_delete'];
                 }
 
-                $config['deletedValue'] = null;
+                $config['nonDeletedColumnValue'] = 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.');
+                        throw new InvalidMappingException('nonDeletedColumnValue must be string. '.gettype($classMapping['soft_deleteable']['deleted_value']).' provided.');
                     }
-                    $config['deletedValue'] = $classMapping['soft_deleteable']['deleted_value'];
+                    $config['nonDeletedColumnValue'] = $classMapping['soft_deleteable']['non_deleted_column_value'];
                 }
             }
         }