1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
namespace Vahid\Respond; |
4
|
|
|
|
5
|
|
|
class Messages extends Main |
6
|
|
|
{ |
7
|
|
|
|
8
|
|
|
/** |
9
|
|
|
* Request succeeded and contains json result |
10
|
|
|
* @param array $data |
11
|
|
|
* @return mixed |
12
|
|
|
* @since May 2, 2016 9:50:51 AM |
13
|
|
|
* @uses |
14
|
|
|
* @see |
15
|
|
|
* @author Shima Payro <[email protected]> |
16
|
|
|
*/ |
17
|
|
|
public function succeed($data) |
18
|
|
|
{ |
19
|
|
|
|
20
|
|
|
return $this->setStatusCode(200) |
21
|
|
|
->setStatusText('success') |
22
|
|
|
->respondWithResult($data); |
23
|
|
|
|
24
|
|
|
} |
25
|
|
|
|
26
|
|
|
/** |
27
|
|
|
* Delete action is succeed |
28
|
|
|
* @param String $message |
29
|
|
|
* @return mixed |
30
|
|
|
* @since May 2, 2016 9:52:05 AM |
31
|
|
|
* @uses |
32
|
|
|
* @see |
33
|
|
|
* @author Shima Payro <[email protected]> |
34
|
|
|
*/ |
35
|
|
|
public function deleteSucceeded($message = null) |
36
|
|
|
{ |
37
|
|
|
|
38
|
|
|
if (is_null($message)) |
39
|
|
|
$message = $this->config['success']['delete']; |
40
|
|
|
|
41
|
|
|
return $this->setStatusCode(200) |
42
|
|
|
->setStatusText('success') |
43
|
|
|
->respondWithMessage($message); |
44
|
|
|
|
45
|
|
|
} |
46
|
|
|
|
47
|
|
|
/** |
48
|
|
|
* Update action is succeed |
49
|
|
|
* @param String $message |
50
|
|
|
* @return mixed |
51
|
|
|
* @since May 2, 2016 9:52:52 AM |
52
|
|
|
* @uses |
53
|
|
|
* @see |
54
|
|
|
* @author Shima Payro <[email protected]> |
55
|
|
|
*/ |
56
|
|
|
public function updateSucceeded($message = null) |
57
|
|
|
{ |
58
|
|
|
|
59
|
|
|
if (is_null($message)) |
60
|
|
|
$message = $this->config['success']['update']; |
61
|
|
|
|
62
|
|
|
return $this->setStatusCode(200) |
63
|
|
|
->setStatusText('success') |
64
|
|
|
->respondWithMessage($message); |
65
|
|
|
|
66
|
|
|
} |
67
|
|
|
|
68
|
|
|
/** |
69
|
|
|
* Insert action is succeed |
70
|
|
|
* @param String $message |
71
|
|
|
* @return mixed |
72
|
|
|
* @since May 2, 2016 9:53:26 AM |
73
|
|
|
* @uses |
74
|
|
|
* @see |
75
|
|
|
* @author Shima Payro <[email protected]> |
76
|
|
|
*/ |
77
|
|
|
public function insertSucceeded($message = null) |
78
|
|
|
{ |
79
|
|
|
|
80
|
|
|
if (is_null($message)) |
81
|
|
|
$message = $this->config['success']['insert']; |
82
|
|
|
|
83
|
|
|
return $this->setStatusCode(200) |
84
|
|
|
->setStatusText('success') |
85
|
|
|
->respondWithMessage($message); |
86
|
|
|
|
87
|
|
|
} |
88
|
|
|
|
89
|
|
|
/** |
90
|
|
|
* Delete action is failed |
91
|
|
|
* @param String $message |
92
|
|
|
* @return mixed |
93
|
|
|
* @since May 2, 2016 9:53:53 AM |
94
|
|
|
* @uses |
95
|
|
|
* @see |
96
|
|
|
* @author Shima Payro <[email protected]> |
97
|
|
|
*/ |
98
|
|
|
public function deleteFailed($message = null) |
99
|
|
|
{ |
100
|
|
|
|
101
|
|
|
if (is_null($message)) |
102
|
|
|
$message = $this->config['fail']['delete']; |
103
|
|
|
|
104
|
|
|
return $this->setStatusCode(447) |
105
|
|
|
->setStatusText('fail') |
106
|
|
|
->setErrorCode(5447) |
107
|
|
|
->respondWithMessage($message); |
108
|
|
|
|
109
|
|
|
} |
110
|
|
|
|
111
|
|
|
/** |
112
|
|
|
* Update action is succeed |
113
|
|
|
* @param String $message |
114
|
|
|
* @return mixed |
115
|
|
|
* @since May 2, 2016 9:54:09 AM |
116
|
|
|
* @uses |
117
|
|
|
* @see |
118
|
|
|
* @author Shima Payro <[email protected]> |
119
|
|
|
*/ |
120
|
|
|
public function updateFailed($message = null) |
121
|
|
|
{ |
122
|
|
|
|
123
|
|
|
if (is_null($message)) |
124
|
|
|
$message = $this->config['fail']['update']; |
125
|
|
|
|
126
|
|
|
return $this->setStatusCode(449) |
127
|
|
|
->setStatusText('fail') |
128
|
|
|
->setErrorCode(5449) |
129
|
|
|
->respondWithMessage($message); |
130
|
|
|
|
131
|
|
|
} |
132
|
|
|
|
133
|
|
|
/** |
134
|
|
|
* Insert action is failed |
135
|
|
|
* @param String $message |
136
|
|
|
* @return mixed |
137
|
|
|
* @since May 2, 2016 9:54:27 AM |
138
|
|
|
* @uses |
139
|
|
|
* @see |
140
|
|
|
* @author Shima Payro <[email protected]> |
141
|
|
|
*/ |
142
|
|
|
public function insertFailed($message = null) |
143
|
|
|
{ |
144
|
|
|
|
145
|
|
|
if (is_null($message)) |
146
|
|
|
$message = $this->config['fail']['insert']; |
147
|
|
|
|
148
|
|
|
return $this->setStatusCode(448) |
149
|
|
|
->setStatusText('fail') |
150
|
|
|
->setErrorCode(5448) |
151
|
|
|
->respondWithMessage($message); |
152
|
|
|
|
153
|
|
|
} |
154
|
|
|
|
155
|
|
|
/** |
156
|
|
|
* Database connection is refused |
157
|
|
|
* @return mixed |
158
|
|
|
* @since May 2, 2016 9:54:45 AM |
159
|
|
|
* @uses |
160
|
|
|
* @see |
161
|
|
|
* @author Shima Payro <[email protected]> |
162
|
|
|
*/ |
163
|
|
|
public function connectionRefused() |
164
|
|
|
{ |
165
|
|
|
|
166
|
|
|
return $this->setStatusCode(445) |
167
|
|
|
->setStatusText('fail') |
168
|
|
|
->setErrorCode(5445) |
169
|
|
|
->respondWithMessage(); |
170
|
|
|
|
171
|
|
|
} |
172
|
|
|
|
173
|
|
|
/** |
174
|
|
|
* page requested is not found |
175
|
|
|
* @return mixed |
176
|
|
|
* @since May 2, 2016 9:55:20 AM |
177
|
|
|
* @uses |
178
|
|
|
* @see |
179
|
|
|
* @author Shima Payro <[email protected]> |
180
|
|
|
*/ |
181
|
|
|
public function notFound() |
182
|
|
|
{ |
183
|
|
|
|
184
|
|
|
return $this->setStatusCode(404) |
185
|
|
|
->setStatusText('fail') |
186
|
|
|
->setErrorCode(5404) |
187
|
|
|
->respondWithMessage(); |
188
|
|
|
|
189
|
|
|
} |
190
|
|
|
|
191
|
|
|
/** |
192
|
|
|
* Wrong parameters are entered |
193
|
|
|
* @return mixed |
194
|
|
|
* @since May 2, 2016 9:55:20 AM |
195
|
|
|
* @uses |
196
|
|
|
* @see |
197
|
|
|
* @author Shima Payro <[email protected]> |
198
|
|
|
*/ |
199
|
|
|
public function wrongParameters() |
200
|
|
|
{ |
201
|
|
|
|
202
|
|
|
return $this->setStatusCode(406) |
203
|
|
|
->setStatusText('fail') |
204
|
|
|
->setErrorCode(5406) |
205
|
|
|
->respondWithMessage(); |
206
|
|
|
|
207
|
|
|
} |
208
|
|
|
|
209
|
|
|
/** |
210
|
|
|
* Method is not allowed |
211
|
|
|
* @return mixed |
212
|
|
|
* @since May 2, 2016 9:55:20 AM |
213
|
|
|
* @uses |
214
|
|
|
* @see |
215
|
|
|
* @author Shima Payro <[email protected]> |
216
|
|
|
*/ |
217
|
|
|
public function methodNotAllowed() |
218
|
|
|
{ |
219
|
|
|
|
220
|
|
|
return $this->setStatusCode(405) |
221
|
|
|
->setStatusText('fail') |
222
|
|
|
->setErrorCode(5405) |
223
|
|
|
->respondWithMessage(); |
224
|
|
|
|
225
|
|
|
} |
226
|
|
|
|
227
|
|
|
/** |
228
|
|
|
* There ara validation errors |
229
|
|
|
* @param $message string |
230
|
|
|
* @return mixed |
231
|
|
|
* @since May 2, 2016 9:55:20 AM |
232
|
|
|
* @uses |
233
|
|
|
* @see |
234
|
|
|
* @author Shima Payro <[email protected]> |
235
|
|
|
*/ |
236
|
|
|
public function validationErrors($message = null) |
237
|
|
|
{ |
238
|
|
|
|
239
|
|
|
return $this->setStatusCode(420) |
240
|
|
|
->setStatusText('fail') |
241
|
|
|
->setErrorCode(5420) |
242
|
|
|
->respondWithResult($message); |
243
|
|
|
|
244
|
|
|
} |
245
|
|
|
|
246
|
|
|
/** |
247
|
|
|
* The request failed is not found |
248
|
|
|
* @return mixed |
249
|
|
|
* @since May 2, 2016 9:55:20 AM |
250
|
|
|
* @uses |
251
|
|
|
* @see |
252
|
|
|
* @author Shima Payro <[email protected]> |
253
|
|
|
*/ |
254
|
|
|
public function requestFailedNotFound() |
255
|
|
|
{ |
256
|
|
|
|
257
|
|
|
return $this->setStatusCode(446) |
258
|
|
|
->setStatusText('fail') |
259
|
|
|
->setErrorCode(1001) |
260
|
|
|
->respondWithMessage(); |
261
|
|
|
|
262
|
|
|
} |
263
|
|
|
|
264
|
|
|
/** |
265
|
|
|
* The request failed is doublicated |
266
|
|
|
* @return mixed |
267
|
|
|
* @since August 24, 2016 |
268
|
|
|
* @author Mehdi Hosseini <[email protected]> |
269
|
|
|
*/ |
270
|
|
|
public function requestFailedDuplicated() |
271
|
|
|
{ |
272
|
|
|
|
273
|
|
|
return $this->setStatusCode(400) |
274
|
|
|
->setStatusText('fail') |
275
|
|
|
->SetErrorCode(1004) |
276
|
|
|
->respondWithMessage(); |
277
|
|
|
|
278
|
|
|
} |
279
|
|
|
|
280
|
|
|
/** |
281
|
|
|
* Custom error message according to error config file |
282
|
|
|
* @param $code integer |
283
|
|
|
* @return mixed |
284
|
|
|
* @author Mehdi Hosseini <[email protected]> |
285
|
|
|
* @since August 24, 2016 |
286
|
|
|
*/ |
287
|
|
|
public function error($code) |
288
|
|
|
{ |
289
|
|
|
|
290
|
|
|
return $this->setStatusCode(400) |
291
|
|
|
->setStatusText('fail') |
292
|
|
|
->setErrorCode($code) |
293
|
|
|
->respondWithMessage(); |
294
|
|
|
|
295
|
|
|
} |
296
|
|
|
|
297
|
|
|
|
298
|
|
|
} |
299
|
|
|
|