firefly-iii/app/Transformers/V2/AbstractTransformer.php

<?php

/*
 * AbstractTransformer.php
 * Copyright (c) 2022 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\V2;

use Illuminate\Support\Collection;
use League\Fractal\TransformerAbstract;
use Symfony\Component\HttpFoundation\ParameterBag;

/**
 * Class AbstractTransformer
 */
abstract class AbstractTransformer extends TransformerAbstract
{
    protected ParameterBag $parameters;

    /**
     * This method is called exactly ONCE from FireflyIII\Api\V2\Controllers\Controller::jsonApiList
     *
     * @param Collection $objects
     *
     * @return void
     */
    abstract public function collectMetaData(Collection $objects): void;


    /**
     * @return ParameterBag
     */
    final public function getParameters(): ParameterBag
    {
        return $this->parameters;
    }

    /**
     * @param ParameterBag $parameters
     */
    final public function setParameters(ParameterBag $parameters): void
    {
        $this->parameters = $parameters;
    }
}