Ubiquity\controllers\rest\RestControllerUtilitiesTrait

Complexity

Total Complexity

14

Size/Duplication

Total Lines	80
Duplicated Lines	0 %

Test Coverage

Coverage

29.73%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getResponseFormatter()	0	2	1
A	operate_()	0	12	3
A	_setValuesToObject()	0	5	2
A	_getResponseFormatter()	0	5	2
A	getMany_()	0	8	2
A	connectDb()	0	4	2
A	getIncluded()	0	5	2

<?php

namespace Ubiquity\controllers\rest;

use Ubiquity\orm\DAO;
use Ubiquity\utils\http\URequest;
use Ubiquity\utils\base\UString;

/**
 * @author jc
 * @property ResponseFormatter $responseFormatter
 */
trait RestControllerUtilitiesTrait {
	
	abstract public function _setResponseCode($value);
	
	protected function operate_($instance,$callback,$status,$exceptionMessage,$keyValues){
		if(isset($instance)){
			$result=$callback($instance);
			if($result){
				$formatter=$this->_getResponseFormatter();
				echo $formatter->format(["status"=>$status,"data"=>$formatter->cleanRestObject($instance)]);
			}else{
				throw new \Exception($exceptionMessage);
			}
		}else{
			$this->_setResponseCode(404);
			echo $this->_getResponseFormatter()->format(["message"=>"No result found","keyValues"=>$keyValues]);
		}
	}
	
	protected function _getResponseFormatter(){
		if(!isset($this->responseFormatter)){
			$this->responseFormatter=$this->getResponseFormatter();
		}
		return $this->responseFormatter;
	}
	
	/**
	 * To override, returns the active formatter for the response
	 * @return \Ubiquity\controllers\rest\ResponseFormatter
	 */
	protected function getResponseFormatter(){
		return new ResponseFormatter();
	}
	
	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);
	}
	
	/**
	 * @param string|boolean $included
	 * @return array|boolean
	 */
	private function getIncluded($included){
		if(!UString::isBoolean($included)){
			return explode(",", $included);
		}
		return UString::isBooleanTrue($included);
	}
	
	/**
	 * @param callable $getDatas
	 * @param string $member
	 * @param boolean|string $included if true, loads associate members with associations, if string, example : client.*,commands
	 * @param boolean $useCache
	 * @throws \Exception
	 */
	protected function getMany_($getDatas,$member,$included=false,$useCache=false){
		if(isset($_SESSION["_restInstance"])){
			$included=$this->getIncluded($included);
			$useCache=UString::isBooleanTrue($useCache);
			$datas=$getDatas($_SESSION["_restInstance"],$member,$included,$useCache);
			echo $this->_getResponseFormatter()->get($datas);
		}else{
			throw new \Exception("You have to call getOne before calling getManyToMany or getOneToMany.");
		}
	}
	
	
}