firefly-iii/app/Transformers/CurrencyExchangeRateTransformer.php

<?php
/**
 * CurrencyExchangeRateTransformer.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\CurrencyExchangeRate;
use League\Fractal\Resource\Item;
use League\Fractal\TransformerAbstract;
use Symfony\Component\HttpFoundation\ParameterBag;

/**
 * Class CurrencyExchangeRateTransformer
 */
class CurrencyExchangeRateTransformer extends TransformerAbstract
{
    /**
     * List of resources possible to include
     *
     * @var array
     */
    protected $availableIncludes = ['from_currency', 'to_currency'];
    /**
     * List of resources to automatically include
     *
     * @var array
     */
    protected $defaultIncludes = ['from_currency', 'to_currency'];

    /** @var ParameterBag */
    protected $parameters;

    /**
     * PiggyBankEventTransformer constructor.
     *
     * @codeCoverageIgnore
     *
     * @param ParameterBag $parameters
     */
    public function __construct(ParameterBag $parameters)
    {
        $this->parameters = $parameters;
    }

    /**
     * @param CurrencyExchangeRate $rate
     *
     * @return Item
     */
    public function includeFromCurrency(CurrencyExchangeRate $rate): Item
    {
        return $this->item($rate->fromCurrency, new CurrencyTransformer($this->parameters), 'transaction_currencies');
    }

    /**
     * @param CurrencyExchangeRate $rate
     *
     * @return \League\Fractal\Resource\Item
     */
    public function includeToCurrency(CurrencyExchangeRate $rate): Item
    {
        return $this->item($rate->toCurrency, new CurrencyTransformer($this->parameters), 'transaction_currencies');
    }

    /**
     * @param CurrencyExchangeRate $rate
     *
     * @return array
     */
    public function transform(CurrencyExchangeRate $rate): array
    {
        $data = [
            'id'         => (int)$rate->id,
            'updated_at' => $rate->updated_at->toAtomString(),
            'created_at' => $rate->created_at->toAtomString(),
            'rate'       => (float)$rate->rate,
            'links'      => [
                [
                    'rel' => 'self',
                    'uri' => '/currency_exchange_rates/' . $rate->id,
                ],
            ],
        ];

        return $data;
    }
}