Make sure bills API is consistent.

2026-05-05 05:33:36 +00:00 · 2018-02-11 07:46:34 +01:00
parent 9b3abd3b19
commit 2ef1022c92
9 changed files with 116 additions and 159 deletions
--- a/app/Transformers/TransactionJournalTransformer.php
+++ b/app/Transformers/TransactionJournalTransformer.php
@@ -0,0 +1,97 @@
+<?php
+/**
+ * JournalTransformer.php
+ * Copyright (c) 2018 thegrumpydictator@gmail.com
+ *
+ * This file is part of Firefly III.
+ *
+ * Firefly III is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Firefly III 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Firefly III. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+declare(strict_types=1);
+
+namespace FireflyIII\Transformers;
+
+
+use FireflyIII\Models\Note;
+use FireflyIII\Models\TransactionJournal;
+use League\Fractal\Resource\Collection as FractalCollection;
+use League\Fractal\TransformerAbstract;
+
+/**
+ * Class TransactionJournalTransformer
+ */
+class TransactionJournalTransformer extends TransformerAbstract
+{
+
+    /**
+     * List of resources possible to include
+     *
+     * @var array
+     */
+    protected $availableIncludes = ['attachments', 'transactions', 'user', 'tags', 'budget', 'category', 'bill', 'meta', 'piggy_bank_events'];
+    /**
+     * List of resources to automatically include
+     *
+     * @var array
+     */
+    protected $defaultIncludes = ['transactions'];
+
+    /**
+     * @param TransactionJournal $journal
+     *
+     * @return FractalCollection
+     */
+    public function includeTransactions(TransactionJournal $journal): FractalCollection
+    {
+        $set = $journal->transactions()->where('amount', '<', 0)->get(['transactions.*']);
+
+        return $this->collection($set, new TransactionTransformer, 'transactions');
+    }
+
+
+    /**
+     * @param TransactionJournal $journal
+     *
+     * @return array
+     */
+    public function transform(TransactionJournal $journal): array
+    {
+        $data = [
+            'id'          => (int)$journal->id,
+            'updated_at'  => $journal->updated_at->toAtomString(),
+            'created_at'  => $journal->created_at->toAtomString(),
+            'type'        => $journal->transactionType->type,
+            'description' => $journal->description,
+            'date'        => $journal->date->format('Y-m-d'),
+            'order'       => $journal->order,
+            'completed'   => $journal->completed,
+            'notes'       => null,
+            'links'       => [
+                [
+                    'rel' => 'self',
+                    'uri' => '/journals/' . $journal->id,
+                ],
+            ],
+        ];
+        /** @var Note $note */
+        $note = $journal->notes()->first();
+        if (!is_null($note)) {
+            $data['notes'] = $note->text;
+        }
+
+        return $data;
+    }
+
+}