Skip to content

Firefly III: a personal finances manager

5.2 KB
Raw Blame
<?php

/*
 * ShowController.php
 * Copyright (c) 2021 [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\Bill;

use FireflyIII\Api\V1\Controllers\Controller;
use FireflyIII\Api\V1\Requests\DateRangeRequest;
use FireflyIII\Api\V1\Requests\Generic\PaginationDateRangeRequest;
use FireflyIII\Models\Bill;
use FireflyIII\Repositories\Bill\BillRepositoryInterface;
use FireflyIII\Support\JsonApi\Enrichments\SubscriptionEnrichment;
use FireflyIII\Transformers\BillTransformer;
use FireflyIII\User;
use Illuminate\Http\JsonResponse;
use Illuminate\Pagination\LengthAwarePaginator;
use League\Fractal\Pagination\IlluminatePaginatorAdapter;
use League\Fractal\Resource\Collection as FractalCollection;
use League\Fractal\Resource\Item;

/**
 * Class ShowController
 */
final class ShowController extends Controller
{
    private BillRepositoryInterface $repository;

    /**
     * BillController constructor.
     */
    public function __construct()
    {
        parent::__construct();
        $this->middleware(function ($request, $next) {
            $this->repository = app(BillRepositoryInterface::class);
            $this->repository->setUser(auth()->user());

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

    /**
     * This endpoint is documented at:
     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/bills/listBill
     *
     * Display a listing of the resource.
     */
    public function index(PaginationDateRangeRequest $request): JsonResponse
    {
        ['limit' => $limit, 'offset' => $offset, 'start' => $start, 'end' => $end, 'page' => $page] = $request->attributes->all();

        $this->repository->correctOrder();
        $bills                                                                                      = $this->repository->getBills();
        $manager                                                                                    = $this->getManager();
        $count                                                                                      = $bills->count();
        $bills                                                                                      = $bills->slice($offset, $limit);
        $paginator                                                                                  = new LengthAwarePaginator($bills, $count, $limit, $page);

        // enrich
        /** @var User $admin */
        $admin                                                                                      = auth()->user();
        $enrichment                                                                                 = new SubscriptionEnrichment();
        $enrichment->setUser($admin);
        $enrichment->setStart($start);
        $enrichment->setEnd($end);
        $bills                                                                                      = $enrichment->enrich($bills);

        /** @var BillTransformer $transformer */
        $transformer                                                                                = app(BillTransformer::class);

        $resource                                                                                   = new FractalCollection($bills, $transformer, 'bills');
        $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/?urls.primaryName=2.0.0%20(v1)#/bills/getBill
     *
     * Show the specified bill.
     */
    public function show(DateRangeRequest $request, Bill $bill): JsonResponse
    {
        ['start' => $start, 'end' => $end] = $request->attributes->all();

        $manager                           = $this->getManager();

        // enrich
        /** @var User $admin */
        $admin                             = auth()->user();
        $enrichment                        = new SubscriptionEnrichment();
        $enrichment->setUser($admin);
        $enrichment->setStart($start);
        $enrichment->setEnd($end);
        $bill                              = $enrichment->enrichSingle($bill);

        /** @var BillTransformer $transformer */
        $transformer                       = app(BillTransformer::class);

        $resource                          = new Item($bill, $transformer, 'bills');

        return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
    }
}