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

52 lines
1.5 KiB
PHP
Raw Normal View History

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