Files
firefly-iii/app/Http/Controllers/HelpController.php

50 lines
1.5 KiB
PHP
Raw Normal View History

2016-05-20 08:57:45 +02:00
<?php
/**
* HelpController.php
2020-01-31 07:32:04 +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.
2017-10-21 08:40:00 +02:00
*
* This program is distributed in the hope that it will be useful,
2017-10-21 08:40:00 +02:00
* 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.
2017-10-21 08:40:00 +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/>.
*/
declare(strict_types=1);
2016-05-20 08:57:45 +02:00
namespace FireflyIII\Http\Controllers;
2015-02-25 16:10:02 +01:00
2018-07-08 12:28:42 +02:00
use Illuminate\Http\JsonResponse;
2015-04-07 18:26:14 +02:00
2015-02-25 16:10:02 +01:00
/**
2017-11-15 12:25:49 +01:00
* Class HelpController.
2015-02-25 16:10:02 +01:00
*/
2015-03-10 17:26:31 +01:00
class HelpController extends Controller
{
2015-02-25 16:10:02 +01:00
/**
2018-07-22 08:10:16 +02:00
* Show help for a route.
*
2021-04-27 06:23:16 +02:00
* @param string $route
2015-02-25 16:10:02 +01:00
*
2018-07-08 12:28:42 +02:00
* @return JsonResponse
2021-09-18 10:21:29 +02:00
* @throws \FireflyIII\Exceptions\FireflyException
2015-02-25 16:10:02 +01:00
*/
2018-07-08 12:28:42 +02:00
public function show(string $route): JsonResponse
2015-02-25 16:10:02 +01:00
{
2018-07-27 04:46:21 +02:00
/** @var string $language */
$language = app('preferences')->get('language', config('firefly.default_language', 'en_US'))->data;
2017-07-23 07:30:05 +02:00
$html = $this->getHelpText($route, $language);
2018-03-10 20:30:09 +01:00
return response()->json(['html' => $html]);
2017-07-23 07:30:05 +02:00
}
2015-02-25 16:10:02 +01:00
}