. */ declare(strict_types=1); namespace FireflyIII\Api\V1\Controllers\Models\RuleGroup; use Exception; use FireflyIII\Api\V1\Controllers\Controller; use FireflyIII\Api\V1\Requests\Models\RuleGroup\TestRequest; use FireflyIII\Api\V1\Requests\Models\RuleGroup\TriggerRequest; use FireflyIII\Exceptions\FireflyException; use FireflyIII\Models\RuleGroup; use FireflyIII\Repositories\RuleGroup\RuleGroupRepositoryInterface; use FireflyIII\TransactionRules\Engine\RuleEngineInterface; use FireflyIII\Transformers\TransactionGroupTransformer; use FireflyIII\User; use Illuminate\Http\JsonResponse; use Illuminate\Pagination\LengthAwarePaginator; use League\Fractal\Pagination\IlluminatePaginatorAdapter; use League\Fractal\Resource\Collection as FractalCollection; /** * Class TriggerController */ class TriggerController extends Controller { private RuleGroupRepositoryInterface $ruleGroupRepository; /** * RuleGroupController constructor. * * @codeCoverageIgnore */ public function __construct() { parent::__construct(); $this->middleware( function ($request, $next) { /** @var User $user */ $user = auth()->user(); $this->ruleGroupRepository = app(RuleGroupRepositoryInterface::class); $this->ruleGroupRepository->setUser($user); return $next($request); } ); } /** * This endpoint is documented at: * https://api-docs.firefly-iii.org/#/rule_groups/testRuleGroup * * @param TestRequest $request * @param RuleGroup $group * * @return JsonResponse * @throws FireflyException * */ public function testGroup(TestRequest $request, RuleGroup $group): JsonResponse { $rules = $this->ruleGroupRepository->getActiveRules($group); if (0 === $rules->count()) { throw new FireflyException('200023: No rules in this rule group.'); } $parameters = $request->getTestParameters(); /** @var RuleEngineInterface $ruleEngine */ $ruleEngine = app(RuleEngineInterface::class); $ruleEngine->setRules($rules); // overrule the rule(s) if necessary. if (array_key_exists('start', $parameters) && null !== $parameters['start']) { // add a range: $ruleEngine->addOperator(['type' => 'date_after', 'value' => $parameters['start']->format('Y-m-d')]); } if (array_key_exists('end', $parameters) && null !== $parameters['end']) { // add a range: $ruleEngine->addOperator(['type' => 'date_before', 'value' => $parameters['end']->format('Y-m-d')]); } if (array_key_exists('accounts', $parameters) && '' !== $parameters['accounts']) { $ruleEngine->addOperator(['type' => 'account_id', 'value' => implode(',', $parameters['accounts'])]); } // file the rule(s) $transactions = $ruleEngine->find(); $count = $transactions->count(); $paginator = new LengthAwarePaginator($transactions, $count, 31337, $this->parameters->get('page')); $paginator->setPath(route('api.v1.rule_groups.test', [$group->id]) . $this->buildParams()); // resulting list is presented as JSON thing. $manager = $this->getManager(); /** @var TransactionGroupTransformer $transformer */ $transformer = app(TransactionGroupTransformer::class); $transformer->setParameters($this->parameters); $resource = new FractalCollection($transactions, $transformer, 'transactions'); $resource->setPaginator(new IlluminatePaginatorAdapter($paginator)); return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE); } /** * This endpoint is documented at: * https://api-docs.firefly-iii.org/#/rule_groups/fireRuleGroup * * Execute the given rule group on a set of existing transactions. * * @param TriggerRequest $request * @param RuleGroup $group * * @return JsonResponse * @throws Exception */ public function triggerGroup(TriggerRequest $request, RuleGroup $group): JsonResponse { $rules = $this->ruleGroupRepository->getActiveRules($group); if (0 === $rules->count()) { throw new FireflyException('200023: No rules in this rule group.'); } // Get parameters specified by the user $parameters = $request->getTriggerParameters(); /** @var RuleEngineInterface $ruleEngine */ $ruleEngine = app(RuleEngineInterface::class); $ruleEngine->setRules($rules); // overrule the rule(s) if necessary. if (array_key_exists('start', $parameters) && null !== $parameters['start']) { // add a range: $ruleEngine->addOperator(['type' => 'date_after', 'value' => $parameters['start']->format('Y-m-d')]); } if (array_key_exists('end', $parameters) && null !== $parameters['end']) { // add a range: $ruleEngine->addOperator(['type' => 'date_before', 'value' => $parameters['end']->format('Y-m-d')]); } if (array_key_exists('accounts', $parameters) && '' !== $parameters['accounts']) { $ruleEngine->addOperator(['type' => 'account_id', 'value' => implode(',', $parameters['accounts'])]); } // file the rule(s) $ruleEngine->fire(); return response()->json([], 204); } }