Skip to content

Firefly III: a personal finances manager

3.8 KB
Raw Blame
<?php

/*
 * ShowController.php
 * Copyright (c) 2025 [email protected].
 *
 * This file is part of Firefly III (https://github.com/firefly-iii).
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see https://www.gnu.org/licenses/.
 */

declare(strict_types=1);

namespace FireflyIII\Api\V1\Controllers\Models\CurrencyExchangeRate;

use Carbon\Carbon;
use FireflyIII\Api\V1\Controllers\Controller;
use FireflyIII\Enums\UserRoleEnum;
use FireflyIII\Models\CurrencyExchangeRate;
use FireflyIII\Models\TransactionCurrency;
use FireflyIII\Repositories\ExchangeRate\ExchangeRateRepositoryInterface;
use FireflyIII\Support\Http\Api\ValidatesUserGroupTrait;
use FireflyIII\Transformers\ExchangeRateTransformer;
use Illuminate\Http\JsonResponse;
use Illuminate\Http\Request;
use Illuminate\Pagination\LengthAwarePaginator;
use Override;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;

/**
 * Class ShowController
 */
final class ShowController extends Controller
{
    use ValidatesUserGroupTrait;

    public const string RESOURCE_KEY = 'exchange-rates';

    #[Override]
    protected array $acceptedRoles   = [UserRoleEnum::OWNER];
    private ExchangeRateRepositoryInterface $repository;

    public function __construct()
    {
        parent::__construct();
        $this->middleware(function (Request $request, $next) {
            $this->repository = app(ExchangeRateRepositoryInterface::class);
            $this->repository->setUserGroup($this->validateUserGroup($request));

            return $next($request);
        });
    }

    public function show(TransactionCurrency $from, TransactionCurrency $to): JsonResponse
    {
        $pageSize    = $this->parameters->get('limit');
        $page        = $this->parameters->get('page');
        $rates       = $this->repository->getRates($from, $to);
        $count       = $rates->count();
        $rates       = $rates->slice(($page - 1) * $pageSize, $pageSize);
        $paginator   = new LengthAwarePaginator($rates, $count, $pageSize, $page);

        $transformer = new ExchangeRateTransformer();
        $transformer->setParameters($this->parameters); // give params to transformer

        return response()->json($this->jsonApiList(self::RESOURCE_KEY, $paginator, $transformer))->header('Content-Type', self::CONTENT_TYPE);
    }

    public function showSingleByDate(TransactionCurrency $from, TransactionCurrency $to, Carbon $date): JsonResponse
    {
        $transformer  = new ExchangeRateTransformer();
        $transformer->setParameters($this->parameters);

        $exchangeRate = $this->repository->getSpecificRateOnDate($from, $to, $date);
        if (!$exchangeRate instanceof CurrencyExchangeRate) {
            throw new NotFoundHttpException();
        }

        return response()->api($this->jsonApiObject(self::RESOURCE_KEY, $exchangeRate, $transformer))->header('Content-Type', self::CONTENT_TYPE);
    }

    public function showSingleById(CurrencyExchangeRate $exchangeRate): JsonResponse
    {
        $transformer = new ExchangeRateTransformer();
        $transformer->setParameters($this->parameters);

        return response()->api($this->jsonApiObject(self::RESOURCE_KEY, $exchangeRate, $transformer))->header('Content-Type', self::CONTENT_TYPE);
    }
}