kenmirrors/firefly-iii
1
0
Fork 0
mirror of https://github.com/firefly-iii/firefly-iii.git synced 2025-09-05 04:03:26 +00:00
Code Issues Projects Releases Wiki Activity

Extend help pages.

Browse Source
This commit is contained in:
James Cole
2016-11-02 14:33:57 +01:00
parent b980b5baea
commit 2ddd4314f1
4 changed files with 29 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
app/Helpers/Help/Help.php
View File

@@ -26,6 +26,8 @@ use Route;
*/
class Help implements HelpInterface
{
/** @var string */
protected $userAgent = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.71 Safari/537.36';
/**
* @param string $route
@@ -51,9 +53,10 @@ class Help implements HelpInterface
$uri = sprintf('https://raw.githubusercontent.com/firefly-iii/help/master/%s/%s.md', $language, $route);
Log::debug(sprintf('Trying to get %s...', $uri));
$opt = ['useragent' => $this->userAgent];
$content = '';
try {
$result = Requests::get($uri);
$result = Requests::get($uri, [], $opt);
} catch (Requests_Exception $e) {
Log::error($e);
@@ -71,6 +74,9 @@ class Help implements HelpInterface
$converter = new CommonMarkConverter();
$content = $converter->convertToHtml($content);
}
if (strlen($content) === 0) {
Log::warning('Raw content length is zero.');
}
return $content;
@@ -95,7 +101,7 @@ class Help implements HelpInterface
*/
public function inCache(string $route, string $language):bool
{
$line = sprintf('help.%s.%s', $route, $language);
$line = sprintf('help.%s.%s', $route, $language);
$result = Cache::has($line);
if ($result) {
Log::debug(sprintf('Cache has this entry: %s', 'help.' . $route . '.' . $language));
@@ -119,7 +125,11 @@ class Help implements HelpInterface
public function putInCache(string $route, string $language, string $content)
{
$key = sprintf('help.%s.%s', $route, $language);
Log::debug(sprintf('Will store entry in cache: %s', $key));
Cache::put($key, $content, 10080); // a week.
if (strlen($content) > 0) {
Log::debug(sprintf('Will store entry in cache: %s', $key));
Cache::put($key, $content, 10080); // a week.
return;
}
Log::info(sprintf('Will not cache %s because content is empty.', $key));
}
}