|
| 1 | +<?php |
| 2 | + |
| 3 | +namespace ProcessMaker\Services; |
| 4 | + |
| 5 | +use InvalidArgumentException; |
| 6 | +use ProcessMaker\Contracts\ConditionalRedirectServiceInterface; |
| 7 | +use ProcessMaker\Managers\DataManager; |
| 8 | +use ProcessMaker\Models\Comment; |
| 9 | +use ProcessMaker\Models\FormalExpression; |
| 10 | +use ProcessMaker\Models\ProcessRequest; |
| 11 | +use ProcessMaker\Models\ProcessRequestToken; |
| 12 | + |
| 13 | +/** |
| 14 | + * ConditionalRedirectService |
| 15 | + * |
| 16 | + * This service handles the evaluation of conditional redirects in ProcessMaker workflows. |
| 17 | + * It processes a set of conditions and returns the first condition that evaluates to true, |
| 18 | + * along with its associated redirect configuration. |
| 19 | + * |
| 20 | + * The service uses FEEL (Friendly Enough Expression Language) expressions to evaluate |
| 21 | + * conditions against process data, allowing for dynamic routing based on runtime data. |
| 22 | + * |
| 23 | + * @package ProcessMaker\Services |
| 24 | + * @since 4.0.0 |
| 25 | + */ |
| 26 | +class ConditionalRedirectService implements ConditionalRedirectServiceInterface |
| 27 | +{ |
| 28 | + /** |
| 29 | + * @var FormalExpression |
| 30 | + */ |
| 31 | + private FormalExpression $feel; |
| 32 | + |
| 33 | + /** |
| 34 | + * @var DataManager |
| 35 | + */ |
| 36 | + private DataManager $dataManager; |
| 37 | + |
| 38 | + private array $errors = []; |
| 39 | + |
| 40 | + /** |
| 41 | + * Constructor |
| 42 | + * |
| 43 | + * Initializes the service with required dependencies for expression evaluation |
| 44 | + * and data management. |
| 45 | + */ |
| 46 | + public function __construct() |
| 47 | + { |
| 48 | + $this->feel = new FormalExpression(); |
| 49 | + $this->dataManager = new DataManager(); |
| 50 | + } |
| 51 | + |
| 52 | + /** |
| 53 | + * Process a set of conditional redirects and return the first condition that evaluates to true |
| 54 | + * |
| 55 | + * This method iterates through an array of conditional redirect configurations, |
| 56 | + * evaluating each condition using FEEL expressions against the provided data. |
| 57 | + * Returns the first condition that evaluates to true, or null if no conditions match. |
| 58 | + * |
| 59 | + * @param array $conditionalRedirect Array of conditional redirect configurations |
| 60 | + * Each item must contain a 'condition' key with a FEEL expression |
| 61 | + * Example: [ |
| 62 | + * [ |
| 63 | + * 'condition' => 'amount > 1000', |
| 64 | + * 'type' => 'externalURL', |
| 65 | + * 'value' => 'https://example.com/approval' |
| 66 | + * ], |
| 67 | + * [ |
| 68 | + * 'condition' => 'status = "urgent"', |
| 69 | + * 'type' => 'taskList', |
| 70 | + * 'value' => null |
| 71 | + * ] |
| 72 | + * ] |
| 73 | + * @param array $data Process data to evaluate conditions against |
| 74 | + * Contains variables from the process instance |
| 75 | + * Example: ['amount' => 1500, 'status' => 'urgent', 'user' => 'john'] |
| 76 | + * |
| 77 | + * @return array|null The first matching conditional redirect configuration, or null if none match |
| 78 | + * |
| 79 | + * @throws InvalidArgumentException When a condition item is missing the required 'condition' key |
| 80 | + * |
| 81 | + * @example |
| 82 | + * ```php |
| 83 | + * $service = new ConditionalRedirectService(); |
| 84 | + * |
| 85 | + * $conditionalRedirect = [ |
| 86 | + * [ |
| 87 | + * 'condition' => 'amount > 1000', |
| 88 | + * 'type' => 'externalURL', |
| 89 | + * 'value' => 'https://example.com/approval' |
| 90 | + * ], |
| 91 | + * [ |
| 92 | + * 'condition' => 'amount <= 1000', |
| 93 | + * 'type' => 'taskList', |
| 94 | + * 'value' => null |
| 95 | + * ] |
| 96 | + * ]; |
| 97 | + * |
| 98 | + * $data = ['amount' => 1500, 'status' => 'pending']; |
| 99 | + * |
| 100 | + * $result = $service->resolve($conditionalRedirect, $data); |
| 101 | + * // Returns: ['condition' => 'amount > 1000', 'type' => 'externalURL', 'value' => 'https://example.com/approval'] |
| 102 | + * ``` |
| 103 | + */ |
| 104 | + public function resolve(array $conditionalRedirect, array $data): ?array |
| 105 | + { |
| 106 | + $this->errors = []; |
| 107 | + foreach ($conditionalRedirect as $item) { |
| 108 | + if (!isset($item['condition'])) { |
| 109 | + throw new InvalidArgumentException('Condition is required'); |
| 110 | + } |
| 111 | + |
| 112 | + $condition = $item['condition']; |
| 113 | + |
| 114 | + $this->feel->setBody($condition); |
| 115 | + try { |
| 116 | + $result = ($this->feel)($data); |
| 117 | + } catch (\Throwable $e) { |
| 118 | + $this->errors[] = $e->getMessage(); |
| 119 | + continue; |
| 120 | + } |
| 121 | + if ($result) { |
| 122 | + return $item; |
| 123 | + } |
| 124 | + } |
| 125 | + |
| 126 | + return null; |
| 127 | + } |
| 128 | + |
| 129 | + /** |
| 130 | + * Process conditional redirects for a specific process request token |
| 131 | + * |
| 132 | + * This method is a convenience wrapper that automatically retrieves process data |
| 133 | + * from a ProcessRequestToken and evaluates conditional redirects against that data. |
| 134 | + * It's commonly used when you have a token and want to determine the appropriate |
| 135 | + * redirect based on the current process state and data, it also considers |
| 136 | + * multi-instance tasks. |
| 137 | + * |
| 138 | + * @param array $conditionalRedirect Array of conditional redirect configurations |
| 139 | + * Each item must contain a 'condition' key with a FEEL expression |
| 140 | + * Example: [ |
| 141 | + * [ |
| 142 | + * 'condition' => 'taskStatus = "completed"', |
| 143 | + * 'type' => 'homepageDashboard', |
| 144 | + * 'value' => null |
| 145 | + * ], |
| 146 | + * [ |
| 147 | + * 'condition' => 'taskStatus = "pending"', |
| 148 | + * 'type' => 'taskList', |
| 149 | + * 'value' => null |
| 150 | + * ] |
| 151 | + * ] |
| 152 | + * @param ProcessRequestToken $token The process request token to evaluate conditions against |
| 153 | + * The token contains the process instance data and context |
| 154 | + * |
| 155 | + * @return array|null The first matching conditional redirect configuration, or null if none match |
| 156 | + * |
| 157 | + * @throws InvalidArgumentException When a condition item is missing the required 'condition' key |
| 158 | + * |
| 159 | + * @example |
| 160 | + * ```php |
| 161 | + * $service = new ConditionalRedirectService(); |
| 162 | + * $token = ProcessRequestToken::find(123); |
| 163 | + * |
| 164 | + * $conditionalRedirect = [ |
| 165 | + * [ |
| 166 | + * 'condition' => 'taskStatus = "completed"', |
| 167 | + * 'type' => 'homepageDashboard', |
| 168 | + * 'value' => null |
| 169 | + * ], |
| 170 | + * [ |
| 171 | + * 'condition' => 'taskStatus = "pending"', |
| 172 | + * 'type' => 'taskList', |
| 173 | + * 'value' => null |
| 174 | + * ] |
| 175 | + * ]; |
| 176 | + * |
| 177 | + * $result = $service->resolveForToken($conditionalRedirect, $token); |
| 178 | + * // Returns the appropriate redirect configuration based on the token's data |
| 179 | + * ``` |
| 180 | + * |
| 181 | + * @see resolve() For detailed parameter documentation |
| 182 | + */ |
| 183 | + public function resolveForToken(array $conditionalRedirect, ProcessRequestToken $token): ?array |
| 184 | + { |
| 185 | + $data = $this->dataManager->getData($token); |
| 186 | + $result = $this->resolve($conditionalRedirect, $data); |
| 187 | + if ($this->errors) { |
| 188 | + $case_number = $this->getCaseNumber($token); |
| 189 | + foreach ($this->errors as $error) { |
| 190 | + $this->addLogComment($token, $error, $case_number); |
| 191 | + } |
| 192 | + } |
| 193 | + return $result; |
| 194 | + } |
| 195 | + |
| 196 | + private function getCaseNumber(ProcessRequestToken $token): ?int |
| 197 | + { |
| 198 | + // get process request from relationship if loaded, otherwise get from database |
| 199 | + if ($token->relationLoaded('processRequest')) { |
| 200 | + $case_number = $token->processRequest->case_number; |
| 201 | + } else { |
| 202 | + // get case_number only to avoid to hidrate all the process request data |
| 203 | + $case_number = ProcessRequest::where('id', $token->process_request_id)->value('case_number'); |
| 204 | + } |
| 205 | + |
| 206 | + return $case_number; |
| 207 | + } |
| 208 | + |
| 209 | + private function addLogComment(ProcessRequestToken $token, string $error, string $case_number) |
| 210 | + { |
| 211 | + Comment::create([ |
| 212 | + 'body' => $error, |
| 213 | + 'user_id' => null, |
| 214 | + 'subject' => $error, |
| 215 | + 'type' => 'LOG', |
| 216 | + 'case_number' => $case_number, |
| 217 | + 'commentable_type' => ProcessRequest::class, |
| 218 | + 'commentable_id' => $token->process_request_id, |
| 219 | + ]); |
| 220 | + } |
| 221 | +} |
0 commit comments