| 
									
										
										
										
											2018-02-11 20:45:33 +01:00
										 |  |  | <?php | 
					
						
							| 
									
										
										
										
											2024-11-25 04:18:55 +01:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2018-02-11 20:45:33 +01:00
										 |  |  | /** | 
					
						
							|  |  |  |  * CategoryTransformer.php | 
					
						
							| 
									
										
										
										
											2020-02-16 13:57:18 +01:00
										 |  |  |  * Copyright (c) 2019 james@firefly-iii.org | 
					
						
							| 
									
										
										
										
											2018-02-11 20:45:33 +01:00
										 |  |  |  * | 
					
						
							| 
									
										
										
										
											2019-10-02 06:37:26 +02:00
										 |  |  |  * This file is part of Firefly III (https://github.com/firefly-iii). | 
					
						
							| 
									
										
										
										
											2018-02-11 20:45:33 +01:00
										 |  |  |  * | 
					
						
							| 
									
										
										
										
											2019-10-02 06:37:26 +02:00
										 |  |  |  * 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. | 
					
						
							| 
									
										
										
										
											2018-02-11 20:45:33 +01:00
										 |  |  |  * | 
					
						
							| 
									
										
										
										
											2019-10-02 06:37:26 +02:00
										 |  |  |  * This program is distributed in the hope that it will be useful, | 
					
						
							| 
									
										
										
										
											2018-02-11 20:45:33 +01:00
										 |  |  |  * but WITHOUT ANY WARRANTY; without even the implied warranty of | 
					
						
							|  |  |  |  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the | 
					
						
							| 
									
										
										
										
											2019-10-02 06:37:26 +02:00
										 |  |  |  * GNU Affero General Public License for more details. | 
					
						
							| 
									
										
										
										
											2018-02-11 20:45:33 +01:00
										 |  |  |  * | 
					
						
							| 
									
										
										
										
											2019-10-02 06:37:26 +02:00
										 |  |  |  * 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/>. | 
					
						
							| 
									
										
										
										
											2018-02-11 20:45:33 +01:00
										 |  |  |  */ | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | declare(strict_types=1); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | namespace FireflyIII\Transformers; | 
					
						
							| 
									
										
										
										
											2021-09-18 10:26:12 +02:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2018-02-11 20:45:33 +01:00
										 |  |  | use FireflyIII\Models\Category; | 
					
						
							| 
									
										
										
										
											2025-01-18 17:20:39 +01:00
										 |  |  | use FireflyIII\Models\TransactionCurrency; | 
					
						
							| 
									
										
										
										
											2020-10-28 06:32:37 +01:00
										 |  |  | use FireflyIII\Repositories\Category\CategoryRepositoryInterface; | 
					
						
							| 
									
										
										
										
											2019-08-27 10:52:07 +02:00
										 |  |  | use FireflyIII\Repositories\Category\OperationsRepositoryInterface; | 
					
						
							| 
									
										
										
										
											2025-01-18 17:20:39 +01:00
										 |  |  | use FireflyIII\Support\Facades\Amount; | 
					
						
							| 
									
										
										
										
											2018-02-17 10:47:06 +01:00
										 |  |  | use Illuminate\Support\Collection; | 
					
						
							| 
									
										
										
										
											2018-02-11 20:45:33 +01:00
										 |  |  | 
 | 
					
						
							|  |  |  | /** | 
					
						
							|  |  |  |  * Class CategoryTransformer | 
					
						
							|  |  |  |  */ | 
					
						
							| 
									
										
										
										
											2018-12-15 22:03:42 +01:00
										 |  |  | class CategoryTransformer extends AbstractTransformer | 
					
						
							| 
									
										
										
										
											2018-02-11 20:45:33 +01:00
										 |  |  | { | 
					
						
							| 
									
										
										
										
											2020-10-28 06:32:37 +01:00
										 |  |  |     private OperationsRepositoryInterface $opsRepository; | 
					
						
							|  |  |  |     private CategoryRepositoryInterface   $repository; | 
					
						
							| 
									
										
										
										
											2025-01-18 17:20:39 +01:00
										 |  |  |     private TransactionCurrency           $default; | 
					
						
							|  |  |  |     private bool                          $convertToNative; | 
					
						
							| 
									
										
										
										
											2018-12-19 19:02:16 +01:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2018-02-11 20:45:33 +01:00
										 |  |  |     /** | 
					
						
							| 
									
										
										
										
											2018-02-17 10:47:06 +01:00
										 |  |  |      * CategoryTransformer constructor. | 
					
						
							| 
									
										
										
										
											2018-02-11 20:45:33 +01:00
										 |  |  |      */ | 
					
						
							| 
									
										
										
										
											2018-12-15 22:03:42 +01:00
										 |  |  |     public function __construct() | 
					
						
							| 
									
										
										
										
											2018-02-11 20:45:33 +01:00
										 |  |  |     { | 
					
						
							| 
									
										
										
										
											2025-01-18 17:20:39 +01:00
										 |  |  |         $this->opsRepository   = app(OperationsRepositoryInterface::class); | 
					
						
							|  |  |  |         $this->repository      = app(CategoryRepositoryInterface::class); | 
					
						
							|  |  |  |         $this->default         = Amount::getDefaultCurrency(); | 
					
						
							|  |  |  |         $this->convertToNative = Amount::convertToNative(); | 
					
						
							| 
									
										
										
										
											2018-02-11 20:45:33 +01:00
										 |  |  |     } | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2018-02-17 10:47:06 +01:00
										 |  |  |     /** | 
					
						
							|  |  |  |      * Convert category. | 
					
						
							| 
									
										
										
										
											2018-02-11 20:45:33 +01:00
										 |  |  |      */ | 
					
						
							|  |  |  |     public function transform(Category $category): array | 
					
						
							|  |  |  |     { | 
					
						
							| 
									
										
										
										
											2019-08-27 10:52:07 +02:00
										 |  |  |         $this->opsRepository->setUser($category->user); | 
					
						
							| 
									
										
										
										
											2020-10-28 06:32:37 +01:00
										 |  |  |         $this->repository->setUser($category->user); | 
					
						
							| 
									
										
										
										
											2019-08-27 10:52:07 +02:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2018-12-12 20:30:25 +01:00
										 |  |  |         $spent  = []; | 
					
						
							|  |  |  |         $earned = []; | 
					
						
							|  |  |  |         $start  = $this->parameters->get('start'); | 
					
						
							|  |  |  |         $end    = $this->parameters->get('end'); | 
					
						
							|  |  |  |         if (null !== $start && null !== $end) { | 
					
						
							| 
									
										
										
										
											2019-08-28 12:28:23 +02:00
										 |  |  |             $earned = $this->beautify($this->opsRepository->sumIncome($start, $end, null, new Collection([$category]))); | 
					
						
							|  |  |  |             $spent  = $this->beautify($this->opsRepository->sumExpenses($start, $end, null, new Collection([$category]))); | 
					
						
							| 
									
										
										
										
											2018-12-12 20:30:25 +01:00
										 |  |  |         } | 
					
						
							| 
									
										
										
										
											2025-01-18 17:20:39 +01:00
										 |  |  |         $default = $this->default; | 
					
						
							|  |  |  |         if (!$this->convertToNative) { | 
					
						
							|  |  |  |             $default = null; | 
					
						
							|  |  |  |         } | 
					
						
							|  |  |  |         $notes = $this->repository->getNoteText($category); | 
					
						
							| 
									
										
										
										
											2020-10-28 06:32:37 +01:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2020-10-23 19:11:25 +02:00
										 |  |  |         return [ | 
					
						
							| 
									
										
										
										
											2025-01-18 17:20:39 +01:00
										 |  |  |             'id'                             => $category->id, | 
					
						
							|  |  |  |             'created_at'                     => $category->created_at->toAtomString(), | 
					
						
							|  |  |  |             'updated_at'                     => $category->updated_at->toAtomString(), | 
					
						
							|  |  |  |             'name'                           => $category->name, | 
					
						
							|  |  |  |             'notes'                          => $notes, | 
					
						
							|  |  |  |             'native_currency_id'             => null === $default ? null : (string) $default->id, | 
					
						
							|  |  |  |             'native_currency_code'           => $default?->code, | 
					
						
							|  |  |  |             'native_currency_symbol'         => $default?->symbol, | 
					
						
							|  |  |  |             'native_currency_decimal_places' => $default?->decimal_places, | 
					
						
							|  |  |  |             'spent'                          => $spent, | 
					
						
							|  |  |  |             'earned'                         => $earned, | 
					
						
							|  |  |  |             'links'                          => [ | 
					
						
							| 
									
										
										
										
											2018-02-11 20:45:33 +01:00
										 |  |  |                 [ | 
					
						
							|  |  |  |                     'rel' => 'self', | 
					
						
							| 
									
										
										
										
											2025-01-18 17:20:39 +01:00
										 |  |  |                     'uri' => '/categories/' . $category->id, | 
					
						
							| 
									
										
										
										
											2018-02-11 20:45:33 +01:00
										 |  |  |                 ], | 
					
						
							|  |  |  |             ], | 
					
						
							|  |  |  |         ]; | 
					
						
							|  |  |  |     } | 
					
						
							| 
									
										
										
										
											2019-08-28 12:28:23 +02:00
										 |  |  | 
 | 
					
						
							|  |  |  |     private function beautify(array $array): array | 
					
						
							|  |  |  |     { | 
					
						
							|  |  |  |         $return = []; | 
					
						
							|  |  |  |         foreach ($array as $data) { | 
					
						
							| 
									
										
										
										
											2024-12-22 08:43:12 +01:00
										 |  |  |             $data['sum'] = app('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
										 |  |  | } |