. */ declare(strict_types=1); namespace FireflyIII\Api\V1\Requests; use Illuminate\Validation\Validator; /** * Class RuleRequest */ class RuleRequest extends Request { /** * Authorize logged in users. * * @return bool */ public function authorize(): bool { // Only allow authenticated users return auth()->check(); } /** * Get all data from the request. * * @return array */ public function getAll(): array { $data = [ 'title' => $this->string('title'), 'description' => $this->string('description'), 'rule_group_id' => $this->integer('rule_group_id'), 'rule_group_title' => $this->string('rule_group_title'), 'trigger' => $this->string('trigger'), 'strict' => $this->boolean('strict'), 'stop_processing' => $this->boolean('stop_processing'), 'active' => $this->boolean('active'), 'rule_triggers' => $this->getRuleTriggers(), 'rule_actions' => $this->getRuleActions(), ]; return $data; } /** * The rules that the incoming request must be matched against. * * @return array */ public function rules(): array { $validTriggers = array_keys(config('firefly.rule-triggers')); $validActions = array_keys(config('firefly.rule-actions')); // some actions require text: $contextActions = implode(',', config('firefly.rule-actions-text')); $rules = [ 'title' => 'required|between:1,100|uniqueObjectForUser:rules,title', 'description' => 'between:1,5000|nullable', 'rule_group_id' => 'required|belongsToUser:rule_groups|required_without:rule_group_title', 'rule_group_title' => 'nullable|between:1,255|required_without:rule_group_id|belongsToUser:rule_groups,title', 'trigger' => 'required|in:store-journal,update-journal', 'rule_triggers.*.name' => 'required|in:' . implode(',', $validTriggers), 'rule_triggers.*.stop_processing' => 'boolean', 'rule_triggers.*.value' => 'required|min:1|ruleTriggerValue', 'rule_actions.*.name' => 'required|in:' . implode(',', $validActions), 'rule_actions.*.value' => 'required_if:rule_actions.*.type,' . $contextActions . '|ruleActionValue', 'rule_actions.*.stop_processing' => 'boolean', 'strict' => 'required|boolean', 'stop_processing' => 'required|boolean', 'active' => 'required|boolean', ]; return $rules; } /** * Configure the validator instance. * * @param Validator $validator * * @return void */ public function withValidator(Validator $validator): void { $validator->after( function (Validator $validator) { $this->atLeastOneTrigger($validator); $this->atLeastOneAction($validator); } ); } /** * Adds an error to the validator when there are no repetitions in the array of data. * * @param Validator $validator */ protected function atLeastOneAction(Validator $validator): void { $data = $validator->getData(); $repetitions = $data['rule_actions'] ?? []; // need at least one transaction if (0 === \count($repetitions)) { $validator->errors()->add('title', (string)trans('validation.at_least_one_action')); } } /** * Adds an error to the validator when there are no repetitions in the array of data. * * @param Validator $validator */ protected function atLeastOneTrigger(Validator $validator): void { $data = $validator->getData(); $repetitions = $data['rule_triggers'] ?? []; // need at least one transaction if (0 === \count($repetitions)) { $validator->errors()->add('title', (string)trans('validation.at_least_one_trigger')); } } /** * @return array */ private function getRuleActions(): array { $actions = $this->get('rule_actions'); $return = []; if (\is_array($actions)) { foreach ($actions as $action) { $return[] = [ 'name' => $action['name'], 'value' => $action['value'], 'stop_processing' => 1 === (int)($action['stop-processing'] ?? '0'), ]; } } return $return; } /** * @return array */ private function getRuleTriggers(): array { $triggers = $this->get('rule_triggers'); $return = []; if (\is_array($triggers)) { foreach ($triggers as $trigger) { $return[] = [ 'name' => $trigger['name'], 'value' => $trigger['value'], 'stop_processing' => 1 === (int)($trigger['stop-processing'] ?? '0'), ]; } } return $return; } }