Files
firefly-iii/app/Transformers/CategoryTransformer.php

96 lines
3.5 KiB
PHP
Raw Normal View History

<?php
/**
* CategoryTransformer.php
2020-02-16 13:57:18 +01:00
* Copyright (c) 2019 james@firefly-iii.org
*
* 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\Transformers;
use FireflyIII\Models\Category;
2025-01-18 17:20:39 +01:00
use FireflyIII\Models\TransactionCurrency;
use FireflyIII\Support\Facades\Amount;
2025-08-04 20:55:31 +02:00
use FireflyIII\Support\Facades\Steam;
/**
* Class CategoryTransformer
*/
class CategoryTransformer extends AbstractTransformer
{
2025-08-04 20:55:31 +02:00
private readonly TransactionCurrency $primaryCurrency;
/**
2018-02-17 10:47:06 +01:00
* CategoryTransformer constructor.
*/
public function __construct()
{
2025-08-04 20:55:31 +02:00
$this->primaryCurrency = Amount::getPrimaryCurrency();
}
2018-02-17 10:47:06 +01:00
/**
* Convert category.
*/
public function transform(Category $category): array
{
2020-10-28 06:32:37 +01:00
2020-10-23 19:11:25 +02:00
return [
'id' => $category->id,
'created_at' => $category->created_at->toAtomString(),
'updated_at' => $category->updated_at->toAtomString(),
'name' => $category->name,
'notes' => $category->meta['notes'],
2025-08-04 20:55:31 +02:00
// category never has currency settings.
'object_has_currency_setting' => false,
2025-08-04 20:55:31 +02:00
'primary_currency_id' => (string)$this->primaryCurrency->id,
2025-08-05 19:49:13 +02:00
'primary_currency_name' => $this->primaryCurrency->name,
2025-08-04 20:55:31 +02:00
'primary_currency_code' => $this->primaryCurrency->code,
'primary_currency_symbol' => $this->primaryCurrency->symbol,
'primary_currency_decimal_places' => (int)$this->primaryCurrency->decimal_places,
'spent' => $this->beautify($category->meta['spent']),
'pc_spent' => $this->beautify($category->meta['pc_spent']),
'earned' => $this->beautify($category->meta['earned']),
'pc_earned' => $this->beautify($category->meta['pc_earned']),
'transferred' => $this->beautify($category->meta['transfers']),
'pc_transferred' => $this->beautify($category->meta['pc_transfers']),
2025-07-31 20:35:44 +02:00
'links' => [
[
'rel' => 'self',
'uri' => '/categories/'.$category->id,
],
],
];
}
2019-08-28 12:28:23 +02:00
2025-08-16 06:02:26 +02:00
private function beautify(?array $array): ?array
2019-08-28 12:28:23 +02:00
{
if (null === $array) {
2025-08-16 06:02:26 +02:00
return null;
}
2019-08-28 12:28:23 +02:00
$return = [];
foreach ($array as $data) {
2025-08-03 17:42:07 +02:00
$data['sum'] = Steam::bcround($data['sum'], (int)$data['currency_decimal_places']);
2019-08-28 12:28:23 +02:00
$return[] = $data;
}
return $return;
}
2018-03-05 19:35:58 +01:00
}