|
1
|
|
|
<?php |
|
2
|
|
|
/** |
|
3
|
|
|
* sysPass |
|
4
|
|
|
* |
|
5
|
|
|
* @author nuxsmin |
|
6
|
|
|
* @link https://syspass.org |
|
7
|
|
|
* @copyright 2012-2018, Rubén Domínguez nuxsmin@$syspass.org |
|
8
|
|
|
* |
|
9
|
|
|
* This file is part of sysPass. |
|
10
|
|
|
* |
|
11
|
|
|
* sysPass is free software: you can redistribute it and/or modify |
|
12
|
|
|
* it under the terms of the GNU General Public License as published by |
|
13
|
|
|
* the Free Software Foundation, either version 3 of the License, or |
|
14
|
|
|
* (at your option) any later version. |
|
15
|
|
|
* |
|
16
|
|
|
* sysPass is distributed in the hope that it will be useful, |
|
17
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
18
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
19
|
|
|
* GNU General Public License for more details. |
|
20
|
|
|
* |
|
21
|
|
|
* You should have received a copy of the GNU General Public License |
|
22
|
|
|
* along with sysPass. If not, see <http://www.gnu.org/licenses/>. |
|
23
|
|
|
*/ |
|
24
|
|
|
|
|
25
|
|
|
namespace SP\Modules\Api\Controllers\Help; |
|
26
|
|
|
|
|
27
|
|
|
/** |
|
28
|
|
|
* Trait HelpTrait |
|
29
|
|
|
* |
|
30
|
|
|
* @package SP\Modules\Api\Controllers\Help |
|
31
|
|
|
*/ |
|
32
|
|
|
trait HelpTrait |
|
33
|
|
|
{ |
|
34
|
|
|
/** |
|
35
|
|
|
* @param string $action |
|
36
|
|
|
* |
|
37
|
|
|
* @return array |
|
38
|
|
|
*/ |
|
39
|
|
|
public static function getHelpFor(string $action): array |
|
40
|
|
|
{ |
|
41
|
|
|
if (strpos($action, '/') !== false) { |
|
42
|
|
|
list(, $action) = explode('/', $action); |
|
43
|
|
|
} |
|
44
|
|
|
|
|
45
|
|
|
if (method_exists(static::class, $action)) { |
|
46
|
|
|
return [ |
|
47
|
|
|
'help' => static::$action() |
|
48
|
|
|
]; |
|
49
|
|
|
} |
|
50
|
|
|
|
|
51
|
|
|
return []; |
|
52
|
|
|
} |
|
53
|
|
|
|
|
54
|
|
|
/** |
|
55
|
|
|
* @param string $name |
|
56
|
|
|
* @param string $description |
|
57
|
|
|
* @param bool $required |
|
58
|
|
|
* |
|
59
|
|
|
* @return array |
|
60
|
|
|
*/ |
|
61
|
|
|
private static function getItem(string $name, string $description, bool $required = false): array |
|
62
|
|
|
{ |
|
63
|
|
|
return [$name => ['description' => $description, 'required' => $required]]; |
|
64
|
|
|
} |
|
65
|
|
|
} |
nuxsmin /
sysPass
