ahtlon/deck
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Update the documentation.

Browse Source 
Signed-off-by: Julius Härtl <jus@bitgrid.net>
This commit is contained in:
Steven R. Baker
2017-07-29 16:54:30 +02:00
committed by Julius Härtl
parent b4224dadfb
commit 975b6f3572
1 changed files with 17 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
lib/Controller/BoardApiController.php
View File

@@ -44,7 +44,10 @@ class BoardApiController extends ApiController {
/** /**
* @param string $appName * @param string $appName
* @param IRequest $request * @param IRequest $request
* @param IUserManager $userManager
* @param IGroupManager $groupManager
* @param BoardService $service * @param BoardService $service
* @param $userId
*/ */
public function __construct($appName, IRequest $request, IUserManager $userManager, IGroupManager $groupManager, BoardService $service, $userId) { public function __construct($appName, IRequest $request, IUserManager $userManager, IGroupManager $groupManager, BoardService $service, $userId) {
parent::__construct($appName, $request); parent::__construct($appName, $request);
@@ -58,6 +61,8 @@ class BoardApiController extends ApiController {
* @NoAdminRequired * @NoAdminRequired
* @CORS * @CORS
* @NoCSRFRequired * @NoCSRFRequired
*
* Return all of the boards that the current user has access to.
*/ */
public function index() { public function index() {
$boards = $this->service->findAll($this->getUserInfo()); $boards = $this->service->findAll($this->getUserInfo());
@@ -69,6 +74,10 @@ class BoardApiController extends ApiController {
* @NoAdminRequired * @NoAdminRequired
* @CORS * @CORS
* @NoCSRFRequired * @NoCSRFRequired
*
* @params $id
*
* Return the board specified by $id.
*/ */
public function get($id) { public function get($id) {
$board = $this->service->find($id); $board = $this->service->find($id);
@@ -82,6 +91,10 @@ class BoardApiController extends ApiController {
* @NoAdminRequired * @NoAdminRequired
* @CORS * @CORS
* @NoCSRFRequired * @NoCSRFRequired
*
* @params $id
*
* Delete the board specified by $id. Return the board that was deleted.
*/ */
public function delete($id) { public function delete($id) {
$board = $this->service->delete($id); $board = $this->service->delete($id);
@@ -93,6 +106,10 @@ class BoardApiController extends ApiController {
* @NoAdminRequired * @NoAdminRequired
* @CORS * @CORS
* @NoCSRFRequired * @NoCSRFRequired
*
* @params $id
*
* Undo the deletion of the board specified by $id.
*/ */
public function undoDelete($id) { public function undoDelete($id) {
$board = $this->service->find($id); $board = $this->service->find($id);