RESTProcessorA::handleHead() - Code Metrics - mariusor/vsc - Measure and Improve Code Quality continuously with Scrutinizer

RESTProcessorA::handleHead()
last analyzed 2020-01-19 11:51 UTC

↳ Parent: RESTProcessorA

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
nc	1
dl	0
loc	1
ccs	0
cts	0
cp	0
c	0
b	0
f	0

<?php
/**
 * A processor for RESTful calls
 *
 * @package application/processors
 * @author marius orcsik <[email protected]>
 * @date 2013.10.04
 */
namespace vsc\rest\application\processors;

use vsc\application\processors\ProcessorA;
use vsc\infrastructure\vsc;
use vsc\presentation\requests\ContentType;
use vsc\presentation\requests\HttpRequestA;
use vsc\presentation\requests\HttpRequestTypes;
use vsc\presentation\requests\RawHttpRequest;
use vsc\presentation\responses\ExceptionResponseError;
use vsc\presentation\responses\HttpResponseType;

abstract class RESTProcessorA extends ProcessorA {
	protected $validRequestMethods = array( );

	public function getValidRequestMethods() {
		return $this->validRequestMethods;
	}

	protected $validContentTypes = array('*/*');

	public function getValidContentTypes() {
		return $this->validContentTypes;
	}

	public function validRequestMethod($sRequestMethod) {
		return (in_array($sRequestMethod, $this->getValidRequestMethods()));
	}

	public function validContentType($sContentType) {
		return ContentType::isAccepted($sContentType, $this->getValidContentTypes());
	}

	abstract public function handleGet(HttpRequestA $oRequest);

	abstract public function handleHead(HttpRequestA $oRequest);

	abstract public function handlePost(HttpRequestA $oRequest);

	abstract public function handlePut(RawHttpRequest $oRequest);

	abstract public function handleDelete(RawHttpRequest $oRequest);


	/**
	 * @param HttpRequestA $oRequest
	 * @return \vsc\domain\models\ModelA
	 * @throws \vsc\presentation\responses\ExceptionResponseError
	 */
	public function handleRequest(HttpRequestA $oRequest) {
		if (!$oRequest->isGet() && !RawHttpRequest::isValid($oRequest)) {
			$oRequest = new RawHttpRequest();
			vsc::getEnv()->setHttpRequest($oRequest);
		}

		switch ($oRequest->getHttpMethod()) {
		case HttpRequestTypes::GET:
			$oModel = $this->handleGet($oRequest);
			break;
		case HttpRequestTypes::HEAD:
			$oModel = $this->handleHead($oRequest);
			break;
		case HttpRequestTypes::POST:
			$oModel = $this->handlePost($oRequest);
			break;
		case HttpRequestTypes::PUT:
			$oModel = $this->handlePut($oRequest);

			break;
		case HttpRequestTypes::DELETE:
			$oModel = $this->handleDelete($oRequest);

			break;
		default:
			throw new ExceptionResponseError('Method [' . $oRequest->getHttpMethod() . '] is unavailable.', HttpResponseType::METHOD_NOT_ALLOWED);
		}
		return $oModel;
	}
}


1		<?php
2		/**
3		* A processor for RESTful calls
4		*
5		* @package application/processors
6		* @author marius orcsik <[email protected]>
7		* @date 2013.10.04
8		*/
9		namespace vsc\rest\application\processors;
10
11		use vsc\application\processors\ProcessorA;
12		use vsc\infrastructure\vsc;
13		use vsc\presentation\requests\ContentType;
14		use vsc\presentation\requests\HttpRequestA;
15		use vsc\presentation\requests\HttpRequestTypes;
16		use vsc\presentation\requests\RawHttpRequest;
17		use vsc\presentation\responses\ExceptionResponseError;
18		use vsc\presentation\responses\HttpResponseType;
19
20		abstract class RESTProcessorA extends ProcessorA {
21		protected $validRequestMethods = array( );
22
23		public function getValidRequestMethods() {
24		return $this->validRequestMethods;
25		}
26
27		protected $validContentTypes = array('/');
28
29	1	public function getValidContentTypes() {
30	1	return $this->validContentTypes;
31		}
32
33	2	public function validRequestMethod($sRequestMethod) {
34	2	return (in_array($sRequestMethod, $this->getValidRequestMethods()));
35		}
36
37	28	public function validContentType($sContentType) {
38	28	return ContentType::isAccepted($sContentType, $this->getValidContentTypes());
39		}
40
41		abstract public function handleGet(HttpRequestA $oRequest);
		0 ignored issues – show Documentation introduced 2018-04-25 09:18 UTC by Report Bug Copy Issue Report For interfaces and abstract methods it is generally a good practice to add a `@return` annotation even if it is just `@return void` or `@return null`, so that implementors know what to do in the overridden method. For interface and abstract methods, it is impossible to infer the return type from the immediate code. In these cases, it is generally advisible to explicitly annotate these methods with a `@return` doc comment to communicate to implementors of these methods what they are expected to return. Loading history...
42		abstract public function handleHead(HttpRequestA $oRequest);
		0 ignored issues – show Documentation introduced 2018-04-25 09:18 UTC by Report Bug Copy Issue Report For interfaces and abstract methods it is generally a good practice to add a `@return` annotation even if it is just `@return void` or `@return null`, so that implementors know what to do in the overridden method. For interface and abstract methods, it is impossible to infer the return type from the immediate code. In these cases, it is generally advisible to explicitly annotate these methods with a `@return` doc comment to communicate to implementors of these methods what they are expected to return. Loading history...
43		abstract public function handlePost(HttpRequestA $oRequest);
		0 ignored issues – show Documentation introduced 2018-04-25 09:18 UTC by Report Bug Copy Issue Report For interfaces and abstract methods it is generally a good practice to add a `@return` annotation even if it is just `@return void` or `@return null`, so that implementors know what to do in the overridden method. For interface and abstract methods, it is impossible to infer the return type from the immediate code. In these cases, it is generally advisible to explicitly annotate these methods with a `@return` doc comment to communicate to implementors of these methods what they are expected to return. Loading history...
44		abstract public function handlePut(RawHttpRequest $oRequest);
		0 ignored issues – show Documentation introduced 2018-04-25 09:18 UTC by Report Bug Copy Issue Report For interfaces and abstract methods it is generally a good practice to add a `@return` annotation even if it is just `@return void` or `@return null`, so that implementors know what to do in the overridden method. For interface and abstract methods, it is impossible to infer the return type from the immediate code. In these cases, it is generally advisible to explicitly annotate these methods with a `@return` doc comment to communicate to implementors of these methods what they are expected to return. Loading history...
45		abstract public function handleDelete(RawHttpRequest $oRequest);
		0 ignored issues – show Documentation introduced 2018-04-25 09:18 UTC by Report Bug Copy Issue Report For interfaces and abstract methods it is generally a good practice to add a `@return` annotation even if it is just `@return void` or `@return null`, so that implementors know what to do in the overridden method. For interface and abstract methods, it is impossible to infer the return type from the immediate code. In these cases, it is generally advisible to explicitly annotate these methods with a `@return` doc comment to communicate to implementors of these methods what they are expected to return. Loading history...
46
47		/**
48		* @param HttpRequestA $oRequest
49		* @return \vsc\domain\models\ModelA
50		* @throws \vsc\presentation\responses\ExceptionResponseError
51		*/
52	6	public function handleRequest(HttpRequestA $oRequest) {
53	6	if (!$oRequest->isGet() && !RawHttpRequest::isValid($oRequest)) {
54		$oRequest = new RawHttpRequest();
55		vsc::getEnv()->setHttpRequest($oRequest);
56		}
57
58	6	switch ($oRequest->getHttpMethod()) {
59	6	case HttpRequestTypes::GET:
60	1	$oModel = $this->handleGet($oRequest);
61	1	break;
62	5	case HttpRequestTypes::HEAD:
63	1	$oModel = $this->handleHead($oRequest);
64	1	break;
65	4	case HttpRequestTypes::POST:
66	1	$oModel = $this->handlePost($oRequest);
67	1	break;
68	3	case HttpRequestTypes::PUT:
69	1	$oModel = $this->handlePut($oRequest);
		0 ignored issues – show Compatibility introduced 2016-01-01 13:53 UTC by Report Bug Copy Issue Report `$oRequest` of type `object<vsc\presentation\requests\HttpRequestA>` is not a sub-type of `object<vsc\presentation\requests\RawHttpRequest>`. It seems like you assume a child class of the class `vsc\presentation\requests\HttpRequestA` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
70	1	break;
71	2	case HttpRequestTypes::DELETE:
72	1	$oModel = $this->handleDelete($oRequest);
		0 ignored issues – show Compatibility introduced 2016-01-01 13:53 UTC by Report Bug Copy Issue Report `$oRequest` of type `object<vsc\presentation\requests\HttpRequestA>` is not a sub-type of `object<vsc\presentation\requests\RawHttpRequest>`. It seems like you assume a child class of the class `vsc\presentation\requests\HttpRequestA` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
73	1	break;
74		default:
75	1	throw new ExceptionResponseError('Method [' . $oRequest->getHttpMethod() . '] is unavailable.', HttpResponseType::METHOD_NOT_ALLOWED);
76		}
77	5	return $oModel;
78		}
79		}
80

mariusor / vsc

GitHub Access Token became invalid

RESTProcessorA::handleHead() last analyzed 2020-01-19 11:51 UTC

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

RESTProcessorA::handleHead()
last analyzed 2020-01-19 11:51 UTC