firefly-iii/app/Api/V1/Controllers/PreferenceController.php

<?php
/**
 * PreferenceController.php
 * 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\Api\V1\Controllers;

use FireflyIII\Api\V1\Requests\PreferenceRequest;
use FireflyIII\Models\AccountType;
use FireflyIII\Models\Preference;
use FireflyIII\Repositories\Account\AccountRepositoryInterface;
use FireflyIII\Transformers\PreferenceTransformer;
use FireflyIII\User;
use Illuminate\Http\JsonResponse;
use Illuminate\Support\Collection;
use League\Fractal\Resource\Collection as FractalCollection;
use League\Fractal\Resource\Item;

/**
 *
 * Class PreferenceController
 */
class PreferenceController extends Controller
{
    /**
     * LinkTypeController constructor.
     *
     * @codeCoverageIgnore
     */
    public function __construct()
    {
        parent::__construct();
        $this->middleware(
            static function ($request, $next) {
                /** @var User $user */
                $user       = auth()->user();
                $repository = app(AccountRepositoryInterface::class);
                $repository->setUser($user);

                // an important fallback is that the frontPageAccount array gets refilled automatically
                // when it turns up empty.
                $frontPageAccounts = app('preferences')->getForUser($user, 'frontPageAccounts', [])->data;
                if (0 === count($frontPageAccounts)) {
                    /** @var Collection $accounts */
                    $accounts   = $repository->getAccountsByType([AccountType::DEFAULT, AccountType::ASSET]);
                    $accountIds = $accounts->pluck('id')->toArray();
                    app('preferences')->setForUser($user, 'frontPageAccounts', $accountIds);
                }

                return $next($request);
            }
        );
    }

    /**
     * List all of them.
     *
     * @return JsonResponse
     * @codeCoverageIgnore
     */
    public function index(): JsonResponse
    {
        /** @var User $user */
        $user      = auth()->user();
        $available = [
            'language', 'customFiscalYear', 'fiscalYearStart', 'currencyPreference',
            'transaction_journal_optional_fields', 'frontPageAccounts', 'viewRange',
            'listPageSize',
        ];

        $preferences = new Collection;
        foreach ($available as $name) {
            $pref = app('preferences')->getForUser($user, $name);
            if (null !== $pref) {
                $preferences->push($pref);
            }
        }

        $manager = $this->getManager();

        /** @var PreferenceTransformer $transformer */
        $transformer = app(PreferenceTransformer::class);
        $transformer->setParameters($this->parameters);

        $resource = new FractalCollection($preferences, $transformer, 'preferences');

        return response()->json($manager->createData($resource)->toArray())->header('Content-Type', 'application/vnd.api+json');

    }

    /**
     * Return a single preference by name.
     *
     * @param Preference $preference
     *
     * @return JsonResponse
     * @codeCoverageIgnore
     */
    public function show(Preference $preference): JsonResponse
    {
        $manager = $this->getManager();
        /** @var PreferenceTransformer $transformer */
        $transformer = app(PreferenceTransformer::class);
        $transformer->setParameters($this->parameters);

        $resource = new Item($preference, $transformer, 'preferences');

        return response()->json($manager->createData($resource)->toArray())->header('Content-Type', 'application/vnd.api+json');
    }

    /**
     * Update a preference.
     *
     * @param PreferenceRequest $request
     * @param Preference        $preference
     *
     * @return JsonResponse
     */
    public function update(PreferenceRequest $request, Preference $preference): JsonResponse
    {

        $data     = $request->getAll();
        $newValue = $data['data'];
        switch ($preference->name) {
            default:
                break;
            case 'transaction_journal_optional_fields':
            case 'frontPageAccounts':
                $newValue = explode(',', $data['data']);
                break;
            case 'listPageSize':
                $newValue = (int)$data['data'];
                break;
            case 'customFiscalYear':
                $newValue = 1 === (int)$data['data'];
                break;
        }
        $result = app('preferences')->set($preference->name, $newValue);

        $manager = $this->getManager();
        /** @var PreferenceTransformer $transformer */
        $transformer = app(PreferenceTransformer::class);
        $transformer->setParameters($this->parameters);

        $resource = new Item($result, $transformer, 'preferences');

        return response()->json($manager->createData($resource)->toArray())->header('Content-Type', 'application/vnd.api+json');

    }
}