CardApiController - Code Metrics - nextcloud/deck - Measure and Improve Code Quality continuously with Scrutinizer

CardApiController A
last analyzed 2020-03-02 02:31 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	130
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

Metric	Value
wmc	10
lcom	1
cbo	4
dl	0
loc	130
rs	10
c	0
b	0
f	0

10 Methods

Rating	Name	Size	Complexity
A	delete()	4	1
A	assignLabel()	4	1
A	removeLabel()	4	1
A	unassignUser()	4	1
A	__construct()	5	1
A	get()	4	1
A	create()	4	1
A	update()	4	1
A	assignUser()	4	1
A	reorder()	4	1

<?php
/**
 * @copyright Copyright (c) 2018 Ryan Fletcher <[email protected]>
 *
 * @copyright Copyright (c) 2019, Alexandru Puiu ([email protected])
 *
 * @author Ryan Fletcher <[email protected]>
 *
 * @license GNU AGPL version 3 or any later version
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Affero General Public License as
 *  published by the Free Software Foundation, either version 3 of the
 *  License, or (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Affero General Public License for more details.
 *
 *  You should have received a copy of the GNU Affero General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

 namespace OCA\Deck\Controller;

 use OCP\AppFramework\ApiController;
 use OCP\AppFramework\Http;
 use OCP\AppFramework\Http\DataResponse;
 use OCP\IRequest;
 use OCA\Deck\Service\CardService;

 /**
 * Class BoardApiController
 *
 * @package OCA\Deck\Controller
 */
class CardApiController extends ApiController {
	private $cardService;
	private $userId;

	/**
	 * @param string $appName
	 * @param IRequest $request
	 * @param CardService $cardService
	 * @param $userId
	 */
	public function __construct($appName, IRequest $request, CardService $cardService, $userId) {
		parent::__construct($appName, $request);
		$this->cardService = $cardService;
		$this->userId = $userId;
	}

	/**
	 * @NoAdminRequired
	 * @CORS
	 * @NoCSRFRequired
	 *
	 * Get a specific card.
	 */
	public function get() {
		$card = $this->cardService->find($this->request->getParam('cardId'));
		return new DataResponse($card, HTTP::STATUS_OK);
	}

	/**
	 * @NoAdminRequired
	 * @CORS
	 * @NoCSRFRequired
	 *
	 * @params $title
	 * @params $type
	 * @params $order
	 * @params $description
	 *
	 * Get a specific card.
	 */
	public function create($title, $type = 'plain', $order = 999, $description = '') {
		$card = $this->cardService->create($title, $this->request->getParam('stackId'), $type, $order, $this->userId, $description);
		return new DataResponse($card, HTTP::STATUS_OK);
	}

	/**
	 * @NoAdminRequired
	 * @CORS
	 * @NoCSRFRequired
	 *
	 *
	 * Update a card
	 */
	public function update($title, $type, $order = 0, $description = '', $owner, $duedate = null, $archived = null) {
		$card = $this->cardService->update($this->request->getParam('cardId'), $title, $this->request->getParam('stackId'), $type, $order, $description, $owner, $duedate, 0, $archived);
		return new DataResponse($card, HTTP::STATUS_OK);
	}

	/**
	 * @NoAdminRequired
	 * @CORS
	 * @NoCSRFRequired
	 *
	 * Delete a specific card.
	 */
	public function delete() {
		$card = $this->cardService->delete($this->request->getParam('cardId'));
		return new DataResponse($card, HTTP::STATUS_OK);
	}

	/**
	 * @NoAdminRequired
	 * @CORS
	 * @NoCSRFRequired
	 *
	 * Assign a label to a card.
	 */
	public function assignLabel($labelId) {
		$card = $this->cardService->assignLabel($this->request->getParam('cardId'), $labelId);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
		return new DataResponse($card, HTTP::STATUS_OK);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

	/**
	 * @NoAdminRequired
	 * @CORS
	 * @NoCSRFRequired
	 *
	 * Assign a label to a card.
	 */
	public function removeLabel($labelId) {
		$card = $this->cardService->removeLabel($this->request->getParam('cardId'), $labelId);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
		return new DataResponse($card, HTTP::STATUS_OK);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

	/**
	 * @NoAdminRequired
	 * @CORS
	 * @NoCSRFRequired
	 *
	 * Unassign a user from a card
	 */
	public function unassignUser($userId) {
		$card = $this->cardService->unassignUser($this->request->getParam('cardId'), $userId);
		return new DataResponse($card, HTTP::STATUS_OK);
	}

	/**
	 * @NoAdminRequired
	 * @CORS
	 * @NoCSRFRequired
	 *
	 * Assign a user to a card
	 */
	public function assignUser($userId) {
		$card = $this->cardService->assignUser($this->request->getParam('cardId'), $userId);;
		return new DataResponse($card, HTTP::STATUS_OK);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
	}

	/**
	 * @NoAdminRequired
	 * @CORS
	 * @NoCSRFRequired
	 *
	 * Reorder cards
	 */
	public function reorder($stackId, $order) {
		$card = $this->cardService->reorder($this->request->getParam('cardId'), $stackId, $order);
		return new DataResponse($card, HTTP::STATUS_OK);
	}
}


1			<?php
2			/**
3			* @copyright Copyright (c) 2018 Ryan Fletcher <[email protected]>
4			*
5			* @copyright Copyright (c) 2019, Alexandru Puiu ([email protected])
6			*
7			* @author Ryan Fletcher <[email protected]>
8			*
9			* @license GNU AGPL version 3 or any later version
10			*
11			* This program is free software: you can redistribute it and/or modify
12			* it under the terms of the GNU Affero General Public License as
13			* published by the Free Software Foundation, either version 3 of the
14			* License, or (at your option) any later version.
15			*
16			* This program is distributed in the hope that it will be useful,
17			* but WITHOUT ANY WARRANTY; without even the implied warranty of
18			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19			* GNU Affero General Public License for more details.
20			*
21			* You should have received a copy of the GNU Affero General Public License
22			* along with this program. If not, see <http://www.gnu.org/licenses/>.
23			*
24			*/
25
26			namespace OCA\Deck\Controller;
27
28			use OCP\AppFramework\ApiController;
29			use OCP\AppFramework\Http;
30			use OCP\AppFramework\Http\DataResponse;
31			use OCP\IRequest;
32			use OCA\Deck\Service\CardService;
33
34			/**
35			* Class BoardApiController
36			*
37			* @package OCA\Deck\Controller
38			*/
39			class CardApiController extends ApiController {
40			private $cardService;
41			private $userId;
42
43			/**
44			* @param string $appName
45			* @param IRequest $request
46			* @param CardService $cardService
47			* @param $userId
48			*/
49			public function __construct($appName, IRequest $request, CardService $cardService, $userId) {
50			parent::__construct($appName, $request);
51			$this->cardService = $cardService;
52			$this->userId = $userId;
53			}
54
55			/**
56			* @NoAdminRequired
57			* @CORS
58			* @NoCSRFRequired
59			*
60			* Get a specific card.
61			*/
62			public function get() {
63			$card = $this->cardService->find($this->request->getParam('cardId'));
64			return new DataResponse($card, HTTP::STATUS_OK);
65			}
66
67			/**
68			* @NoAdminRequired
69			* @CORS
70			* @NoCSRFRequired
71			*
72			* @params $title
73			* @params $type
74			* @params $order
75			* @params $description
76			*
77			* Get a specific card.
78			*/
79			public function create($title, $type = 'plain', $order = 999, $description = '') {
80			$card = $this->cardService->create($title, $this->request->getParam('stackId'), $type, $order, $this->userId, $description);
81			return new DataResponse($card, HTTP::STATUS_OK);
82			}
83
84			/**
85			* @NoAdminRequired
86			* @CORS
87			* @NoCSRFRequired
88			*
89			*
90			* Update a card
91			*/
92			public function update($title, $type, $order = 0, $description = '', $owner, $duedate = null, $archived = null) {
93			$card = $this->cardService->update($this->request->getParam('cardId'), $title, $this->request->getParam('stackId'), $type, $order, $description, $owner, $duedate, 0, $archived);
94			return new DataResponse($card, HTTP::STATUS_OK);
95			}
96
97			/**
98			* @NoAdminRequired
99			* @CORS
100			* @NoCSRFRequired
101			*
102			* Delete a specific card.
103			*/
104			public function delete() {
105			$card = $this->cardService->delete($this->request->getParam('cardId'));
106			return new DataResponse($card, HTTP::STATUS_OK);
107			}
108
109			/**
110			* @NoAdminRequired
111			* @CORS
112			* @NoCSRFRequired
113			*
114			* Assign a label to a card.
115			*/
116			public function assignLabel($labelId) {
117			$card = $this->cardService->assignLabel($this->request->getParam('cardId'), $labelId);
			0 ignored issues – show Bug introduced 2018-07-20 15:20 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$card` is correct as `$this->cardService->assi...am('cardId'), $labelId)` (which targets `OCA\Deck\Service\CardService::assignLabel()`) seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
118			return new DataResponse($card, HTTP::STATUS_OK);
			0 ignored issues – show Documentation introduced 2019-08-19 07:19 UTC by Report Bug Copy Issue Report `$card` is of type `null`, but the function expects a `array\|object`. 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...
119			}
120
121			/**
122			* @NoAdminRequired
123			* @CORS
124			* @NoCSRFRequired
125			*
126			* Assign a label to a card.
127			*/
128			public function removeLabel($labelId) {
129			$card = $this->cardService->removeLabel($this->request->getParam('cardId'), $labelId);
			0 ignored issues – show Bug introduced 2018-07-20 15:20 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$card` is correct as `$this->cardService->remo...am('cardId'), $labelId)` (which targets `OCA\Deck\Service\CardService::removeLabel()`) seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
130			return new DataResponse($card, HTTP::STATUS_OK);
			0 ignored issues – show Documentation introduced 2019-08-19 07:19 UTC by Report Bug Copy Issue Report `$card` is of type `null`, but the function expects a `array\|object`. 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...
131			}
132
133			/**
134			* @NoAdminRequired
135			* @CORS
136			* @NoCSRFRequired
137			*
138			* Unassign a user from a card
139			*/
140			public function unassignUser($userId) {
141			$card = $this->cardService->unassignUser($this->request->getParam('cardId'), $userId);
142			return new DataResponse($card, HTTP::STATUS_OK);
143			}
144
145			/**
146			* @NoAdminRequired
147			* @CORS
148			* @NoCSRFRequired
149			*
150			* Assign a user to a card
151			*/
152			public function assignUser($userId) {
153			$card = $this->cardService->assignUser($this->request->getParam('cardId'), $userId);;
154			return new DataResponse($card, HTTP::STATUS_OK);
			0 ignored issues – show Bug introduced 2019-12-19 19:29 UTC by Report Bug Copy Issue Report It seems like `$card` defined by `$this->cardService->assi...ram('cardId'), $userId)` on line `153` can be `null`; however, `OCP\AppFramework\Http\DataResponse::__construct()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
155			}
156
157			/**
158			* @NoAdminRequired
159			* @CORS
160			* @NoCSRFRequired
161			*
162			* Reorder cards
163			*/
164			public function reorder($stackId, $order) {
165			$card = $this->cardService->reorder($this->request->getParam('cardId'), $stackId, $order);
166			return new DataResponse($card, HTTP::STATUS_OK);
167			}
168			}
169

nextcloud / deck

CardApiController A last analyzed 2020-03-02 02:31 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

10 Methods

Duplication Side-by-Side

Filter issues like

CardApiController A
last analyzed 2020-03-02 02:31 UTC