Skip to content

FOUR-16161: Add support for raw query conditions to advanced filters #6876

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
nolanpro merged 5 commits into from
Jun 18, 2024
Merged

FOUR-16161: Add support for raw query conditions to advanced filters #6876

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
39f5c94
Adding support for raw() filter
runyan-co May 23, 2024
27f7ab4
Refactored raw() special filter to its own trait and finished busines…
runyan-co May 24, 2024
6ded797
Add raw filter test
nolanpro May 24, 2024
15eedec
Updated to replace regex matching with string manipulation; Removed s…
runyan-co May 29, 2024
74e0c7f
Merge branch 'improvement/FOUR-16161' of https://github.com/ProcessMa…
runyan-co May 29, 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
Next Next commit
Adding support for raw() filter
  • Loading branch information
@runyan-co
runyan-co committed May 23, 2024
commit 39f5c943a7b7a42a2d9d35062bff85a7692e0ed0
81 changes: 55 additions & 26 deletions ProcessMaker/Filters/Filter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,28 @@

namespace ProcessMaker\Filters;

use Illuminate\Support\Str;
use Illuminate\Support\Facades\DB;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Support\Arr;
use ProcessMaker\Models\ProcessRequestToken;
use ProcessMaker\Models\User;
use ProcessMaker\Query\BaseField;
use ProcessMaker\Query\Expression;

class Filter
{
const TYPE_PARTICIPANTS = 'Participants';
public const TYPE_PARTICIPANTS = 'Participants';

const TYPE_PARTICIPANTS_FULLNAME = 'ParticipantsFullName';
public const TYPE_PARTICIPANTS_FULLNAME = 'ParticipantsFullName';

const TYPE_ASSIGNEES_FULLNAME = 'AssigneesFullName';
public const TYPE_ASSIGNEES_FULLNAME = 'AssigneesFullName';

const TYPE_STATUS = 'Status';
public const TYPE_STATUS = 'Status';

const TYPE_FIELD = 'Field';
public const TYPE_FIELD = 'Field';

const TYPE_PROCESS = 'Process';
public const TYPE_PROCESS = 'Process';

const TYPE_RELATIONSHIP = 'Relationship';
public const TYPE_RELATIONSHIP = 'Relationship';

public string|null $subjectValue;

Expand All @@ -33,6 +33,8 @@ class Filter

public $value;

protected bool $usesRawValue = false;

public array $or;

public array $operatorWhitelist = [
Expand All @@ -49,7 +51,17 @@ class Filter
'starts_with',
];

public static function filter(Builder $query, string|array $filterDefinitions)
public function __construct($definition)
{
$this->subjectType = $definition['subject']['type'];
$this->subjectValue = Arr::get($definition, 'subject.value');
$this->operator = $definition['operator'];
$this->value = $definition['value'];
$this->usesRawValue = $this->containsRawValue($this->value ?? '');
$this->or = Arr::get($definition, 'or', []);
}

public static function filter(Builder $query, string|array $filterDefinitions): void
{
if (is_string($filterDefinitions)) {
$filterDefinitions = json_decode($filterDefinitions, true);
Expand All @@ -66,26 +78,39 @@ public static function filter(Builder $query, string|array $filterDefinitions)
});
}

public function __construct($definition)
{
$this->subjectType = $definition['subject']['type'];
$this->subjectValue = Arr::get($definition, 'subject.value');
$this->operator = $definition['operator'];
$this->value = $definition['value'];
$this->or = Arr::get($definition, 'or', []);
}

public function addToQuery(Builder $query)
public function addToQuery(Builder $query): void
{
if (!empty($this->or)) {
$query->where(function ($query) {
$this->apply($query);
});
$query->where(fn ($query) => $this->apply($query));
} else {
$this->apply($query);
}
}

/**
* Use regex to find the raw() pattern and extract its content
*
* @param string|null $value
*
* @return string
*/
public function getRawValue(string $value = null): string
{
return Str::match('/(?<=raw\().*(?=\))/', $value ?? $this->value);
}

/**
* Determine if the value is using the raw() function
*
* @param string $value
*
* @return bool
*/
public function containsRawValue(string $value): bool
{
return Str::contains($value, 'raw(');
}

private function apply($query)
{
if ($valueAliasMethod = $this->valueAliasMethod()) {
Expand Down Expand Up @@ -212,7 +237,7 @@ private function subject()
return $this->subjectValue;
}

private function relationshipSubjectTypeParts()
private function relationshipSubjectTypeParts(): array
{
return explode('.', $this->subjectValue);
}
Expand All @@ -227,6 +252,10 @@ private function value()
return $this->value . '%';
}

if ($this->usesRawValue) {
return DB::raw($this->getRawValue());
}

return $this->value;
}

Expand Down Expand Up @@ -261,13 +290,13 @@ private function valueAliasMethod()
private function valueAliasAdapter(string $method, Builder $query)
{
$operator = $this->operator();

if ($operator === 'in') {
$operator = '=';
}
$values = (array) $this->value();

$values = (array) $this->value();
$expression = (object) ['operator' => $operator];

$model = $query->getModel();

if ($method === 'valueAliasParticipant') {
Expand Down