BoardApiController::__construct() - Code Metrics - nextcloud/deck - Measure and Improve Code Quality continuously with Scrutinizer

BoardApiController::__construct() A
last analyzed 2020-03-02 02:31 UTC

↳ Parent: BoardApiController

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	5
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	4

<?php
/**
 * @copyright Copyright (c) 2017 Steven R. Baker <[email protected]>
 *
 * @author Steven R. Baker <[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 OCA\Deck\StatusException;
use OCP\AppFramework\ApiController;
use OCP\AppFramework\Http;
use OCP\AppFramework\Http\DataResponse;
use OCP\IRequest;

use OCA\Deck\Service\BoardService;
use Sabre\HTTP\Util;

/**
 * Class BoardApiController
 *
 * @package OCA\Deck\Controller
 */
class BoardApiController extends ApiController {

	private $boardService;

	/**
	 * @param string $appName
	 * @param IRequest $request
	 * @param BoardService $service
	 * @param $userId
	 */
	public function __construct($appName, IRequest $request, BoardService $service, $userId) {
		parent::__construct($appName, $request);
		$this->boardService = $service;
		$this->userId = $userId;
class MyClass { }

$x = new MyClass();
$x->foo = true;
	}

	/**
	 * @NoAdminRequired
	 * @CORS
	 * @NoCSRFRequired
	 *
	 * Return all of the boards that the current user has access to.
	 * @throws StatusException
	 */
	public function index($details = null) {
		$modified = $this->request->getHeader('If-Modified-Since');
		if ($modified === null || $modified === '') {
			$boards = $this->boardService->findAll(0, $details);
		} else {
			$date = Util::parseHTTPDate($modified);
			if (!$date) {
				throw new StatusException('Invalid If-Modified-Since header provided.');
			}
			$boards = $this->boardService->findAll($date->getTimestamp(), $details);
		}
		return new DataResponse($boards, HTTP::STATUS_OK);
	 }

	/**
	 * @NoAdminRequired
	 * @CORS
	 * @NoCSRFRequired
	 *
	 *
	 * Return the board specified by $this->request->getParam('boardId').
	 */
	public function get() {
		$board = $this->boardService->find($this->request->getParam('boardId'));
		return new DataResponse($board, HTTP::STATUS_OK);
	}

	/**
	 * @NoAdminRequired
	 * @CORS
	 * @NoCSRFRequired
	 *
	 * @params $title
	 * @params $color
	 *
	 * Create a board with the specified title and color.
	 */
	public function create($title, $color) {
		$board = $this->boardService->create($title, $this->userId, $color);
		return new DataResponse($board, HTTP::STATUS_OK);
	}

	/**
	 * @NoAdminRequired
	 * @CORS
	 * @NoCSRFRequired
	 *
	 * @params $title
	 * @params $color
	 * @params $archived
	 *
	 * Update a board with the specified boardId, title and color, and archived state.
	 */
	public function update($title, $color, $archived = false) {
		$board = $this->boardService->update($this->request->getParam('boardId'), $title, $color, $archived);
		return new DataResponse($board, HTTP::STATUS_OK);
	}

	/**
	 * @NoAdminRequired
	 * @CORS
	 * @NoCSRFRequired
	 *
	 *
	 * Delete the board specified by $boardId.  Return the board that was deleted.
	 */
	public function delete() {
		$board = $this->boardService->delete($this->request->getParam('boardId'));
		return new DataResponse($board, HTTP::STATUS_OK);
	}

	/**
	 * @NoAdminRequired
	 * @CORS
	 * @NoCSRFRequired
	 *
	 *
	 * Undo the deletion of the board specified by $boardId.
	 */
	public function undoDelete() {
		$board = $this->boardService->deleteUndo($this->request->getParam('boardId'));
		return new DataResponse($board, HTTP::STATUS_OK);
	}

	/**
	 * @NoAdminRequired
	 * @CORS
	 * @NoCSRFRequired
	 */
	public function addAcl($boardId, $type, $participant, $permissionEdit, $permissionShare, $permissionManage) {
		$acl = $this->boardService->addAcl($boardId, $type, $participant, $permissionEdit, $permissionShare, $permissionManage);
		return new DataResponse($acl, HTTP::STATUS_OK);
	}

	/**
	 * @NoAdminRequired
	 * @CORS
	 * @NoCSRFRequired
	 */
	public function updateAcl($aclId, $permissionEdit, $permissionShare, $permissionManage) {
		$acl = $this->boardService->updateAcl($aclId, $permissionEdit, $permissionShare, $permissionManage);
		return new DataResponse($acl, HTTP::STATUS_OK);
	}

	/**
	 * @NoAdminRequired
	 * @CORS
	 * @NoCSRFRequired
	 */
	public function deleteAcl($aclId) {
		$acl = $this->boardService->deleteAcl($aclId);
		return new DataResponse($acl, HTTP::STATUS_OK);
	}

}


1			<?php
2			/**
3			* @copyright Copyright (c) 2017 Steven R. Baker <[email protected]>
4			*
5			* @author Steven R. Baker <[email protected]>
6			* @author Ryan Fletcher <[email protected]>
7			*
8			* @license GNU AGPL version 3 or any later version
9			*
10			* This program is free software: you can redistribute it and/or modify
11			* it under the terms of the GNU Affero General Public License as
12			* published by the Free Software Foundation, either version 3 of the
13			* License, or (at your option) any later version.
14			*
15			* This program is distributed in the hope that it will be useful,
16			* but WITHOUT ANY WARRANTY; without even the implied warranty of
17			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18			* GNU Affero General Public License for more details.
19			*
20			* You should have received a copy of the GNU Affero General Public License
21			* along with this program. If not, see <http://www.gnu.org/licenses/>.
22			*
23			*/
24
25			namespace OCA\Deck\Controller;
26
27			use OCA\Deck\StatusException;
28			use OCP\AppFramework\ApiController;
29			use OCP\AppFramework\Http;
30			use OCP\AppFramework\Http\DataResponse;
31			use OCP\IRequest;
32
33			use OCA\Deck\Service\BoardService;
34			use Sabre\HTTP\Util;
35
36			/**
37			* Class BoardApiController
38			*
39			* @package OCA\Deck\Controller
40			*/
41			class BoardApiController extends ApiController {
42
43			private $boardService;
44
45			/**
46			* @param string $appName
47			* @param IRequest $request
48			* @param BoardService $service
49			* @param $userId
50			*/
51			public function __construct($appName, IRequest $request, BoardService $service, $userId) {
52			parent::__construct($appName, $request);
53			$this->boardService = $service;
54			$this->userId = $userId;
			0 ignored issues – show Bug introduced 2018-02-12 15:33 UTC by Report Bug Copy Issue Report The property `userId` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
55			}
56
57			/**
58			* @NoAdminRequired
59			* @CORS
60			* @NoCSRFRequired
61			*
62			* Return all of the boards that the current user has access to.
63			* @throws StatusException
64			*/
65			public function index($details = null) {
66			$modified = $this->request->getHeader('If-Modified-Since');
67			if ($modified === null \|\| $modified === '') {
68			$boards = $this->boardService->findAll(0, $details);
69			} else {
70			$date = Util::parseHTTPDate($modified);
71			if (!$date) {
72			throw new StatusException('Invalid If-Modified-Since header provided.');
73			}
74			$boards = $this->boardService->findAll($date->getTimestamp(), $details);
75			}
76			return new DataResponse($boards, HTTP::STATUS_OK);
77			}
78
79			/**
80			* @NoAdminRequired
81			* @CORS
82			* @NoCSRFRequired
83			*
84			*
85			* Return the board specified by $this->request->getParam('boardId').
86			*/
87			public function get() {
88			$board = $this->boardService->find($this->request->getParam('boardId'));
89			return new DataResponse($board, HTTP::STATUS_OK);
90			}
91
92			/**
93			* @NoAdminRequired
94			* @CORS
95			* @NoCSRFRequired
96			*
97			* @params $title
98			* @params $color
99			*
100			* Create a board with the specified title and color.
101			*/
102			public function create($title, $color) {
103			$board = $this->boardService->create($title, $this->userId, $color);
104			return new DataResponse($board, HTTP::STATUS_OK);
105			}
106
107			/**
108			* @NoAdminRequired
109			* @CORS
110			* @NoCSRFRequired
111			*
112			* @params $title
113			* @params $color
114			* @params $archived
115			*
116			* Update a board with the specified boardId, title and color, and archived state.
117			*/
118			public function update($title, $color, $archived = false) {
119			$board = $this->boardService->update($this->request->getParam('boardId'), $title, $color, $archived);
120			return new DataResponse($board, HTTP::STATUS_OK);
121			}
122
123			/**
124			* @NoAdminRequired
125			* @CORS
126			* @NoCSRFRequired
127			*
128			*
129			* Delete the board specified by $boardId. Return the board that was deleted.
130			*/
131			public function delete() {
132			$board = $this->boardService->delete($this->request->getParam('boardId'));
133			return new DataResponse($board, HTTP::STATUS_OK);
134			}
135
136			/**
137			* @NoAdminRequired
138			* @CORS
139			* @NoCSRFRequired
140			*
141			*
142			* Undo the deletion of the board specified by $boardId.
143			*/
144			public function undoDelete() {
145			$board = $this->boardService->deleteUndo($this->request->getParam('boardId'));
146			return new DataResponse($board, HTTP::STATUS_OK);
147			}
148
149			/**
150			* @NoAdminRequired
151			* @CORS
152			* @NoCSRFRequired
153			*/
154			public function addAcl($boardId, $type, $participant, $permissionEdit, $permissionShare, $permissionManage) {
155			$acl = $this->boardService->addAcl($boardId, $type, $participant, $permissionEdit, $permissionShare, $permissionManage);
156			return new DataResponse($acl, HTTP::STATUS_OK);
157			}
158
159			/**
160			* @NoAdminRequired
161			* @CORS
162			* @NoCSRFRequired
163			*/
164			public function updateAcl($aclId, $permissionEdit, $permissionShare, $permissionManage) {
165			$acl = $this->boardService->updateAcl($aclId, $permissionEdit, $permissionShare, $permissionManage);
166			return new DataResponse($acl, HTTP::STATUS_OK);
167			}
168
169			/**
170			* @NoAdminRequired
171			* @CORS
172			* @NoCSRFRequired
173			*/
174			public function deleteAcl($aclId) {
175			$acl = $this->boardService->deleteAcl($aclId);
176			return new DataResponse($acl, HTTP::STATUS_OK);
177			}
178
179			}
180

nextcloud / deck

BoardApiController::__construct() A last analyzed 2020-03-02 02:31 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

BoardApiController::__construct() A
last analyzed 2020-03-02 02:31 UTC