All model API things done!

2025-09-04 03:43:07 +00:00 · 2021-03-06 22:22:51 +01:00
parent 9632f69b15
commit 9cc20bbea7
10 changed files with 397 additions and 268 deletions
--- a/app/Api/V1/Controllers/Models/TransactionLinkType/DestroyController.php
+++ b/app/Api/V1/Controllers/Models/TransactionLinkType/DestroyController.php
@@ -5,11 +5,63 @@ namespace FireflyIII\Api\V1\Controllers\Models\TransactionLinkType;


 use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Exceptions\FireflyException;
+use FireflyIII\Models\LinkType;
+use FireflyIII\Repositories\LinkType\LinkTypeRepositoryInterface;
+use FireflyIII\Repositories\User\UserRepositoryInterface;
+use FireflyIII\Support\Http\Api\TransactionFilter;
+use FireflyIII\User;
+use Illuminate\Http\JsonResponse;

 /**
 * Class DestroyController
 */
 class DestroyController extends Controller
 {
+    use TransactionFilter;
+
+    private LinkTypeRepositoryInterface $repository;
+    private UserRepositoryInterface     $userRepository;
+
+    /**
+     * LinkTypeController constructor.
+     *
+     * @codeCoverageIgnore
+     */
+    public function __construct()
+    {
+        parent::__construct();
+        $this->middleware(
+            function ($request, $next) {
+                /** @var User $user */
+                $user                 = auth()->user();
+                $this->repository     = app(LinkTypeRepositoryInterface::class);
+                $this->userRepository = app(UserRepositoryInterface::class);
+                $this->repository->setUser($user);
+
+                return $next($request);
+            }
+        );
+    }
+
+
+    /**
+     * Delete the resource.
+     *
+     * @param LinkType $linkType
+     *
+     * @return JsonResponse
+     * @throws FireflyException
+     * @codeCoverageIgnore
+     */
+    public function destroy(LinkType $linkType): JsonResponse
+    {
+        if (false === $linkType->editable) {
+            throw new FireflyException('200020: Link type cannot be changed.');
+        }
+        $this->repository->destroy($linkType);
+
+        return response()->json([], 204);
+    }

 }
--- a/app/Api/V1/Controllers/Models/TransactionLinkType/ListController.php
+++ b/app/Api/V1/Controllers/Models/TransactionLinkType/ListController.php
@@ -5,11 +5,107 @@ namespace FireflyIII\Api\V1\Controllers\Models\TransactionLinkType;


 use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Helpers\Collector\GroupCollectorInterface;
+use FireflyIII\Models\LinkType;
+use FireflyIII\Repositories\LinkType\LinkTypeRepositoryInterface;
+use FireflyIII\Repositories\User\UserRepositoryInterface;
+use FireflyIII\Support\Http\Api\TransactionFilter;
+use FireflyIII\Transformers\TransactionGroupTransformer;
+use FireflyIII\User;
+use Illuminate\Http\JsonResponse;
+use Illuminate\Http\Request;
+use League\Fractal\Pagination\IlluminatePaginatorAdapter;
+use League\Fractal\Resource\Collection as FractalCollection;

 /**
 * Class ListController
 */
 class ListController extends Controller
 {
+    use TransactionFilter;
+
+    private LinkTypeRepositoryInterface $repository;
+    private UserRepositoryInterface     $userRepository;
+
+    /**
+     * LinkTypeController constructor.
+     *
+     * @codeCoverageIgnore
+     */
+    public function __construct()
+    {
+        parent::__construct();
+        $this->middleware(
+            function ($request, $next) {
+                /** @var User $user */
+                $user                 = auth()->user();
+                $this->repository     = app(LinkTypeRepositoryInterface::class);
+                $this->userRepository = app(UserRepositoryInterface::class);
+                $this->repository->setUser($user);
+
+                return $next($request);
+            }
+        );
+    }
+
+
+
+    /**
+     * Delete the resource.
+     *
+     * @param Request  $request
+     * @param LinkType $linkType
+     *
+     * @return JsonResponse
+     * @codeCoverageIgnore
+     */
+    public function transactions(Request $request, LinkType $linkType): JsonResponse
+    {
+        $pageSize = (int)app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
+        $type     = $request->get('type') ?? 'default';
+        $this->parameters->set('type', $type);
+
+        $types   = $this->mapTransactionTypes($this->parameters->get('type'));
+        $manager = $this->getManager();
+
+        // whatever is returned by the query, it must be part of these journals:
+        $journalIds = $this->repository->getJournalIds($linkType);
+
+        /** @var User $admin */
+        $admin = auth()->user();
+
+        // use new group collector:
+        /** @var GroupCollectorInterface $collector */
+        $collector = app(GroupCollectorInterface::class);
+        $collector
+            ->setUser($admin)
+            // filter on journal IDs.
+            ->setJournalIds($journalIds)
+            // all info needed for the API:
+            ->withAPIInformation()
+            // set page size:
+            ->setLimit($pageSize)
+            // set page to retrieve
+            ->setPage($this->parameters->get('page'))
+            // set types of transactions to return.
+            ->setTypes($types);
+
+
+        if (null !== $this->parameters->get('start') && null !== $this->parameters->get('end')) {
+            $collector->setRange($this->parameters->get('start'), $this->parameters->get('end'));
+        }
+        $paginator = $collector->getPaginatedGroups();
+        $paginator->setPath(route('api.v1.transactions.index') . $this->buildParams());
+        $transactions = $paginator->getCollection();
+
+        /** @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);
+    }

 }
--- a/app/Api/V1/Controllers/Models/TransactionLinkType/ShowController.php
+++ b/app/Api/V1/Controllers/Models/TransactionLinkType/ShowController.php
@@ -5,11 +5,101 @@ namespace FireflyIII\Api\V1\Controllers\Models\TransactionLinkType;


 use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Models\LinkType;
+use FireflyIII\Repositories\LinkType\LinkTypeRepositoryInterface;
+use FireflyIII\Repositories\User\UserRepositoryInterface;
+use FireflyIII\Support\Http\Api\TransactionFilter;
+use FireflyIII\Transformers\LinkTypeTransformer;
+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
 */
 class ShowController extends Controller
 {
+    use TransactionFilter;

+    private LinkTypeRepositoryInterface $repository;
+    private UserRepositoryInterface     $userRepository;
+
+    /**
+     * LinkTypeController constructor.
+     *
+     * @codeCoverageIgnore
+     */
+    public function __construct()
+    {
+        parent::__construct();
+        $this->middleware(
+            function ($request, $next) {
+                /** @var User $user */
+                $user                 = auth()->user();
+                $this->repository     = app(LinkTypeRepositoryInterface::class);
+                $this->userRepository = app(UserRepositoryInterface::class);
+                $this->repository->setUser($user);
+
+                return $next($request);
+            }
+        );
+    }
+
+    /**
+     * List all of them.
+     *
+     * @return JsonResponse
+     * @codeCoverageIgnore
+     */
+    public function index(): JsonResponse
+    {
+        // create some objects:
+        $manager  = $this->getManager();
+        $pageSize = (int)app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
+
+        // get list of accounts. Count it and split it.
+        $collection = $this->repository->get();
+        $count      = $collection->count();
+        $linkTypes  = $collection->slice(($this->parameters->get('page') - 1) * $pageSize, $pageSize);
+
+        // make paginator:
+        $paginator = new LengthAwarePaginator($linkTypes, $count, $pageSize, $this->parameters->get('page'));
+        $paginator->setPath(route('api.v1.link_types.index') . $this->buildParams());
+
+        /** @var LinkTypeTransformer $transformer */
+        $transformer = app(LinkTypeTransformer::class);
+        $transformer->setParameters($this->parameters);
+
+        $resource = new FractalCollection($linkTypes, $transformer, 'link_types');
+        $resource->setPaginator(new IlluminatePaginatorAdapter($paginator));
+
+        return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
+
+    }
+
+
+
+    /**
+     * List single resource.
+     *
+     * @param LinkType $linkType
+     *
+     * @return JsonResponse
+     * @codeCoverageIgnore
+     */
+    public function show(LinkType $linkType): JsonResponse
+    {
+        $manager = $this->getManager();
+        /** @var LinkTypeTransformer $transformer */
+        $transformer = app(LinkTypeTransformer::class);
+        $transformer->setParameters($this->parameters);
+
+        $resource = new Item($linkType, $transformer, 'link_types');
+
+        return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
+
+    }
 }
--- a/app/Api/V1/Controllers/Models/TransactionLinkType/StoreController.php
+++ b/app/Api/V1/Controllers/Models/TransactionLinkType/StoreController.php
@@ -5,11 +5,76 @@ namespace FireflyIII\Api\V1\Controllers\Models\TransactionLinkType;


 use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Api\V1\Requests\Models\TransactionLinkType\StoreRequest;
+use FireflyIII\Exceptions\FireflyException;
+use FireflyIII\Repositories\LinkType\LinkTypeRepositoryInterface;
+use FireflyIII\Repositories\User\UserRepositoryInterface;
+use FireflyIII\Support\Http\Api\TransactionFilter;
+use FireflyIII\Transformers\LinkTypeTransformer;
+use FireflyIII\User;
+use Illuminate\Http\JsonResponse;
+use League\Fractal\Resource\Item;

 /**
 * Class StoreController
 */
 class StoreController extends Controller
 {
+    use TransactionFilter;

+    private LinkTypeRepositoryInterface $repository;
+    private UserRepositoryInterface     $userRepository;
+
+    /**
+     * LinkTypeController constructor.
+     *
+     * @codeCoverageIgnore
+     */
+    public function __construct()
+    {
+        parent::__construct();
+        $this->middleware(
+            function ($request, $next) {
+                /** @var User $user */
+                $user                 = auth()->user();
+                $this->repository     = app(LinkTypeRepositoryInterface::class);
+                $this->userRepository = app(UserRepositoryInterface::class);
+                $this->repository->setUser($user);
+
+                return $next($request);
+            }
+        );
+    }
+
+
+
+    /**
+     * Store new object.
+     *
+     * @param StoreRequest $request
+     *
+     * @return JsonResponse
+     * @throws FireflyException
+     */
+    public function store(StoreRequest $request): JsonResponse
+    {
+        /** @var User $admin */
+        $admin = auth()->user();
+
+        if (!$this->userRepository->hasRole($admin, 'owner')) {
+            throw new FireflyException('200005: You need the "owner" role to do this.'); // @codeCoverageIgnore
+        }
+        $data = $request->getAll();
+        // if currency ID is 0, find the currency by the code:
+        $linkType = $this->repository->store($data);
+        $manager  = $this->getManager();
+
+        /** @var LinkTypeTransformer $transformer */
+        $transformer = app(LinkTypeTransformer::class);
+        $transformer->setParameters($this->parameters);
+        $resource = new Item($linkType, $transformer, 'link_types');
+
+        return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
+
+    }
 }
--- a/app/Api/V1/Controllers/Models/TransactionLinkType/UpdateController.php
+++ b/app/Api/V1/Controllers/Models/TransactionLinkType/UpdateController.php
@@ -5,11 +5,82 @@ namespace FireflyIII\Api\V1\Controllers\Models\TransactionLinkType;


 use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Api\V1\Requests\Models\TransactionLinkType\UpdateRequest;
+use FireflyIII\Exceptions\FireflyException;
+use FireflyIII\Models\LinkType;
+use FireflyIII\Repositories\LinkType\LinkTypeRepositoryInterface;
+use FireflyIII\Repositories\User\UserRepositoryInterface;
+use FireflyIII\Support\Http\Api\TransactionFilter;
+use FireflyIII\Transformers\LinkTypeTransformer;
+use FireflyIII\User;
+use Illuminate\Http\JsonResponse;
+use League\Fractal\Resource\Item;

 /**
 * Class UpdateController
 */
 class UpdateController extends Controller
 {
+    use TransactionFilter;

+    private LinkTypeRepositoryInterface $repository;
+    private UserRepositoryInterface     $userRepository;
+
+    /**
+     * LinkTypeController constructor.
+     *
+     * @codeCoverageIgnore
+     */
+    public function __construct()
+    {
+        parent::__construct();
+        $this->middleware(
+            function ($request, $next) {
+                /** @var User $user */
+                $user                 = auth()->user();
+                $this->repository     = app(LinkTypeRepositoryInterface::class);
+                $this->userRepository = app(UserRepositoryInterface::class);
+                $this->repository->setUser($user);
+
+                return $next($request);
+            }
+        );
+    }
+
+
+
+    /**
+     * Update object.
+     *
+     * @param UpdateRequest $request
+     * @param LinkType              $linkType
+     *
+     * @return JsonResponse
+     * @throws FireflyException
+     */
+    public function update(UpdateRequest $request, LinkType $linkType): JsonResponse
+    {
+        if (false === $linkType->editable) {
+            throw new FireflyException('200020: Link type cannot be changed.');
+        }
+
+        /** @var User $admin */
+        $admin = auth()->user();
+
+        if (!$this->userRepository->hasRole($admin, 'owner')) {
+            throw new FireflyException('200005: You need the "owner" role to do this.'); // @codeCoverageIgnore
+        }
+
+        $data = $request->getAll();
+        $this->repository->update($linkType, $data);
+        $manager = $this->getManager();
+        /** @var LinkTypeTransformer $transformer */
+        $transformer = app(LinkTypeTransformer::class);
+        $transformer->setParameters($this->parameters);
+
+        $resource = new Item($linkType, $transformer, 'link_types');
+
+        return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
+
+    }
 }