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