Messages - Code Metrics - Inspection of "fixed bugs" - anetwork/respond - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f200ef...bd47c4 )

unknown

created 2016-08-30 07:23 UTC

Messages A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	253
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	4
Bugs	2	Features	1

Metric	Value
c	4
b	2
f	1
dl	0
loc	253
rs	10
wmc	15
lcom	1
cbo	1

15 Methods

Rating	Name	Size	Complexity
A	succeed()	7	1
A	deleteSucceeded()	7	1
A	updateSucceeded()	7	1
A	insertSucceeded()	7	1
A	deleteFaild()	8	1
A	updateFaild()	8	1
A	insertFaild()	8	1
A	connectionRefused()	8	1
A	notFound()	8	1
A	wrongParameters()	8	1
A	methodNotAllowed()	8	1
A	validationErrors()	8	1
A	requestFieldNotFound()	8	1
A	requestFieldDuplicated()	8	1
A	error()	8	1

<?php

namespace Anetwork\Respond;

class Messages extends Main
{

	/**
	 * Request succeeded and contains json result
	 * @param array $data
	 * @author Shima Payro <[email protected]>
	 * @since May 2, 2016 9:50:51 AM
	 * @uses
	 * @see
	 */
	public function succeed( $data ) {

		return $this->setStatusCode( 200 )
					->setStatusText( 'success' )
					->respondWithResult( $data );
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

	}

	/**
	 * Delete action is succeed
	 * @author Shima Payro <[email protected]>
	 * @param String $message
	 * @since May 2, 2016 9:52:05 AM
	 * @uses
	 * @see
	 */
	public function deleteSucceeded( $message = 'The requested parameter is deleted successfully!' ) {

		return $this->setStatusCode( 200 )
					->setStatusText( 'success' )
					->respondWithMessage( $message );

	}

	/**
	 * Update action is succeed
	 * @author Shima Payro <[email protected]>
	 * @param String $message
	 * @since May 2, 2016 9:52:52 AM
	 * @uses
	 * @see
	 */
	public function updateSucceeded( $message = 'The requested parameter is updated successfully!' ) {

		return $this->setStatusCode( 200 )
					->setStatusText( 'success' )
					->respondWithMessage( $message );

	}

	/**
	 * Insert action is succeed
	 * @author Shima Payro <[email protected]>
	 * @param String $message
	 * @since May 2, 2016 9:53:26 AM
	 * @uses
	 * @see
	 */
	public function insertSucceeded( $message = 'The requested parameter is Added successfully!' ) {

		return $this->setStatusCode( 200 )
					->setStatusText( 'success' )
					->respondWithMessage( $message );

	}

	/**
	 * Delete action is faild
	 * @author Shima Payro <[email protected]>
	 * @param String $message
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
	 * @since May 2, 2016 9:53:53 AM
	 * @uses
	 * @see
	 */
	public function deleteFaild() {

		return $this->setStatusCode( 447 )
					->setStatusText( 'fail' )
					->setErrorCode( 5447 )
					->respondWithMessage();

	}

	/**
	 * Update action is succeed
	 * @author Shima Payro <[email protected]>
	 * @param String $message
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
	 * @since May 2, 2016 9:54:09 AM
	 * @uses
	 * @see
	 */
	public function updateFaild() {

		return $this->setStatusCode( 449 )
					->setStatusText( 'fail' )
					->setErrorCode( 5449 )
					->respondWithMessage();

	}

	/**
	 * Insert action is faild
	 * @author Shima Payro <[email protected]>
	 * @param String $message
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
	 * @since May 2, 2016 9:54:27 AM
	 * @uses
	 * @see
	 */
	public function insertFaild() {

		return $this->setStatusCode( 448 )
					->setStatusText( 'fail' )
					->setErrorCode( 5448 )
					->respondWithMessage();

	}

	/**
	 * Database connection is refused
	 * @author Shima Payro <[email protected]>
	 * @param String $message
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
	 * @since May 2, 2016 9:54:45 AM
	 * @uses
	 * @see
	 */
	public function connectionRefused() {

		return $this->setStatusCode( 445 )
					->setStatusText( 'fail' )
					->setErrorCode( 5445 )
					->respondWithMessage();

	}

	/**
	 * page requested is not found
	 * @author Shima Payro <[email protected]>
	 * @param String $message
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
	 * @since May 2, 2016 9:55:20 AM
	 * @uses
	 * @see
	 */
	public function notFound() {

		return $this->setStatusCode( 404 )
					->setStatusText( 'fail' )
					->setErrorCode( 5404 )
					->respondWithMessage();

	}

	/**
	 * Wrong parameters are entered
	 * @author Shima Payro <[email protected]>
	 * @param String $message
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
	 * @since May 2, 2016 9:55:20 AM
	 * @uses
	 * @see
	 */
	public function wrongParameters() {

		return $this->setStatusCode( 406 )
					->setStatusText( 'fail' )
					->setErrorCode( 5406 )
					->respondWithMessage();

	}

	/**
	 * Method is not allowed
	 * @author Shima Payro <[email protected]>
	 * @param String $message
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
	 * @since May 2, 2016 9:55:20 AM
	 * @uses
	 * @see
	 */
	public function methodNotAllowed() {

		return $this->setStatusCode( 405 )
					->setStatusText( 'fail' )
					->setErrorCode( 5405 )
					->respondWithMessage();

	}

	/**
	 * There ara validation errors
	 * @author Shima Payro <[email protected]>
	 * @param Array $data
	 * @since May 2, 2016 9:55:20 AM
	 * @uses
	 * @see
	 */
	public function validationErrors( $data ) {

		return $this->setStatusCode( 420 )
					->setStatusText( 'fail' )
					->setErrorCode( 5420 )
					->respondWithResult( $data );
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

	}

	/**
	 * The request field is not found
	 * @author Shima Payro <[email protected]>
	 * @param String $message
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
	 * @since May 2, 2016 9:55:20 AM
	 * @uses
	 * @see
	 */
	public function requestFieldNotFound() {

		return $this->setStatusCode( 446 )
					->setStatusText( 'fail' )
					->setErrorCode( 1001 )
					->respondWithMessage();

	}

	/**
	 * The request field is doublicated
	 * @author Mehdi Hosseini <[email protected]>
	 * @since August 24, 2016
	 * @return json
	 */
	public function requestFieldDuplicated() {

	  return $this->setStatusCode( 400 )
					->setStatusText( 'fail' )
					->SetErrorCode(1004)
					->respondWithMessage();

	}

	/**
	 * Custom error message according to error config file
	 * @author Mehdi Hosseini <[email protected]>
	 * @since August 24, 2016
	 * @param $code integer
	 * @return json
	 */
	public function error( $code ) {

	  return $this->SetStatusCode( 400 )
					->setStatusText( 'fail' )
					->setErrorCode( $code )
					->respondWithMessage();

	}


}


1			<?php
2
3			namespace Anetwork\Respond;
4
5			class Messages extends Main
6			{
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 );
			0 ignored issues – show Documentation introduced 2016-08-30 07:26 UTC by Report Bug Copy Issue Report `$data` is of type `array`, but the function expects a `object<Anetwork\Respond\json>\|null`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
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 = 'The requested parameter is deleted successfully!' ) {
33
34			return $this->setStatusCode( 200 )
35			->setStatusText( 'success' )
36			->respondWithMessage( $message );
37
38			}
39
40			/**
41			* Update action is succeed
42			* @author Shima Payro <[email protected]>
43			* @param String $message
44			* @since May 2, 2016 9:52:52 AM
45			* @uses
46			* @see
47			*/
48			public function updateSucceeded( $message = 'The requested parameter is updated successfully!' ) {
49
50			return $this->setStatusCode( 200 )
51			->setStatusText( 'success' )
52			->respondWithMessage( $message );
53
54			}
55
56			/**
57			* Insert action is succeed
58			* @author Shima Payro <[email protected]>
59			* @param String $message
60			* @since May 2, 2016 9:53:26 AM
61			* @uses
62			* @see
63			*/
64			public function insertSucceeded( $message = 'The requested parameter is Added successfully!' ) {
65
66			return $this->setStatusCode( 200 )
67			->setStatusText( 'success' )
68			->respondWithMessage( $message );
69
70			}
71
72			/**
73			* Delete action is faild
74			* @author Shima Payro <[email protected]>
75			* @param String $message
			0 ignored issues – show Bug introduced 2016-08-24 16:36 UTC by Report Bug Copy Issue Report There is no parameter named `$message`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
76			* @since May 2, 2016 9:53:53 AM
77			* @uses
78			* @see
79			*/
80			public function deleteFaild() {
81
82			return $this->setStatusCode( 447 )
83			->setStatusText( 'fail' )
84			->setErrorCode( 5447 )
85			->respondWithMessage();
86
87			}
88
89			/**
90			* Update action is succeed
91			* @author Shima Payro <[email protected]>
92			* @param String $message
			0 ignored issues – show Bug introduced 2016-08-24 16:36 UTC by Report Bug Copy Issue Report There is no parameter named `$message`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
93			* @since May 2, 2016 9:54:09 AM
94			* @uses
95			* @see
96			*/
97			public function updateFaild() {
98
99			return $this->setStatusCode( 449 )
100			->setStatusText( 'fail' )
101			->setErrorCode( 5449 )
102			->respondWithMessage();
103
104			}
105
106			/**
107			* Insert action is faild
108			* @author Shima Payro <[email protected]>
109			* @param String $message
			0 ignored issues – show Bug introduced 2016-08-24 16:36 UTC by Report Bug Copy Issue Report There is no parameter named `$message`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
110			* @since May 2, 2016 9:54:27 AM
111			* @uses
112			* @see
113			*/
114			public function insertFaild() {
115
116			return $this->setStatusCode( 448 )
117			->setStatusText( 'fail' )
118			->setErrorCode( 5448 )
119			->respondWithMessage();
120
121			}
122
123			/**
124			* Database connection is refused
125			* @author Shima Payro <[email protected]>
126			* @param String $message
			0 ignored issues – show Bug introduced 2016-08-24 16:36 UTC by Report Bug Copy Issue Report There is no parameter named `$message`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
127			* @since May 2, 2016 9:54:45 AM
128			* @uses
129			* @see
130			*/
131			public function connectionRefused() {
132
133			return $this->setStatusCode( 445 )
134			->setStatusText( 'fail' )
135			->setErrorCode( 5445 )
136			->respondWithMessage();
137
138			}
139
140			/**
141			* page requested is not found
142			* @author Shima Payro <[email protected]>
143			* @param String $message
			0 ignored issues – show Bug introduced 2016-08-24 16:36 UTC by Report Bug Copy Issue Report There is no parameter named `$message`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
144			* @since May 2, 2016 9:55:20 AM
145			* @uses
146			* @see
147			*/
148			public function notFound() {
149
150			return $this->setStatusCode( 404 )
151			->setStatusText( 'fail' )
152			->setErrorCode( 5404 )
153			->respondWithMessage();
154
155			}
156
157			/**
158			* Wrong parameters are entered
159			* @author Shima Payro <[email protected]>
160			* @param String $message
			0 ignored issues – show Bug introduced 2016-08-24 16:36 UTC by Report Bug Copy Issue Report There is no parameter named `$message`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
161			* @since May 2, 2016 9:55:20 AM
162			* @uses
163			* @see
164			*/
165			public function wrongParameters() {
166
167			return $this->setStatusCode( 406 )
168			->setStatusText( 'fail' )
169			->setErrorCode( 5406 )
170			->respondWithMessage();
171
172			}
173
174			/**
175			* Method is not allowed
176			* @author Shima Payro <[email protected]>
177			* @param String $message
			0 ignored issues – show Bug introduced 2016-08-24 16:36 UTC by Report Bug Copy Issue Report There is no parameter named `$message`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
178			* @since May 2, 2016 9:55:20 AM
179			* @uses
180			* @see
181			*/
182			public function methodNotAllowed() {
183
184			return $this->setStatusCode( 405 )
185			->setStatusText( 'fail' )
186			->setErrorCode( 5405 )
187			->respondWithMessage();
188
189			}
190
191			/**
192			* There ara validation errors
193			* @author Shima Payro <[email protected]>
194			* @param Array $data
195			* @since May 2, 2016 9:55:20 AM
196			* @uses
197			* @see
198			*/
199			public function validationErrors( $data ) {
200
201			return $this->setStatusCode( 420 )
202			->setStatusText( 'fail' )
203			->setErrorCode( 5420 )
204			->respondWithResult( $data );
			0 ignored issues – show Documentation introduced 2016-08-30 07:26 UTC by Report Bug Copy Issue Report `$data` is of type `array`, but the function expects a `object<Anetwork\Respond\json>\|null`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
205
206			}
207
208			/**
209			* The request field is not found
210			* @author Shima Payro <[email protected]>
211			* @param String $message
			0 ignored issues – show Bug introduced 2016-08-24 16:36 UTC by Report Bug Copy Issue Report There is no parameter named `$message`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
212			* @since May 2, 2016 9:55:20 AM
213			* @uses
214			* @see
215			*/
216			public function requestFieldNotFound() {
217
218			return $this->setStatusCode( 446 )
219			->setStatusText( 'fail' )
220			->setErrorCode( 1001 )
221			->respondWithMessage();
222
223			}
224
225			/**
226			* The request field is doublicated
227			* @author Mehdi Hosseini <[email protected]>
228			* @since August 24, 2016
229			* @return json
230			*/
231			public function requestFieldDuplicated() {
232
233			return $this->setStatusCode( 400 )
234			->setStatusText( 'fail' )
235			->SetErrorCode(1004)
236			->respondWithMessage();
237
238			}
239
240			/**
241			* Custom error message according to error config file
242			* @author Mehdi Hosseini <[email protected]>
243			* @since August 24, 2016
244			* @param $code integer
245			* @return json
246			*/
247			public function error( $code ) {
248
249			return $this->SetStatusCode( 400 )
250			->setStatusText( 'fail' )
251			->setErrorCode( $code )
252			->respondWithMessage();
253
254			}
255
256
257			}
258

anetwork / respond

Push — master ( f200ef...bd47c4 )

Messages A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

15 Methods

Duplication Side-by-Side

Filter issues like