Skip to content
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

[5.x] Add empty/not empty field filters #11389

Open
wants to merge 1 commit into
base: 5.x
Choose a base branch
from
+155 −19
Open

[5.x] Add empty/not empty field filters #11389

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 7 additions & 1 deletion src/Query/Scopes/Filters/Fields/Date.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ public function fieldItems()
'<' => __('Before'),
'>' => __('After'),
'between' => __('Between'),
'null' => __('Empty'),
'not-null' => __('Not empty'),
],
],
'value' => [
Expand Down Expand Up @@ -54,7 +56,11 @@ public function apply($query, $handle, $values)

$value = Carbon::parse($values['value']);

$query->where($handle, $operator, $value);
match ($operator) {
'null' => $query->whereNull($handle),
'not-null' => $query->whereNotNull($handle),
default => $query->where($handle, $operator, $value),
};
}

public function badge($values)
Expand Down
14 changes: 13 additions & 1 deletion src/Query/Scopes/Filters/Fields/Entries.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,18 @@ public function fieldItems()
'like' => __('Contains'),
'=' => __('Is'),
'!=' => __('Isn\'t'),
'null' => __('Empty'),
'not-null' => __('Not empty'),
],
'default' => 'like',
],
'value' => [
'type' => 'text',
'placeholder' => __('Value'),
'if' => [
'operator' => 'not empty',
'operator' => 'contains_any like, =, !=',
],
'required' => false,
],
];
}
Expand All @@ -45,6 +48,15 @@ public function apply($query, $handle, $values)
$operator = $values['operator'];
$value = $values['value'];

if (in_array($operator, ['null', 'not-null'])) {
match ($operator) {
'null' => $query->whereNull($handle),
'not-null' => $query->whereNotNull($handle),
};

return;
}

if ($operator === 'like') {
$value = Str::ensureLeft($value, '%');
$value = Str::ensureRight($value, '%');
Expand Down
11 changes: 9 additions & 2 deletions src/Query/Scopes/Filters/Fields/FieldtypeFilter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,18 @@ public function fieldItems()
'like' => __('Contains'),
'=' => __('Is'),
'<>' => __('Isn\'t'),
'null' => __('Empty'),
'not-null' => __('Not empty'),
],
'default' => 'like',
],
'value' => [
'type' => 'text',
'placeholder' => __('Value'),
'if' => [
'operator' => 'not empty',
'operator' => 'contains_any like, =, <>',
],
'required' => false,
],
];
}
Expand All @@ -50,7 +53,11 @@ public function apply($query, $handle, $values)
$value = Str::ensureRight($value, '%');
}

$query->where($handle, $operator, $value);
match ($operator) {
'null' => $query->whereNull($handle),
'not-null' => $query->whereNotNull($handle),
default => $query->where($handle, $operator, $value),
};
}

public function badge($values)
Expand Down
10 changes: 8 additions & 2 deletions src/Query/Scopes/Filters/Fields/Number.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,16 @@ public function fieldItems()
'>=' => __('Greater than or equals'),
'<' => __('Less than'),
'<=' => __('Less than or equals'),
'null' => __('Empty'),
'not-null' => __('Not empty'),
],
'default' => '=',
],
'value' => [
'type' => $this->valueFieldtype(),
'placeholder' => __('Value'),
'if' => [
'operator' => 'not empty',
'operator' => 'contains_any <>, >, >=, <, <=, =',
],
],
];
Expand All @@ -39,7 +41,11 @@ public function apply($query, $handle, $values)
$operator = $values['operator'];
$value = $values['value'];

$query->where($handle, $operator, $value);
match ($operator) {
'null' => $query->whereNull($handle),
'not-null' => $query->whereNotNull($handle),
default => $query->where($handle, $operator, $value),
};
}

public function badge($values)
Expand Down
30 changes: 27 additions & 3 deletions src/Query/Scopes/Filters/Fields/Template.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,35 +2,59 @@

namespace Statamic\Query\Scopes\Filters\Fields;

use Statamic\Support\Arr;

class Template extends FieldtypeFilter
{
public function fieldItems()
{
return [
'operator' => [
'type' => 'select',
'placeholder' => __('Select Operator'),
'options' => [
'=' => __('Is'),
'<>' => __('Isn\'t'),
'null' => __('Empty'),
'not-null' => __('Not empty'),
],
'default' => '=',
],
'value' => [
'type' => 'template',
'if' => [
'operator' => 'contains_any <>, =',
],
'required' => false,
],
];
}

public function apply($query, $handle, $values)
{
$operator = $values['operator'];
$template = $values['value'];

$variations = [
str_replace('.', '/', $template),
str_replace('/', '.', $template),
];

$query->whereIn($handle, $variations);
match ($operator) {
'=' => $query->whereIn($handle, $variations),
'<>' => $query->whereNotIn($handle, $variations),
'null' => $query->whereNull($handle),
'not-null' => $query->whereNotNull($handle),
};
}

public function badge($values)
{
$field = $this->fieldtype->field()->display();
$operator = __('Is');
$operator = $values['operator'];
$translatedOperator = Arr::get($this->fieldItems(), "operator.options.{$operator}");
$value = $values['value'];

return strtolower($field).' '.strtolower($operator).' '.$value;
return $field.' '.strtolower($translatedOperator).' '.$value;
}
}
30 changes: 28 additions & 2 deletions src/Query/Scopes/Filters/Fields/Terms.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,29 +3,55 @@
namespace Statamic\Query\Scopes\Filters\Fields;

use Statamic\Facades;
use Statamic\Support\Arr;

class Terms extends FieldtypeFilter
{
public function fieldItems()
{
return [
'operator' => [
'type' => 'select',
'options' => [
'like' => __('Contains'),
'null' => __('Empty'),
'not-null' => __('Not empty'),
],
'default' => 'like',
],
'term' => [
'type' => 'select',
'options' => $this->options()->all(),
'placeholder' => __('Contains'),
'placeholder' => __('Term'),
'clearable' => true,
'if' => [
'operator' => 'contains_any like',
],
],
];
}

public function apply($query, $handle, $values)
{
$query->whereJsonContains($handle, $values['term']);
$operator = $values['operator'];

match ($operator) {
'like' => $query->whereJsonContains($handle, $values['term']),
'null' => $query->whereNull($handle),
'not-null' => $query->whereNotNull($handle),
};
}

public function badge($values)
{
$field = $this->fieldtype->field()->display();
$operator = $values['operator'];

if (in_array($operator, ['null', 'not-null'])) {
$translatedOperator = Arr::get($this->fieldItems(), "operator.options.{$operator}");

return $field.' '.strtolower($translatedOperator);
}

$id = $this->fieldtype->usingSingleTaxonomy()
? $this->fieldtype->taxonomies()[0].'::'.$values['term']
Expand Down
34 changes: 28 additions & 6 deletions src/Query/Scopes/Filters/Fields/Textarea.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,36 +2,58 @@

namespace Statamic\Query\Scopes\Filters\Fields;

use Statamic\Support\Arr;
use Statamic\Support\Str;

class Textarea extends FieldtypeFilter
{
public function fieldItems()
{
return [
'operator' => [
'type' => 'select',
'options' => [
'like' => __('Contains'),
'null' => __('Empty'),
'not-null' => __('Not empty'),
],
'default' => 'like',
],
'value' => [
'type' => 'text',
'placeholder' => __('Contains'),
'placeholder' => __('Value'),
'if' => [
'operator' => 'like',
],
'required' => false,
],
];
}

public function apply($query, $handle, $values)
{
$operator = $values['operator'];
$value = $values['value'];

$value = Str::ensureLeft($value, '%');
$value = Str::ensureRight($value, '%');
if ($operator === 'like') {
$value = Str::ensureLeft($value, '%');
$value = Str::ensureRight($value, '%');
}

$query->where($handle, 'like', $value);
match ($operator) {
'null' => $query->whereNull($handle),
'not-null' => $query->whereNotNull($handle),
default => $query->where($handle, $operator, $value),
};
}

public function badge($values)
{
$field = $this->fieldtype->field()->display();
$operator = __('Contains');
$operator = $values['operator'];
$translatedOperator = Arr::get($this->fieldItems(), "operator.options.{$operator}");
$value = $values['value'];

return strtolower($field).' '.strtolower($operator).' '.$value;
return $field.' '.strtolower($translatedOperator).' '.$value;
}
}
37 changes: 35 additions & 2 deletions src/Query/Scopes/Filters/Fields/User.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,48 @@
namespace Statamic\Query\Scopes\Filters\Fields;

use Statamic\Facades\User as Users;
use Statamic\Support\Arr;

class User extends FieldtypeFilter
{
public function fieldItems()
{
return [
'operator' => [
'type' => 'select',
'placeholder' => __('Select Operator'),
'options' => [
'=' => __('Is'),
'null' => __('Empty'),
'not-null' => __('Not empty'),
],
'default' => '=',
],
'value' => [
'type' => 'users',
'max_items' => 1,
'mode' => 'select',
'if' => [
'operator' => 'contains_any like, =, !=',
],
'required' => false,
],
];
}

public function apply($query, $handle, $values)
{
$operator = $values['operator'];

if (in_array($operator, ['null', 'not-null'])) {
match ($operator) {
'null' => $query->whereNull($handle),
'not-null' => $query->whereNotNull($handle),
};

return;
}

if (! $user = $values['value']) {
return;
}
Expand All @@ -30,12 +56,19 @@ public function apply($query, $handle, $values)

public function badge($values)
{
$field = $this->fieldtype->field()->display();
$operator = $values['operator'];

if (in_array($operator, ['null', 'not-null'])) {
$translatedOperator = Arr::get($this->fieldItems(), "operator.options.{$operator}");

return $field.' '.strtolower($translatedOperator);
}

if (! $user = $values['value']) {
return null;
}

$field = $this->fieldtype->field()->display();
$operator = __('Is');
$user = Users::find($user)->name();

return $field.' '.strtolower($operator).' '.$user;
Expand Down
Loading