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

88 lines
2.3 KiB
PHP
Raw Normal View History

2016-05-20 01:57:45 -05:00
<?php
/**
* HelpController.php
* Copyright (C) 2016 thegrumpydictator@gmail.com
*
* This software may be modified and distributed under the terms of the
* Creative Commons Attribution-ShareAlike 4.0 International License.
*
* See the LICENSE file for details.
*/
2016-05-20 01:57:45 -05:00
declare(strict_types = 1);
namespace FireflyIII\Http\Controllers;
2015-02-25 09:10:02 -06:00
2015-04-07 12:58:49 -05:00
use FireflyIII\Helpers\Help\HelpInterface;
2015-04-07 11:26:14 -05:00
use Log;
use Preferences;
2015-02-25 09:10:02 -06:00
use Response;
2015-04-07 11:26:14 -05:00
2015-02-25 09:10:02 -06:00
/**
* Class HelpController
*
* @package FireflyIII\Http\Controllers
*/
2015-03-10 11:26:31 -05:00
class HelpController extends Controller
{
/**
* HelpController constructor.
*/
2016-01-08 11:29:47 -06:00
public function __construct()
{
2016-01-08 13:40:48 -06:00
parent::__construct();
2016-01-08 11:29:47 -06:00
}
2015-02-25 09:10:02 -06:00
/**
2015-05-03 05:58:55 -05:00
* @param HelpInterface $help
* @param $route
2015-02-25 09:10:02 -06:00
*
* @return \Illuminate\Http\JsonResponse
*/
2016-02-05 02:25:15 -06:00
public function show(HelpInterface $help, string $route)
2015-02-25 09:10:02 -06:00
{
2016-10-23 10:33:53 -05:00
$language = Preferences::get('language', config('firefly.default_language', 'en_US'))->data;
$content = '<p>' . strval(trans('firefly.route_has_no_help')) . '</p>';
2015-02-25 09:10:02 -06:00
2015-04-07 12:58:49 -05:00
if (!$help->hasRoute($route)) {
2015-04-07 11:25:21 -05:00
Log::error('No such route: ' . $route);
2015-02-25 09:10:02 -06:00
return Response::json($content);
}
2016-10-23 10:33:53 -05:00
if ($help->inCache($route, $language)) {
$content = $help->getFromCache($route, $language);
2016-11-02 08:33:57 -05:00
Log::debug(sprintf('Help text %s was in cache.', $language));
2015-02-25 09:10:02 -06:00
return Response::json($content);
}
2016-04-09 02:27:04 -05:00
2016-04-09 02:20:16 -05:00
$content = $help->getFromGithub($language, $route);
2015-02-25 09:10:02 -06:00
// get backup language content (try English):
if (strlen($content) === 0) {
2016-11-02 08:33:57 -05:00
$language = 'en_US';
if ($help->inCache($route, $language)) {
Log::debug(sprintf('Help text %s was in cache.', $language));
$content = $help->getFromCache($route, $language);
}
if (!$help->inCache($route, $language)) {
$content = $help->getFromGithub($language, $route);
$content = '<p><em>' . strval(trans('firefly.help_may_not_be_your_language')) . '</em></p>' . $content;
}
}
if (strlen($content) === 0) {
$content = '<p>' . strval(trans('firefly.route_has_no_help')) . '</p>';
}
2016-04-09 02:27:04 -05:00
$help->putInCache($route, $language, $content);
2015-02-25 09:10:02 -06:00
return Response::json($content);
}
}