Merge branch 'master' of github.com:kivitendo/kivitendo-erp
[kivitendo-erp.git] / SL / Controller / Helper / ParseFilter.pm
index ea4eba0..afe9b7b 100644 (file)
@@ -8,6 +8,7 @@ our @EXPORT = qw(parse_filter);
 use DateTime;
 use SL::Helper::DateTime;
 use List::MoreUtils qw(uniq);
+use SL::MoreCommon qw(listify);
 use Data::Dumper;
 
 my %filters = (
@@ -21,6 +22,7 @@ my %filters = (
 
 my %methods = (
   enable => sub { ;;;; },
+  eq_ignore_empty => sub { ($_[0] // '') eq '' ? () : +{ eq => $_[0] } },
   map {
     # since $_ is an alias it can't be used in a closure. even "".$_ or "$_"
     # does not work, we need a real copy.
@@ -32,13 +34,12 @@ my %methods = (
 sub parse_filter {
   my ($filter, %params) = @_;
 
-  my $hint_objects = $params{with_objects} || [];
-  my $auto_objects = [];
+  my $objects      = $params{with_objects} || [];
 
-  my ($flattened, $objects) = flatten($filter, $auto_objects, '', %params);
+  my ($flattened, $auto_objects) = flatten($filter, '', %params);
 
-  if ($params{class}) {
-    $objects = $hint_objects;
+  if (!$params{class}) {
+    _add_uniq($objects, $_) for @$auto_objects;
   }
 
   my $query = _parse_filter($flattened, $objects, %params);
@@ -69,19 +70,19 @@ sub _launder_keys {
 }
 
 sub flatten {
-  my ($filter, $with_objects, $prefix, %params) = @_;
+  my ($filter, $prefix, %params) = @_;
 
-  return (undef, $with_objects) unless 'HASH'  eq ref $filter;
-  $with_objects ||= [];
+  return (undef, []) unless 'HASH'  eq ref $filter;
+  my $with_objects = [];
 
   my @result;
 
   while (my ($key, $value) = each %$filter) {
     next if !defined $value || $value eq ''; # 0 is fine
     if ('HASH' eq ref $value) {
-      my ($query, $more_objects) = flatten($value, $with_objects, _prefix($prefix, $key));
-      push @result,        @$query if $query;
-      push @$with_objects, _prefix($prefix, $key), ($more_objects ? @$more_objects : ());
+      my ($query, $more_objects) = flatten($value, _prefix($prefix, $key));
+      push @result, @$query        if  $query;
+      _add_uniq($with_objects, $_) for _prefix($prefix, $key), @$more_objects;
     } else {
       push @result, _prefix($prefix, $key) => $value;
     }
@@ -105,7 +106,7 @@ sub _parse_filter {
     ($key, $value) = _apply_all($key, $value, qr/\b::(\w+)/, { %methods, %{ $params{methods} || {} } });
     ($key, $value) = _dispatch_custom_filters($params{class}, $with_objects, $key, $value) if $params{class};
 
-    push @result, $key, $value;
+    push @result, $key, $value if defined $key;
   }
   return \@result;
 }
@@ -137,9 +138,9 @@ sub _dispatch_custom_filters {
 
   if ($manager->can('filter')) {
     ($key, $value, my $obj) = $manager->filter($last_token, $value, $obj_prefix);
-    _add_uniq($with_objects, $obj);
+    _add_uniq($with_objects, $obj) if $obj;
   } else {
-    _add_uniq($with_objects, $obj_path);
+    _add_uniq($with_objects, $obj_path) if $obj_path;
   }
 
   return ($key, $value);
@@ -149,7 +150,7 @@ sub _add_uniq {
    my ($array, $what) = @_;
 
    $array //= [];
-   $array = [ uniq @$array, $what ];
+   @$array = (uniq @$array, listify($what));
 }
 
 sub _collapse_indirect_filters {
@@ -383,6 +384,11 @@ Adds "%" at the end of the string.
 
 Adds "% .. %" around the search string.
 
+=item eq_ignore_empty
+
+Ignores this item if it's empty. Otherwise compares it with the
+standard SQL C<=> operator.
+
 =back
 
 =head2 METHODS (leading with ::)