kenmirrors/firefly-iii
1
0
Fork 0
mirror of https://github.com/firefly-iii/firefly-iii.git synced 2025-11-17 23:28:20 +00:00
Code Issues Projects Releases Wiki Activity

Expand documentation for Helper directory.

Browse Source
This commit is contained in:
James Cole
2018-07-07 23:14:16 +02:00
parent 8e08ff2d39
commit 10492e3b2f
30 changed files with 328 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
app/Helpers/Help/HelpInterface.php
View File

@@ -28,6 +28,8 @@ namespace FireflyIII\Helpers\Help;
interface HelpInterface
{
/**
* Get the help text from cache.
*
* @param string $route
* @param string $language
*
@@ -36,14 +38,18 @@ interface HelpInterface
public function getFromCache(string $route, string $language): string;
/**
* Get the help text from GitHub.
*
* @param string $route
* @param string $language
*
* @return string
*/
public function getFromGithub(string $route, string $language): string;
public function getFromGitHub(string $route, string $language): string;
/**
* Is the route a known route?
*
* @param string $route
*
* @return bool
@@ -51,6 +57,8 @@ interface HelpInterface
public function hasRoute(string $route): bool;
/**
* Is the help text in cache?
*
* @param string $route
* @param string $language
*
@@ -59,6 +67,8 @@ interface HelpInterface
public function inCache(string $route, string $language): bool;
/**
* Put the result in cache.
*
* @param string $route
* @param string $language
* @param string $content