JsonApiRestController::connect() - Code Metrics - Inspection of "9957c5e601653027899ca46a5c4b00c4f8cb96c2" - phpMv/ubiquity - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Branch — master (9957c5)

by Jean-Christophe

created 2019-07-07 03:14 UTC

JsonApiRestController::connect() A

↳ Parent: JsonApiRestController

Complexity

Conditions	1
Paths	1

Size

Total Lines	2
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	1
c	1
b	0
f	0
dl	0
loc	2
ccs	0
cts	2
cp	0
rs	10
cc	1
nc	1
nop	0
crap	2

<?php

/**
 * JsonApi implementation
 */
namespace Ubiquity\controllers\rest\api\jsonapi;

use Ubiquity\orm\DAO;
use Ubiquity\controllers\rest\RestError;
use Ubiquity\controllers\Startup;
use Ubiquity\controllers\rest\RestBaseController;
use Ubiquity\utils\http\URequest;
use Ubiquity\orm\OrmUtils;
use Ubiquity\controllers\rest\RestServer;
use Ubiquity\controllers\crud\CRUDHelper;

/**
 * Rest JsonAPI implementation.
 * Ubiquity\controllers\rest\api\jsonapi$JsonApiRestController
 * This class is part of Ubiquity
 *
 * @author jcheron <[email protected]>
 * @version 1.1.3
 * @since Ubiquity 2.0.11
 *
 */
abstract class JsonApiRestController extends RestBaseController {
	const API_VERSION = 'JsonAPI 1.0';

	protected function _setResource($resource) {
		$modelsNS = $this->config ["mvcNS"] ["models"];
		$this->model = $modelsNS . "\\" . $this->_getResponseFormatter ()->getModel ( $resource );
	}

	protected function _checkResource($resource, $callback) {
		$this->_setResource ( $resource );
		if (class_exists ( $this->model )) {
			$callback ();
		} else {
			$this->_setResponseCode ( 404 );
			$error = new RestError ( 404, "Not existing class", $this->model . " class does not exists!", Startup::getController () . "/" . Startup::getAction () );
			echo $this->_format ( $error->asArray () );
		}
	}

	protected function getDatas() {
		$datas = URequest::getRealInput ();
		if (sizeof ( $datas ) > 0) {
			$datas = current ( array_keys ( $datas ) );
			$datas = json_decode ( $datas, true );
			$attributes = $datas ["data"] ["attributes"] ?? [ ];
			if (isset ( $datas ["data"] ["id"] )) {
				$key = OrmUtils::getFirstKey ( $this->model );
				$attributes [$key] = $datas ["data"] ["id"];
			}
			$this->loadRelationshipsDatas ( $datas, $attributes );
			return $attributes;
		}
		$this->addError ( 204, 'No content', 'The POST request has no content!' );
	}

	protected function loadRelationshipsDatas($datas, &$attributes) {
		if (isset ( $datas ['data'] ['relationships'] )) {
			$relationShips = $datas ['data'] ['relationships'];
			foreach ( $relationShips as $member => $data ) {
				if (isset ( $data ['data'] ['id'] )) {
					$m = OrmUtils::getJoinColumnName ( $this->model, $member );
					$attributes [$m] = $data ['data'] ['id'];
				}
			}
		}
	}

	/**
	 *
	 * @return RestServer
	 */
	protected function getRestServer(): RestServer {
		return new JsonApiRestServer ( $this->config );
	}

	protected function updateOperation($instance, $datas, $updateMany = false) {
		$instance->_new = false;
		return CRUDHelper::update ( $instance, $datas, false, $updateMany );
	}

	protected function AddOperation($instance, $datas, $insertMany = false) {
		$instance->_new = true;
		return CRUDHelper::update ( $instance, $datas, false, $insertMany );
	}

	/**
	 * Route for CORS
	 *
	 * @route("{resource}","methods"=>["options"],"priority"=>3000)
	 */
	public function options(...$resource) {
	}

	/**
	 *
	 * {@inheritdoc}
	 * @see \Ubiquity\controllers\rest\RestBaseController::index()
	 * @route("links/","methods"=>["get"],"priority"=>3000)
	 */
	public function index() {
		parent::index ();
	}

	/**
	 *
	 * {@inheritdoc}
	 * @see \Ubiquity\controllers\rest\RestBaseController::connect()
	 * @route("connect/","priority"=>2500)
	 */
	public function connect() {
		parent::connect ();
	}

	/**
	 * Returns all the instances from the model $resource.
	 * Query parameters:
	 * - **include**: A string of associated members to load, comma separated (e.g. users,groups,organization...), or a boolean: true for all members, false for none (default: true).
	 * - **filter**: The filter to apply to the query (where part of an SQL query) (default: 1=1).
	 * - **page[number]**: The page to display (in this case, the page size is set to 1).
	 * - **page[size]**: The page size (count of instance per page) (default: 1).
	 *
	 * @route("{resource}/","methods"=>["get"],"priority"=>0)
	 */
	public function getAll_($resource) {
		$this->_checkResource ( $resource, function () {
			$filter = $this->getCondition ( $this->getRequestParam ( 'filter', '1=1' ) );
			$pages = null;
			if (isset ( $_GET ['page'] )) {
				$pageNumber = $_GET ['page'] ['number'];
				$pageSize = $_GET ['page'] ['size'] ?? 1;
				$pages = $this->generatePagination ( $filter, $pageNumber, $pageSize );
			}
			$datas = DAO::getAll ( $this->model, $filter, $this->getInclude ( $this->getRequestParam ( 'include', true ) ) );
			echo $this->_getResponseFormatter ()->get ( $datas, $pages );
		} );
	}

	/**
	 * Returns an instance of $resource, by primary key $id.
	 *
	 * @param string $resource The resource (model) to use
	 * @param string $id The primary key value(s), if the primary key is composite, use a comma to separate the values (e.g. 1,115,AB)
	 *
	 * @route("{resource}/{id}/","methods"=>["get"],"priority"=>1000)
	 */
	public function getOne_($resource, $id) {
		$this->_checkResource ( $resource, function () use ($id) {
			$this->_getOne ( $id, true, false );
		} );
	}

	/**
	 * Returns an associated member value(s).
	 * Query parameters:
	 * - **include**: A string of associated members to load, comma separated (e.g. users,groups,organization...), or a boolean: true for all members, false for none (default: true).
	 *
	 * @param string $resource The resource (model) to use
	 * @param string $id The primary key value(s), if the primary key is composite, use a comma to separate the values (e.g. 1,115,AB)
	 * @param string $member The member to load
	 *
	 * @route("{resource}/{id}/relationships/{member}/","methods"=>["get"],"priority"=>2000)
	 */
	public function getRelationShip_($resource, $id, $member) {
		$this->_checkResource ( $resource, function () use ($id, $member) {
			$relations = OrmUtils::getAnnotFieldsInRelations ( $this->model );
			if (isset ( $relations [$member] )) {
				$include = $this->getRequestParam ( 'include', true );
				switch ($relations [$member] ['type']) {
					case 'manyToOne' :
						$this->_getManyToOne ( $id, $member, $include );
						break;
					case 'oneToMany' :
						$this->_getOneToMany ( $id, $member, $include );
						break;
					case 'manyToMany' :
						$this->_getManyToMany ( $id, $member, $include );
						break;
				}
			}
		} );
	}

	/**
	 * Inserts a new instance of $resource.
	 * Data attributes are send in data[attributes] request body (in JSON format)
	 *
	 * @param string $resource The resource (model) to use
	 * @route("{resource}/","methods"=>["post"],"priority"=>0)
	 * @authorization
	 */
	public function add_($resource) {
		$this->_checkResource ( $resource, function () {
			parent::_add ();
		} );
	}

	/**
	 * Updates an existing instance of $resource.
	 * Data attributes are send in data[attributes] request body (in JSON format)
	 *
	 * @param string $resource The resource (model) to use
	 *
	 * @route("{resource}/{id}","methods"=>["patch"],"priority"=>0)
	 * @authorization
	 */
	public function update_($resource, ...$id) {
		$this->_checkResource ( $resource, function () use ($id) {
			if (! $this->hasErrors ()) {
				parent::_update ( ...$id );
			} else {
				echo $this->displayErrors ();
			}
		} );
	}

	/**
	 * Deletes an existing instance of $resource.
	 *
	 * @param string $resource The resource (model) to use
	 * @param string $ids The primary key value(s), if the primary key is composite, use a comma to separate the values (e.g. 1,115,AB)
	 *
	 * @route("{resource}/{id}/","methods"=>["delete"],"priority"=>0)
	 * @authorization
	 */
	public function delete_($resource, ...$id) {
		$this->_checkResource ( $resource, function () use ($id) {
			$this->_delete ( ...$id );
		} );
	}

	/**
	 * Returns the api version.
	 *
	 * @return string
	 */
	public static function _getApiVersion() {
		return self::API_VERSION;
	}

	/**
	 * Returns the template for creating this type of controller
	 *
	 * @return string
	 */
	public static function _getTemplateFile() {
		return 'restApiController.tpl';
	}
}



1		<?php
2
3		/**
4		* JsonApi implementation
5		*/
6		namespace Ubiquity\controllers\rest\api\jsonapi;
7
8		use Ubiquity\orm\DAO;
9		use Ubiquity\controllers\rest\RestError;
10		use Ubiquity\controllers\Startup;
11		use Ubiquity\controllers\rest\RestBaseController;
12		use Ubiquity\utils\http\URequest;
13		use Ubiquity\orm\OrmUtils;
14		use Ubiquity\controllers\rest\RestServer;
15		use Ubiquity\controllers\crud\CRUDHelper;
16
17		/**
18		* Rest JsonAPI implementation.
19		* Ubiquity\controllers\rest\api\jsonapi$JsonApiRestController
20		* This class is part of Ubiquity
21		*
22		* @author jcheron <[email protected]>
23		* @version 1.1.3
24		* @since Ubiquity 2.0.11
25		*
26		*/
27		abstract class JsonApiRestController extends RestBaseController {
28		const API_VERSION = 'JsonAPI 1.0';
29
30	6	protected function _setResource($resource) {
31	6	$modelsNS = $this->config ["mvcNS"] ["models"];
32	6	$this->model = $modelsNS . "\\" . $this->_getResponseFormatter ()->getModel ( $resource );
33	6	}
34
35	6	protected function _checkResource($resource, $callback) {
36	6	$this->_setResource ( $resource );
37	6	if (class_exists ( $this->model )) {
38	6	$callback ();
39		} else {
40		$this->_setResponseCode ( 404 );
41		$error = new RestError ( 404, "Not existing class", $this->model . " class does not exists!", Startup::getController () . "/" . Startup::getAction () );
42		echo $this->_format ( $error->asArray () );
43		}
44	6	}
45
46	1	protected function getDatas() {
47	1	$datas = URequest::getRealInput ();
48	1	if (sizeof ( $datas ) > 0) {
49	1	$datas = current ( array_keys ( $datas ) );
50	1	$datas = json_decode ( $datas, true );
51	1	$attributes = $datas ["data"] ["attributes"] ?? [ ];
52	1	if (isset ( $datas ["data"] ["id"] )) {
53		$key = OrmUtils::getFirstKey ( $this->model );
54		$attributes [$key] = $datas ["data"] ["id"];
55		}
56	1	$this->loadRelationshipsDatas ( $datas, $attributes );
57	1	return $attributes;
58		}
59		$this->addError ( 204, 'No content', 'The POST request has no content!' );
60		}
61
62	1	protected function loadRelationshipsDatas($datas, &$attributes) {
63	1	if (isset ( $datas ['data'] ['relationships'] )) {
64		$relationShips = $datas ['data'] ['relationships'];
65		foreach ( $relationShips as $member => $data ) {
66		if (isset ( $data ['data'] ['id'] )) {
67		$m = OrmUtils::getJoinColumnName ( $this->model, $member );
68		$attributes [$m] = $data ['data'] ['id'];
69		}
70		}
71		}
72	1	}
73
74		/**
75		*
76		* @return RestServer
77		*/
78	7	protected function getRestServer(): RestServer {
79	7	return new JsonApiRestServer ( $this->config );
80		}
81
82	1	protected function updateOperation($instance, $datas, $updateMany = false) {
83	1	$instance->_new = false;
84	1	return CRUDHelper::update ( $instance, $datas, false, $updateMany );
85		}
86
87	1	protected function AddOperation($instance, $datas, $insertMany = false) {
88	1	$instance->_new = true;
89	1	return CRUDHelper::update ( $instance, $datas, false, $insertMany );
90		}
91
92		/**
93		* Route for CORS
94		*
95		* @route("{resource}","methods"=>["options"],"priority"=>3000)
96		*/
97		public function options(...$resource) {
98		}
99
100		/**
101		*
102		* {@inheritdoc}
103		* @see \Ubiquity\controllers\rest\RestBaseController::index()
104		* @route("links/","methods"=>["get"],"priority"=>3000)
105		*/
106	1	public function index() {
107	1	parent::index ();
108	1	}
109
110		/**
111		*
112		* {@inheritdoc}
113		* @see \Ubiquity\controllers\rest\RestBaseController::connect()
114		* @route("connect/","priority"=>2500)
115		*/
116		public function connect() {
117		parent::connect ();
118		}
119
120		/**
121		* Returns all the instances from the model $resource.
122		* Query parameters:
123		* - include: A string of associated members to load, comma separated (e.g. users,groups,organization...), or a boolean: true for all members, false for none (default: true).
124		* - filter: The filter to apply to the query (where part of an SQL query) (default: 1=1).
125		* - page[number]: The page to display (in this case, the page size is set to 1).
126		* - page[size]: The page size (count of instance per page) (default: 1).
127		*
128		* @route("{resource}/","methods"=>["get"],"priority"=>0)
129		*/
130	1	public function getAll_($resource) {
131		$this->_checkResource ( $resource, function () {
132	1	$filter = $this->getCondition ( $this->getRequestParam ( 'filter', '1=1' ) );
133	1	$pages = null;
134	1	if (isset ( $_GET ['page'] )) {
135		$pageNumber = $_GET ['page'] ['number'];
136		$pageSize = $_GET ['page'] ['size'] ?? 1;
137		$pages = $this->generatePagination ( $filter, $pageNumber, $pageSize );
138		}
139	1	$datas = DAO::getAll ( $this->model, $filter, $this->getInclude ( $this->getRequestParam ( 'include', true ) ) );
140	1	echo $this->_getResponseFormatter ()->get ( $datas, $pages );
141	1	} );
142	1	}
143
144		/**
145		* Returns an instance of $resource, by primary key $id.
146		*
147		* @param string $resource The resource (model) to use
148		* @param string $id The primary key value(s), if the primary key is composite, use a comma to separate the values (e.g. 1,115,AB)
149		*
150		* @route("{resource}/{id}/","methods"=>["get"],"priority"=>1000)
151		*/
152	2	public function getOne_($resource, $id) {
153		$this->_checkResource ( $resource, function () use ($id) {
154	2	$this->_getOne ( $id, true, false );
155	2	} );
156	2	}
157
158		/**
159		* Returns an associated member value(s).
160		* Query parameters:
161		* - include: A string of associated members to load, comma separated (e.g. users,groups,organization...), or a boolean: true for all members, false for none (default: true).
162		*
163		* @param string $resource The resource (model) to use
164		* @param string $id The primary key value(s), if the primary key is composite, use a comma to separate the values (e.g. 1,115,AB)
165		* @param string $member The member to load
166		*
167		* @route("{resource}/{id}/relationships/{member}/","methods"=>["get"],"priority"=>2000)
168		*/
169	3	public function getRelationShip_($resource, $id, $member) {
170		$this->_checkResource ( $resource, function () use ($id, $member) {
171	3	$relations = OrmUtils::getAnnotFieldsInRelations ( $this->model );
172	3	if (isset ( $relations [$member] )) {
173	3	$include = $this->getRequestParam ( 'include', true );
174	3	switch ($relations [$member] ['type']) {
175	3	case 'manyToOne' :
176	1	$this->_getManyToOne ( $id, $member, $include );
177	1	break;
178	2	case 'oneToMany' :
179	1	$this->_getOneToMany ( $id, $member, $include );
180	1	break;
181	1	case 'manyToMany' :
182	1	$this->_getManyToMany ( $id, $member, $include );
183	1	break;
184		}
185		}
186	3	} );
187	3	}
188
189		/**
190		* Inserts a new instance of $resource.
191		* Data attributes are send in data[attributes] request body (in JSON format)
192		*
193		* @param string $resource The resource (model) to use
194		* @route("{resource}/","methods"=>["post"],"priority"=>0)
195		* @authorization
196		*/
197	1	public function add_($resource) {
198		$this->_checkResource ( $resource, function () {
199	1	parent::_add ();
200	1	} );
201	1	}
202
203		/**
204		* Updates an existing instance of $resource.
205		* Data attributes are send in data[attributes] request body (in JSON format)
206		*
207		* @param string $resource The resource (model) to use
208		*
209		* @route("{resource}/{id}","methods"=>["patch"],"priority"=>0)
210		* @authorization
211		*/
212	1	public function update_($resource, ...$id) {
213		$this->_checkResource ( $resource, function () use ($id) {
214	1	if (! $this->hasErrors ()) {
215	1	parent::_update ( ...$id );
216		} else {
217		echo $this->displayErrors ();
218		}
219	1	} );
220	1	}
221
222		/**
223		* Deletes an existing instance of $resource.
224		*
225		* @param string $resource The resource (model) to use
226		* @param string $ids The primary key value(s), if the primary key is composite, use a comma to separate the values (e.g. 1,115,AB)
227		*
228		* @route("{resource}/{id}/","methods"=>["delete"],"priority"=>0)
229		* @authorization
230		*/
231	1	public function delete_($resource, ...$id) {
232		$this->_checkResource ( $resource, function () use ($id) {
233	1	$this->_delete ( ...$id );
234	1	} );
235	1	}
236
237		/**
238		* Returns the api version.
239		*
240		* @return string
241		*/
242	1	public static function _getApiVersion() {
243	1	return self::API_VERSION;
244		}
245
246		/**
247		* Returns the template for creating this type of controller
248		*
249		* @return string
250		*/
251		public static function _getTemplateFile() {
252		return 'restApiController.tpl';
253		}
254		}
255
256

phpMv / ubiquity

Branch — master (9957c5)

JsonApiRestController::connect() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like