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