firefly-iii/app/Helpers/Help/HelpInterface.php

61 lines
1.2 KiB
PHP
Raw Normal View History

2015-04-07 12:58:49 -05:00
<?php
/**
* HelpInterface.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-02-05 05:08:25 -06:00
declare(strict_types = 1);
2015-04-07 12:58:49 -05:00
namespace FireflyIII\Helpers\Help;
/**
* Interface HelpInterface
*
* @package FireflyIII\Helpers\Help
*/
interface HelpInterface
{
/**
2016-10-23 10:33:53 -05:00
* @param string $route
* @param string $language
2015-04-07 12:58:49 -05:00
*
* @return string
*/
2016-10-23 10:33:53 -05:00
public function getFromCache(string $route, string $language): string;
2015-04-07 12:58:49 -05:00
/**
2016-02-05 02:25:15 -06:00
* @param string $route
2017-03-19 11:54:21 -05:00
* @param string $language
2015-04-07 12:58:49 -05:00
*
2016-10-23 10:33:53 -05:00
* @return string
2015-04-07 12:58:49 -05:00
*/
2017-03-19 11:54:21 -05:00
public function getFromGithub(string $route, string $language): string;
2015-04-07 12:58:49 -05:00
/**
2016-02-05 02:25:15 -06:00
* @param string $route
2015-04-07 12:58:49 -05:00
*
2015-05-03 05:58:55 -05:00
* @return bool
2015-04-07 12:58:49 -05:00
*/
public function hasRoute(string $route): bool;
2015-04-07 12:58:49 -05:00
/**
2016-02-05 02:25:15 -06:00
* @param string $route
2016-10-23 10:33:53 -05:00
* @param string $language
2015-04-07 12:58:49 -05:00
*
* @return bool
*/
2016-11-05 05:47:21 -05:00
public function inCache(string $route, string $language): bool;
2015-05-03 05:58:55 -05:00
/**
2016-02-05 02:25:15 -06:00
* @param string $route
2016-04-09 02:27:04 -05:00
* @param string $language
2016-10-23 10:33:53 -05:00
* @param string $content
2015-05-03 05:58:55 -05:00
*/
2016-10-23 10:33:53 -05:00
public function putInCache(string $route, string $language, string $content);
}