RestController::getById() - Code Metrics - Inspection of "Add request with params for all DAO methods" - phpMv/ubiquity - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9bd3b4...2d1963 )

by Jean-Christophe

created 2018-06-20 01:07 UTC

RestController::getById() A

↳ Parent: RestController

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	3
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	1

<?php

namespace Ubiquity\controllers\rest;

use Ubiquity\controllers\Controller;
use Ubiquity\orm\DAO;
use Ubiquity\controllers\Startup;
use Ubiquity\utils\base\UString;
use Ubiquity\cache\CacheManager;
use Ubiquity\utils\http\URequest;

/**
 * @author jc
 * Abstract base class for Rest controllers
 *
 */
abstract class RestController extends Controller {
	protected $config;
	protected $model;
	protected $contentType;
	protected $restCache;
	/**
	 * @var ResponseFormatter
	 */
	protected $responseFormatter;

	/**
	 * @var RestServer
	 */
	protected $server;

	public function __construct(){
		if(!\headers_sent()){
			@\set_exception_handler(array ($this,'_errorHandler' ));
			$this->config=Startup::getConfig();
			$this->server=new RestServer($this->config);
			$this->server->cors();
			$this->responseFormatter=new ResponseFormatter();
			$this->contentType="application/json";
			$this->server->_setContentType($this->contentType);
			$this->restCache=CacheManager::getRestCacheController(\get_class($this));
		}
		if (! $this->isValid (Startup::getAction()))
			$this->onInvalidControl ();
	}

	public function isValid($action){
		if(isset($this->restCache["authorizations"])){
			if(\array_search($action, $this->restCache["authorizations"])!==false){
				return $this->server->isValid();
			}
		}
		return true;
	}

	public function onInvalidControl(){
		throw new \Exception('HTTP/1.1 401 Unauthorized, you need an access token for this request',401);
	}

	/**
	 * Realise the connection to the server
	 * To override in derived classes to define your own authentication
	 */
	public function connect(){
		$this->server->connect($this);
	}

	public function initialize(){
		$thisClass=\get_class($this);
		if(!isset($this->model))
			$this->model=CacheManager::getRestResource($thisClass);
		if(!isset($this->model)){
			$modelsNS=$this->config["mvcNS"]["models"];
			$this->model=$modelsNS."\\".$this->responseFormatter->getModel($thisClass);
		}
		$this->connectDb($this->config);
	}

	public function finalize(){
		parent::finalize();
		$this->server->finalizeTokens();
	}



	public function _errorHandler($e){
		$code=500;
		if($e->getCode()!==0)
			$code=$e->getCode();
		$this->_setResponseCode($code);
		echo $this->responseFormatter->formatException($e);
	}

	public function _setResponseCode($value){
		\http_response_code($value);
	}

	protected function connectDb($config){
		$db=$config["database"];
		if($db["dbName"]!==""){
			DAO::connect($db["type"],$db["dbName"],@$db["serverName"],@$db["port"],@$db["user"],@$db["password"],@$db["options"],@$db["cache"]);
		}
	}

	/**
	 * Updates $instance with $values
	 * To eventually be redefined in derived classes
	 * @param object $instance the instance to update
	 * @param array|null $values
	 */
	protected function _setValuesToObject($instance,$values=null){
		if(URequest::isJSON()){
			$values=\json_decode($values,true);
		}
		URequest::setValuesToObject($instance,$values);
	}

	/**
	 * Returns all objects for the resource $model
	 * @route("cache"=>false)
	 */
	public function index() {
			$datas=DAO::getAll($this->model);
			echo $this->responseFormatter->get($datas);
	}

	/**
	 * Default route for requiring a single object
	 * @route("{id}","methods"=>["get","options"])
	 */
	public function getById($id){
		return $this->getOne($id,true,true);
	}

	/**
	 * Returns a list of objects from the server
	 * @param string $condition the sql Where part
	 * @param boolean|string $included if true, loads associate members with associations, if string, example : client.*,commands
	 * @param boolean $useCache
	 */
	public function get($condition="1=1",$included=false,$useCache=false){
		try{
			$condition=\urldecode($condition);
			$included=$this->getIncluded($included);
			$useCache=UString::isBooleanTrue($useCache);
			$datas=DAO::getAll($this->model,$condition,$included,$useCache);
			echo $this->responseFormatter->get($datas);
		}catch (\Exception $e){
			$this->_setResponseCode(500);
			echo $this->responseFormatter->formatException($e);
		}
	}

	/**
	 * Get the first object corresponding to the $keyValues
	 * @param string $keyValues primary key(s) value(s) or condition
	 * @param boolean|string $included if true, loads associate members with associations, if string, example : client.*,commands
	 * @param boolean $useCache if true then response is cached
	 */
	public function getOne($keyValues,$included=false,$useCache=false){
		$keyValues=\urldecode($keyValues);
		$included=$this->getIncluded($included);
		$useCache=UString::isBooleanTrue($useCache);
		$data=DAO::getOne($this->model, $keyValues,$included,$useCache);
		if(isset($data)){
			$_SESSION["_restInstance"]=$data;
			echo $this->responseFormatter->getOne($data);
		}
		else{
			$this->_setResponseCode(404);
			echo $this->responseFormatter->format(["message"=>"No result found","keyValues"=>$keyValues]);
		}
	}
	
	private function getIncluded($included){
		if(!UString::isBoolean($included)){
			return explode(",", $included);
		}
		return UString::isBooleanTrue($included);
	}

	public function _format($arrayMessage){
		return $this->responseFormatter->format($arrayMessage);
	}

	/**
	 * @param string $member
	 * @param boolean|string $included if true, loads associate members with associations, if string, example : client.*,commands
	 * @param boolean $useCache
	 * @throws \Exception
	 */
	public function getOneToMany($member,$included=false,$useCache=false){

		if(isset($_SESSION["_restInstance"])){
			$included=$this->getIncluded($included);
			$useCache=UString::isBooleanTrue($useCache);
			$datas=DAO::getOneToMany($_SESSION["_restInstance"], $member,$included,$useCache);
			echo $this->responseFormatter->get($datas);
		}else{
			throw new \Exception("You have to call getOne before calling getOneToMany.");
		}
	}

	/**
	 * @param string $member
	 * @param boolean|string $included if true, loads associate members with associations, if string, example : client.*,commands
	 * @param boolean $useCache
	 * @throws \Exception
	 */
	public function getManyToMany($member,$included=false,$useCache=false){

		if(isset($_SESSION["_restInstance"])){
			$included=$this->getIncluded($included);
			$useCache=UString::isBooleanTrue($useCache);
			$datas=DAO::getManyToMany($_SESSION["_restInstance"], $member,$included,null,$useCache);
			echo $this->responseFormatter->get($datas);
		}else{
			throw new \Exception("You have to call getOne before calling getManyToMany.");
		}
	}

	/**
	 * Update an instance of $model selected by the primary key $keyValues
	 * Require members values in $_POST array
	 * @param array $keyValues
	 * @authorization
	 */
	public function update(...$keyValues){

		$instance=DAO::getOne($this->model, $keyValues);
		if(isset($instance)){
			$this->_setValuesToObject($instance,URequest::getInput());
			$result=DAO::update($instance);
			if($result){
				echo $this->responseFormatter->format(["status"=>"updated","data"=>$this->responseFormatter->cleanRestObject($instance)]);
			}else{
				throw new \Exception("Unable to update the instance");
			}
		}else{
			$this->_setResponseCode(404);
			echo $this->responseFormatter->format(["message"=>"No result found","keyValues"=>$keyValues]);
		}
	}

	/**
	 * Insert a new instance of $model
	 * Require members values in $_POST array
	 * @authorization
	 */
	public function add(){
		$model=$this->model;
		$instance=new $model();
		if(isset($instance)){
			$this->_setValuesToObject($instance,URequest::getInput());
			$result=DAO::insert($instance);
			if($result){
				echo $this->responseFormatter->format(["status"=>"inserted","data"=>$this->responseFormatter->cleanRestObject($instance)]);
			}else{
				throw new \Exception("Unable to insert the instance");
			}
		}else{
			$this->_setResponseCode(500);
			echo $this->responseFormatter->format(["message"=>"Unable to create ".$model." instance"]);
		}
	}

	/**
	 * Delete the instance of $model selected by the primary key $keyValues
	 * Requires an authorization with access token
	 * @param array $keyValues
	 * @route("methods"=>["delete"])
	 * @authorization
	 */
	public function delete(...$keyValues){

		$instance=DAO::getOne($this->model, $keyValues);
		if(isset($instance)){
			$result=DAO::remove($instance);
			if($result){
				echo $this->responseFormatter->format(["status"=>"deleted","data"=>$this->responseFormatter->cleanRestObject($instance)]);
			}else{
				throw new \Exception("Unable to delete the instance");
			}
		}else{
			$this->_setResponseCode(404);
			echo $this->responseFormatter->format(["message"=>"No result found","keyValues"=>$keyValues]);
		}
	}
}


1		<?php
2
3		namespace Ubiquity\controllers\rest;
4
5		use Ubiquity\controllers\Controller;
6		use Ubiquity\orm\DAO;
7		use Ubiquity\controllers\Startup;
8		use Ubiquity\utils\base\UString;
9		use Ubiquity\cache\CacheManager;
10		use Ubiquity\utils\http\URequest;
11
12		/**
13		* @author jc
14		* Abstract base class for Rest controllers
15		*
16		*/
17		abstract class RestController extends Controller {
18		protected $config;
19		protected $model;
20		protected $contentType;
21		protected $restCache;
22		/**
23		* @var ResponseFormatter
24		*/
25		protected $responseFormatter;
26
27		/**
28		* @var RestServer
29		*/
30		protected $server;
31
32		public function __construct(){
33		if(!\headers_sent()){
34		@\set_exception_handler(array ($this,'_errorHandler' ));
35		$this->config=Startup::getConfig();
36		$this->server=new RestServer($this->config);
37		$this->server->cors();
38		$this->responseFormatter=new ResponseFormatter();
39		$this->contentType="application/json";
40		$this->server->_setContentType($this->contentType);
41		$this->restCache=CacheManager::getRestCacheController(\get_class($this));
42		}
43		if (! $this->isValid (Startup::getAction()))
44		$this->onInvalidControl ();
45		}
46
47		public function isValid($action){
48		if(isset($this->restCache["authorizations"])){
49		if(\array_search($action, $this->restCache["authorizations"])!==false){
50		return $this->server->isValid();
51		}
52		}
53		return true;
54		}
55
56		public function onInvalidControl(){
57		throw new \Exception('HTTP/1.1 401 Unauthorized, you need an access token for this request',401);
58		}
59
60		/**
61		* Realise the connection to the server
62		* To override in derived classes to define your own authentication
63		*/
64		public function connect(){
65		$this->server->connect($this);
66		}
67
68		public function initialize(){
69		$thisClass=\get_class($this);
70		if(!isset($this->model))
71		$this->model=CacheManager::getRestResource($thisClass);
72		if(!isset($this->model)){
73		$modelsNS=$this->config["mvcNS"]["models"];
74		$this->model=$modelsNS."\\".$this->responseFormatter->getModel($thisClass);
75		}
76		$this->connectDb($this->config);
77		}
78
79		public function finalize(){
80		parent::finalize();
81		$this->server->finalizeTokens();
82		}
83
84
85
86		public function _errorHandler($e){
87		$code=500;
88		if($e->getCode()!==0)
89		$code=$e->getCode();
90		$this->_setResponseCode($code);
91		echo $this->responseFormatter->formatException($e);
92		}
93
94		public function _setResponseCode($value){
95		\http_response_code($value);
96		}
97
98		protected function connectDb($config){
99		$db=$config["database"];
100		if($db["dbName"]!==""){
101		DAO::connect($db["type"],$db["dbName"],@$db["serverName"],@$db["port"],@$db["user"],@$db["password"],@$db["options"],@$db["cache"]);
102		}
103		}
104
105		/**
106		* Updates $instance with $values
107		* To eventually be redefined in derived classes
108		* @param object $instance the instance to update
109		* @param array\|null $values
110		*/
111		protected function _setValuesToObject($instance,$values=null){
112		if(URequest::isJSON()){
113		$values=\json_decode($values,true);
114		}
115		URequest::setValuesToObject($instance,$values);
116		}
117
118		/**
119		* Returns all objects for the resource $model
120		* @route("cache"=>false)
121		*/
122		public function index() {
123		$datas=DAO::getAll($this->model);
124		echo $this->responseFormatter->get($datas);
125		}
126
127		/**
128		* Default route for requiring a single object
129		* @route("{id}","methods"=>["get","options"])
130		*/
131		public function getById($id){
132		return $this->getOne($id,true,true);
133		}
134
135		/**
136		* Returns a list of objects from the server
137		* @param string $condition the sql Where part
138		* @param boolean\|string $included if true, loads associate members with associations, if string, example : client.*,commands
139		* @param boolean $useCache
140		*/
141		public function get($condition="1=1",$included=false,$useCache=false){
142		try{
143		$condition=\urldecode($condition);
144		$included=$this->getIncluded($included);
145		$useCache=UString::isBooleanTrue($useCache);
146		$datas=DAO::getAll($this->model,$condition,$included,$useCache);
147		echo $this->responseFormatter->get($datas);
148		}catch (\Exception $e){
149		$this->_setResponseCode(500);
150		echo $this->responseFormatter->formatException($e);
151		}
152		}
153
154		/**
155		* Get the first object corresponding to the $keyValues
156		* @param string $keyValues primary key(s) value(s) or condition
157		* @param boolean\|string $included if true, loads associate members with associations, if string, example : client.*,commands
158		* @param boolean $useCache if true then response is cached
159		*/
160		public function getOne($keyValues,$included=false,$useCache=false){
161		$keyValues=\urldecode($keyValues);
162		$included=$this->getIncluded($included);
163		$useCache=UString::isBooleanTrue($useCache);
164		$data=DAO::getOne($this->model, $keyValues,$included,$useCache);
165		if(isset($data)){
166		$_SESSION["_restInstance"]=$data;
167		echo $this->responseFormatter->getOne($data);
168		}
169		else{
170		$this->_setResponseCode(404);
171		echo $this->responseFormatter->format(["message"=>"No result found","keyValues"=>$keyValues]);
172		}
173		}
174
175		private function getIncluded($included){
176		if(!UString::isBoolean($included)){
177		return explode(",", $included);
178		}
179		return UString::isBooleanTrue($included);
180		}
181
182		public function _format($arrayMessage){
183		return $this->responseFormatter->format($arrayMessage);
184		}
185
186		/**
187		* @param string $member
188		* @param boolean\|string $included if true, loads associate members with associations, if string, example : client.*,commands
189		* @param boolean $useCache
190		* @throws \Exception
191		*/
192	View Code Duplication	public function getOneToMany($member,$included=false,$useCache=false){
		0 ignored issues – show Duplication introduced 2018-06-20 01:09 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
193		if(isset($_SESSION["_restInstance"])){
194		$included=$this->getIncluded($included);
195		$useCache=UString::isBooleanTrue($useCache);
196		$datas=DAO::getOneToMany($_SESSION["_restInstance"], $member,$included,$useCache);
197		echo $this->responseFormatter->get($datas);
198		}else{
199		throw new \Exception("You have to call getOne before calling getOneToMany.");
200		}
201		}
202
203		/**
204		* @param string $member
205		* @param boolean\|string $included if true, loads associate members with associations, if string, example : client.*,commands
206		* @param boolean $useCache
207		* @throws \Exception
208		*/
209	View Code Duplication	public function getManyToMany($member,$included=false,$useCache=false){
		0 ignored issues – show Duplication introduced 2018-06-20 01:09 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
210		if(isset($_SESSION["_restInstance"])){
211		$included=$this->getIncluded($included);
212		$useCache=UString::isBooleanTrue($useCache);
213		$datas=DAO::getManyToMany($_SESSION["_restInstance"], $member,$included,null,$useCache);
214		echo $this->responseFormatter->get($datas);
215		}else{
216		throw new \Exception("You have to call getOne before calling getManyToMany.");
217		}
218		}
219
220		/**
221		* Update an instance of $model selected by the primary key $keyValues
222		* Require members values in $_POST array
223		* @param array $keyValues
224		* @authorization
225		*/
226	View Code Duplication	public function update(...$keyValues){
		1 ignored issue – show Duplication introduced 2017-11-30 02:17 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
227		$instance=DAO::getOne($this->model, $keyValues);
228		if(isset($instance)){
229		$this->_setValuesToObject($instance,URequest::getInput());
230		$result=DAO::update($instance);
231		if($result){
232		echo $this->responseFormatter->format(["status"=>"updated","data"=>$this->responseFormatter->cleanRestObject($instance)]);
233		}else{
234		throw new \Exception("Unable to update the instance");
235		}
236		}else{
237		$this->_setResponseCode(404);
238		echo $this->responseFormatter->format(["message"=>"No result found","keyValues"=>$keyValues]);
239		}
240		}
241
242		/**
243		* Insert a new instance of $model
244		* Require members values in $_POST array
245		* @authorization
246		*/
247		public function add(){
248		$model=$this->model;
249		$instance=new $model();
250		if(isset($instance)){
251		$this->_setValuesToObject($instance,URequest::getInput());
252		$result=DAO::insert($instance);
253		if($result){
254		echo $this->responseFormatter->format(["status"=>"inserted","data"=>$this->responseFormatter->cleanRestObject($instance)]);
255		}else{
256		throw new \Exception("Unable to insert the instance");
257		}
258		}else{
259		$this->_setResponseCode(500);
260		echo $this->responseFormatter->format(["message"=>"Unable to create ".$model." instance"]);
261		}
262		}
263
264		/**
265		* Delete the instance of $model selected by the primary key $keyValues
266		* Requires an authorization with access token
267		* @param array $keyValues
268		* @route("methods"=>["delete"])
269		* @authorization
270		*/
271	View Code Duplication	public function delete(...$keyValues){
		0 ignored issues – show Duplication introduced 2017-11-30 02:17 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
272		$instance=DAO::getOne($this->model, $keyValues);
273		if(isset($instance)){
274		$result=DAO::remove($instance);
275		if($result){
276		echo $this->responseFormatter->format(["status"=>"deleted","data"=>$this->responseFormatter->cleanRestObject($instance)]);
277		}else{
278		throw new \Exception("Unable to delete the instance");
279		}
280		}else{
281		$this->_setResponseCode(404);
282		echo $this->responseFormatter->format(["message"=>"No result found","keyValues"=>$keyValues]);
283		}
284		}
285		}
286

phpMv / ubiquity

Push — master ( 9bd3b4...2d1963 )

RestController::getById() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like