kenmirrors/firefly-iii
1
0
Fork 0
mirror of https://github.com/firefly-iii/firefly-iii.git synced 2025-10-16 17:33:45 +00:00
Code Issues Projects Releases Wiki Activity

API will display journal location.

Browse Source
This commit is contained in:
James Cole
2021-02-16 10:19:20 +01:00
parent d5d0e6b4ba
commit 25e4d78119
3 changed files with 114 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
app/Repositories/TransactionGroup/TransactionGroupRepository.php
View File

@@ -32,6 +32,7 @@ use FireflyIII\Exceptions\FireflyException;
use FireflyIII\Factory\TransactionGroupFactory;
use FireflyIII\Models\AccountMeta;
use FireflyIII\Models\Attachment;
use FireflyIII\Models\Location;
use FireflyIII\Models\Note;
use FireflyIII\Models\PiggyBankEvent;
use FireflyIII\Models\Transaction;
@@ -472,4 +473,15 @@ class TransactionGroupRepository implements TransactionGroupRepositoryInterface
return $journal->tags()->get();
}
/**
* @inheritDoc
*/
public function getLocation(int $journalId): ?Location
{
/** @var TransactionJournal $journal */
$journal = $this->user->transactionJournals()->find($journalId);
return $journal->locations()->first();
}
}

11
app/Repositories/TransactionGroup/TransactionGroupRepositoryInterface.php
View File

@@ -25,6 +25,7 @@ namespace FireflyIII\Repositories\TransactionGroup;
use FireflyIII\Exceptions\DuplicateTransactionException;
use FireflyIII\Exceptions\FireflyException;
use FireflyIII\Models\Location;
use FireflyIII\Models\TransactionGroup;
use FireflyIII\Support\NullArrayObject;
use FireflyIII\User;
@@ -96,6 +97,16 @@ interface TransactionGroupRepositoryInterface
*/
public function getMetaFields(int $journalId, array $fields): NullArrayObject;
/**
* Get the location of a journal or NULL.
*
* @param int $journalId
*
* @return Location|null
*/
public function getLocation(int $journalId): ?Location;
/**
* Get the note text for a journal (by ID).
*

59
app/Transformers/TransactionGroupTransformer.php
View File

@@ -27,6 +27,7 @@ use FireflyIII\Exceptions\FireflyException;
use FireflyIII\Models\Bill;
use FireflyIII\Models\Budget;
use FireflyIII\Models\Category;
use FireflyIII\Models\Location;
use FireflyIII\Models\Transaction;
use FireflyIII\Models\TransactionCurrency;
use FireflyIII\Models\TransactionGroup;
@@ -72,6 +73,7 @@ class TransactionGroupTransformer extends AbstractTransformer
{
$data = new NullArrayObject($group);
$first = new NullArrayObject(reset($group['transactions']));
return [
'id' => (int)$first['transaction_group_id'],
'created_at' => $first['created_at']->toAtomString(),
@@ -329,6 +331,16 @@ class TransactionGroupTransformer extends AbstractTransformer
$foreignAmount = number_format((float)$foreignAmount, $foreignCurrency['decimal_places'], '.', '');
}
$longitude = null;
$latitude = null;
$zoomLevel = null;
$location = $this->getLocation($journal);
if (null !== $location) {
$longitude = $location->longitude;
$latitude = $location->latitude;
$zoomLevel = $location->zoom_level;
}
return [
'user' => (int)$journal->user_id,
'transaction_journal_id' => (int)$journal->id,
@@ -396,6 +408,11 @@ class TransactionGroupTransformer extends AbstractTransformer
'due_date' => $metaDates['due_date'],
'payment_date' => $metaDates['payment_date'],
'invoice_date' => $metaDates['invoice_date'],
// location data
'longitude' => $longitude,
'latitude' => $latitude,
'zoom_level' => $zoomLevel,
];
}
@@ -428,11 +445,13 @@ class TransactionGroupTransformer extends AbstractTransformer
foreach ($transactions as $transaction) {
$result[] = $this->transformTransaction($transaction);
}
return $result;
}
/**
* @param array $transaction
*
* @return array
*/
private function transformTransaction(array $transaction): array
@@ -450,6 +469,16 @@ class TransactionGroupTransformer extends AbstractTransformer
$metaFieldData = $this->groupRepos->getMetaFields((int)$row['transaction_journal_id'], $this->metaFields);
$metaDateData = $this->groupRepos->getMetaDateFields((int)$row['transaction_journal_id'], $this->metaDateFields);
$longitude = null;
$latitude = null;
$zoomLevel = null;
$location = $this->getLocationById((int)$row['transaction_journal_id']);
if (null !== $location) {
$longitude = $location->longitude;
$latitude = $location->latitude;
$zoomLevel = $location->zoom_level;
}
return [
'user' => (int)$row['user_id'],
'transaction_journal_id' => (int)$row['transaction_journal_id'],
@@ -521,6 +550,11 @@ class TransactionGroupTransformer extends AbstractTransformer
'due_date' => $this->dateFromArray($metaDateData, 'due_date'),
'payment_date' => $this->dateFromArray($metaDateData, 'payment_date'),
'invoice_date' => $this->dateFromArray($metaDateData, 'invoice_date'),
// location data
'longitude' => $longitude,
'latitude' => $latitude,
'zoom_level' => $zoomLevel,
];
}
@@ -528,6 +562,7 @@ class TransactionGroupTransformer extends AbstractTransformer
* @param array $array
* @param string $key
* @param string|null $default
*
* @return string|null
*/
private function stringFromArray(array $array, string $key, ?string $default): ?string
@@ -538,12 +573,14 @@ class TransactionGroupTransformer extends AbstractTransformer
if (null !== $default) {
return $default;
}
return null;
}
/**
* @param array $array
* @param string $key
*
* @return int|null
*/
private function integerFromArray(array $array, string $key): ?int
@@ -551,12 +588,14 @@ class TransactionGroupTransformer extends AbstractTransformer
if (array_key_exists($key, $array)) {
return (int)$array[$key];
}
return null;
}
/**
* @param NullArrayObject $object
* @param string $key
*
* @return string|null
*/
private function dateFromArray(NullArrayObject $object, string $key): ?string
@@ -567,4 +606,24 @@ class TransactionGroupTransformer extends AbstractTransformer
return $object[$key]->toAtomString();
}
/**
* @param TransactionJournal $journal
*
* @return Location|null
*/
private function getLocation(TransactionJournal $journal): ?Location
{
return $journal->locations()->first();
}
/**
* @param int $journalId
*
* @return Location|null
*/
private function getLocationById(int $journalId): ?Location
{
return $this->groupRepos->getLocation($journalId);
}
}