|
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\Services\Api; |
|
26
|
|
|
|
|
27
|
|
|
/** |
|
28
|
|
|
* Class ApiResponse |
|
29
|
|
|
* |
|
30
|
|
|
* @package SP\Api |
|
31
|
|
|
*/ |
|
32
|
|
|
final class ApiResponse |
|
33
|
|
|
{ |
|
34
|
|
|
const RESULT_SUCCESS = 0; |
|
35
|
|
|
const RESULT_ERROR = 1; |
|
36
|
|
|
|
|
37
|
|
|
/** |
|
38
|
|
|
* @var mixed |
|
39
|
|
|
*/ |
|
40
|
|
|
private $result; |
|
41
|
|
|
/** |
|
42
|
|
|
* @var int |
|
43
|
|
|
*/ |
|
44
|
|
|
private $resultCode; |
|
45
|
|
|
/** |
|
46
|
|
|
* @var int |
|
47
|
|
|
*/ |
|
48
|
|
|
private $itemId; |
|
49
|
|
|
/** |
|
50
|
|
|
* @var string |
|
51
|
|
|
*/ |
|
52
|
|
|
private $resultMessage; |
|
53
|
|
|
|
|
54
|
|
|
/** |
|
55
|
|
|
* ApiResponse constructor. |
|
56
|
|
|
* |
|
57
|
|
|
* @param mixed $result |
|
58
|
|
|
* @param null $itemId |
|
|
|
|
|
|
59
|
|
|
*/ |
|
60
|
|
|
public function __construct($result, $itemId = null) |
|
61
|
|
|
{ |
|
62
|
|
|
$this->result = $result; |
|
63
|
|
|
$this->itemId = (int)$itemId; |
|
64
|
|
|
} |
|
65
|
|
|
|
|
66
|
|
|
/** |
|
67
|
|
|
* @param mixed $result |
|
68
|
|
|
* @param int|null $itemId |
|
69
|
|
|
* @param string|null $message |
|
70
|
|
|
* |
|
71
|
|
|
* @return ApiResponse |
|
72
|
|
|
*/ |
|
73
|
|
|
public static function makeSuccess($result, int $itemId = null, string $message = null) |
|
74
|
|
|
{ |
|
75
|
|
|
$out = new self($result, $itemId); |
|
|
|
|
|
|
76
|
|
|
$out->resultCode = self::RESULT_SUCCESS; |
|
77
|
|
|
$out->resultMessage = $message; |
|
78
|
|
|
|
|
79
|
|
|
return $out; |
|
80
|
|
|
} |
|
81
|
|
|
|
|
82
|
|
|
/** |
|
83
|
|
|
* @param mixed $result |
|
84
|
|
|
* @param string|null $message |
|
85
|
|
|
* |
|
86
|
|
|
* @return ApiResponse |
|
87
|
|
|
*/ |
|
88
|
|
|
public static function makeError($result, string $message = null) |
|
89
|
|
|
{ |
|
90
|
|
|
$out = new self($result); |
|
91
|
|
|
$out->resultCode = self::RESULT_ERROR; |
|
92
|
|
|
$out->resultMessage = $message; |
|
93
|
|
|
|
|
94
|
|
|
return $out; |
|
95
|
|
|
} |
|
96
|
|
|
|
|
97
|
|
|
/** |
|
98
|
|
|
* @return array |
|
99
|
|
|
*/ |
|
100
|
|
|
public function getResponse() |
|
101
|
|
|
{ |
|
102
|
|
|
return [ |
|
103
|
|
|
'itemId' => $this->itemId, |
|
104
|
|
|
'result' => $this->result, |
|
105
|
|
|
'resultCode' => $this->resultCode, |
|
106
|
|
|
'resultMessage' => $this->resultMessage, |
|
107
|
|
|
'count' => is_array($this->result) ? count($this->result) : null |
|
108
|
|
|
]; |
|
109
|
|
|
} |
|
110
|
|
|
} |
nuxsmin /
sysPass
Loading history...