Skip to content

8225: Adding a checkbox to StringFilterForm to control whether an empty value should cause the filter to be skipped #8781

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
BenedekFarkas merged 6 commits into from
Apr 17, 2024
Merged

8225: Adding a checkbox to StringFilterForm to control whether an empty value should cause the filter to be skipped #8781

Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
175408e
Adding a checkbox to StringFilterForm to control whether an empty val…
BenedekFarkas Apr 10, 2024
d258204
Removing StringOperator.ContainsAnyIfProvided as its now obsolete due…
BenedekFarkas Apr 10, 2024
d4fea2b
Merge branch '1.10.x' into issue/8225
BenedekFarkas Apr 16, 2024
c9f3330
Code styling in StringFilterForm
BenedekFarkas Apr 16, 2024
9481a66
Adding missing T-string
BenedekFarkas Apr 16, 2024
f3732f9
Adding migration step to upgrade from using the ContainsAnyIfProvided…
BenedekFarkas Apr 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 15 additions & 22 deletions src/Orchard.Web/Modules/Orchard.Projections/FilterEditors/Forms/StringFilterForm.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,14 @@ public void Describe(DescribeContext context) {
Title: T("Value"),
Classes: new[] { "text medium", "tokenized" },
Description: T("Enter the value the string should be.")
)
);
),
_IgnoreIfEmptyValue: Shape.Checkbox(
Id: "IgnoreFilterIfValueIsEmpty",
Name: "IgnoreFilterIfValueIsEmpty",
Title: "Ignore filter if value is empty",
Comment thread
BenedekFarkas marked this conversation as resolved.
Outdated
Description: T("When enabled, the filter will not be applied if the provided value is or evaluates to empty."),
Value: "true"
));

f._Operator.Add(new SelectListItem { Value = Convert.ToString(StringOperator.Equals), Text = T("Is equal to").Text });
f._Operator.Add(new SelectListItem { Value = Convert.ToString(StringOperator.NotEquals), Text = T("Is not equal to").Text });
Expand All @@ -49,10 +55,6 @@ public void Describe(DescribeContext context) {
f._Operator.Add(new SelectListItem { Value = Convert.ToString(StringOperator.Ends), Text = T("Ends with").Text });
f._Operator.Add(new SelectListItem { Value = Convert.ToString(StringOperator.NotEnds), Text = T("Does not end with").Text });
f._Operator.Add(new SelectListItem { Value = Convert.ToString(StringOperator.NotContains), Text = T("Does not contain").Text });
f._Operator.Add(new SelectListItem {
Value = Convert.ToString(StringOperator.ContainsAnyIfProvided),
Text = T("Contains any word (if any is provided)").Text
});

return f;
};
Expand All @@ -65,6 +67,11 @@ public static Action<IHqlExpressionFactory> GetFilterPredicate(dynamic formState
var op = (StringOperator)Enum.Parse(typeof(StringOperator), Convert.ToString(formState.Operator));
object value = Convert.ToString(formState.Value);

if (bool.TryParse(formState.IgnoreFilterIfValueIsEmpty?.ToString() ?? "", out bool ignoreIfEmpty)
&& ignoreIfEmpty
&& string.IsNullOrWhiteSpace(value as string))
return (ex) => { };

switch (op) {
case StringOperator.Equals:
return x => x.Eq(property, value);
Expand Down Expand Up @@ -92,14 +99,6 @@ public static Action<IHqlExpressionFactory> GetFilterPredicate(dynamic formState
return y => y.Not(x => x.Like(property, Convert.ToString(value), HqlMatchMode.End));
case StringOperator.NotContains:
return y => y.Not(x => x.Like(property, Convert.ToString(value), HqlMatchMode.Anywhere));
case StringOperator.ContainsAnyIfProvided:
if (string.IsNullOrWhiteSpace((string)value))
return x => x.IsNotEmpty("Id"); // basically, return every possible ContentItem
var values3 = Convert.ToString(value)
.Split(new[] { ' ' }, StringSplitOptions.RemoveEmptyEntries);
var predicates3 = values3.Skip(1)
.Select<string, Action<IHqlExpressionFactory>>(x => y => y.Like(property, x, HqlMatchMode.Anywhere)).ToArray();
return x => x.Disjunction(y => y.Like(property, values3[0], HqlMatchMode.Anywhere), predicates3);
default:
throw new ArgumentOutOfRangeException();
}
Expand Down Expand Up @@ -130,11 +129,6 @@ public static LocalizedString DisplayFilter(string fieldName, dynamic formState,
return T("{0} does not end with '{1}'", fieldName, value);
case StringOperator.NotContains:
return T("{0} does not contain '{1}'", fieldName, value);
case StringOperator.ContainsAnyIfProvided:
return T("{0} contains any of '{1}' (or '{1}' is empty)",
fieldName,
new LocalizedString(string.Join("', '",
value.Split(new[] { ' ' }, StringSplitOptions.RemoveEmptyEntries))));
default:
throw new ArgumentOutOfRangeException();
}
Expand All @@ -151,7 +145,6 @@ public enum StringOperator {
NotStarts,
Ends,
NotEnds,
NotContains,
ContainsAnyIfProvided
NotContains
}
}
}