kenmirrors/firefly-iii
1
0
Fork 0
mirror of https://github.com/firefly-iii/firefly-iii.git synced 2025-10-03 11:08:28 +00:00
Code Issues Projects Releases Wiki Activity

Expand and fix account API

Browse Source
This commit is contained in:
James Cole
2024-08-01 20:45:42 +02:00
parent faa0d59340
commit f33ffb98ff
9 changed files with 159 additions and 93 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
app/JsonApi/V2/Accounts/AccountRepository.php
View File

@@ -28,8 +28,10 @@ use FireflyIII\Support\JsonApi\Concerns\UsergroupAware;
use FireflyIII\Support\JsonApi\Enrichments\AccountEnrichment;
use Illuminate\Support\Facades\Log;
use LaravelJsonApi\Contracts\Store\QueriesAll;
use LaravelJsonApi\Contracts\Store\QueryOneBuilder;
use LaravelJsonApi\NonEloquent\AbstractRepository;
use LaravelJsonApi\NonEloquent\Capabilities\CrudRelations;
use LaravelJsonApi\NonEloquent\Capabilities\CrudResource;
use LaravelJsonApi\NonEloquent\Concerns\HasCrudCapability;
use LaravelJsonApi\NonEloquent\Concerns\HasRelationsCapability;
@@ -52,17 +54,21 @@ class AccountRepository extends AbstractRepository implements QueriesAll
/**
* SiteRepository constructor.
*/
public function __construct() {}
public function __construct() {
Log::debug(__METHOD__);
}
public function exists(string $resourceId): bool
{
Log::debug(__METHOD__);
$result = null !== Account::find((int) $resourceId);
Log::debug(sprintf('%s: %s',__METHOD__, var_export($result, true)));
return null !== Account::find((int) $resourceId);
return $result;
}
public function find(string $resourceId): ?object
{
die(__METHOD__);
Log::debug(__METHOD__);
// throw new \RuntimeException('trace me');
$account = Account::find((int) $resourceId);
@@ -88,11 +94,13 @@ class AccountRepository extends AbstractRepository implements QueriesAll
protected function crud(): Capabilities\CrudAccount
{
Log::debug(__METHOD__);
return Capabilities\CrudAccount::make();
}
protected function relations(): CrudRelations
{
Log::debug(__METHOD__);
return Capabilities\CrudAccountRelations::make();
}
}

24
app/JsonApi/V2/Accounts/AccountResource.php
View File

@@ -19,9 +19,10 @@ class AccountResource extends JsonApiResource
*/
public function id(): string
{
Log::debug(__METHOD__);
$id = (string) $this->resource->id;
Log::debug(sprintf('%s: "%s"', __METHOD__, $id));
return (string) $this->resource->id;
return $id;
}
/**
@@ -39,7 +40,7 @@ class AccountResource extends JsonApiResource
'name' => $this->resource->name,
'active' => $this->resource->active,
'order' => $this->resource->order,
'iban' => $this->resource->iban,
'iban' => $this->resource->iban,
'type' => $this->resource->account_type_string,
'account_role' => $this->resource->account_role,
'account_number' => '' === $this->resource->account_number ? null : $this->resource->account_number,
@@ -62,23 +63,14 @@ class AccountResource extends JsonApiResource
'interest_period' => $this->resource->interest_period,
'current_debt' => $this->resource->current_debt, // TODO may be removed in the future.
// other things
'last_activity' => $this->resource->last_activity,
'last_activity' => $this->resource->last_activity,
// still to do
// balance difference
// 'balance_difference' => $balanceDiff,
// 'native_balance_difference' => $nativeBalanceDiff,
// 'balance_difference_start' => $diffStart,
// 'balance_difference_end' => $diffEnd,
// object group
// 'object_group_id' => null !== $objectGroupId ? (string) $objectGroupId : null,
// 'object_group_order' => $objectGroupOrder,
// 'object_group_title' => $objectGroupTitle,
'object_group_id' => $this->resource->object_group_id,
'object_group_title' => $this->resource->object_group_title,
'object_group_order' => $this->resource->object_group_order,
];
}

13
app/JsonApi/V2/Accounts/AccountSchema.php
View File

@@ -76,13 +76,12 @@ class AccountSchema extends Schema
public function repository(): AccountRepository
{
Log::debug(__METHOD__);
$this->setUserGroup($this->server->getUsergroup());
return AccountRepository::make()
->withServer($this->server)
->withSchema($this)
->withUserGroup($this->userGroup)
;
$repository = AccountRepository::make()
->withServer($this->server)
->withSchema($this)
->withUserGroup($this->userGroup);
Log::debug(sprintf('%s: %s', __METHOD__, get_class($repository)));
return $repository;
}
}

3
app/JsonApi/V2/Accounts/Capabilities/AccountQuery.php
View File

@@ -48,6 +48,8 @@ class AccountQuery extends QueryAll implements HasPagination
#[\Override]
/**
* This method returns all accounts, given a bunch of filters and sort fields, together with pagination.
*
* It is only used on the index, and nowhere else.
*/
public function get(): iterable
{
@@ -77,6 +79,7 @@ class AccountQuery extends QueryAll implements HasPagination
$query = $this->addSortParams($query, $sort);
$query = $this->addFilterParams('account', $query, $filters);
// collect the result.
$collection = $query->get(['accounts.*']);

12
app/JsonApi/V2/Accounts/Capabilities/CrudAccount.php
View File

@@ -24,19 +24,31 @@ declare(strict_types=1);
namespace FireflyIII\JsonApi\V2\Accounts\Capabilities;
use FireflyIII\Models\Account;
use FireflyIII\Support\JsonApi\CollectsCustomParameters;
use FireflyIII\Support\JsonApi\Enrichments\AccountEnrichment;
use Illuminate\Support\Facades\Log;
use LaravelJsonApi\NonEloquent\Capabilities\CrudResource;
class CrudAccount extends CrudResource
{
use CollectsCustomParameters;
/**
* Read the supplied site.
*/
public function read(Account $account): ?Account
{
$otherParams = $this->getOtherParams($this->request->query->all());
Log::debug(__METHOD__);
// enrich the collected data
$enrichment = new AccountEnrichment();
// set start and date, if present.
$enrichment->setStart($otherParams['start'] ?? null);
$enrichment->setEnd($otherParams['end'] ?? null);
return $enrichment->enrichSingle($account);
}
}