PHPdoc and small fixes

2016-10-28 00:45:03 +02:00
parent 1faa3481f8
commit 9bbe4b9137
19 changed files with 261 additions and 189 deletions
--- a/lib/Controller/BoardController.php
+++ b/lib/Controller/BoardController.php
@@ -49,10 +49,10 @@ class BoardController extends Controller {
        $this->userManager = $userManager;
        $this->groupManager = $groupManager;
        $this->boardService = $cardService;
-        $this->userInfo = $this->getBoardPrequisites();
+        $this->userInfo = $this->getBoardPrerequisites();
    }

-    private function getBoardPrequisites() {
+    private function getBoardPrerequisites() {
        $groups = $this->groupManager->getUserGroupIds($this->userManager->get($this->userId));
        return [
            'user' => $this->userId,
@@ -68,66 +68,93 @@ class BoardController extends Controller {
        return $this->boardService->findAll($this->userInfo);
    }

-    /**
-     * @NoAdminRequired
-     * @RequireReadPermission
-     */
+	/**
+	 * @NoAdminRequired
+	 * @RequireReadPermission
+	 * @param $boardId
+	 * @return \OCP\AppFramework\Db\Entity
+	 */
    public function read($boardId) {
        return $this->boardService->find($this->userId, $boardId);
    }

-    /**
-     * @NoAdminRequired
+	/**
+	 * @NoAdminRequired
 	 * @RequireNoPermission
-     */
+	 * @param $title
+	 * @param $color
+	 * @return \OCP\AppFramework\Db\Entity
+	 */
    public function create($title, $color) {
        return $this->boardService->create($title, $this->userId, $color);
    }

-    /**
-     * @NoAdminRequired
-     * @RequireManagePermission
-     */
+	/**
+	 * @NoAdminRequired
+	 * @RequireManagePermission
+	 * @param $id
+	 * @param $title
+	 * @param $color
+	 * @return \OCP\AppFramework\Db\Entity
+	 */
    public function update($id, $title, $color) {
        return $this->boardService->update($id, $title, $this->userId, $color);
    }

-    /**
-     * @NoAdminRequired
-     * @RequireManagePermission
-     */
+	/**
+	 * @NoAdminRequired
+	 * @RequireManagePermission
+	 * @param $boardId
+	 * @return \OCP\AppFramework\Db\Entity
+	 */
    public function delete($boardId) {
        return $this->boardService->delete($this->userId, $boardId);
    }

-    /**
-     * @NoAdminRequired
-     * @RequireReadPermission
-     */
+	/**
+	 * @NoAdminRequired
+	 * @RequireReadPermission
+	 * @param $boardId
+	 * @return
+	 */
    public function labels($boardId) {
        return $this->boardService->labels($boardId);
    }

-    /**
-     * @NoAdminRequired
-     * @RequireManagePermission
-     */
+	/**
+	 * @NoAdminRequired
+	 * @RequireManagePermission
+	 * @param $boardId
+	 * @param $type
+	 * @param $participant
+	 * @param $write
+	 * @param $invite
+	 * @param $manage
+	 * @return \OCP\AppFramework\Db\Entity
+	 */
    public function addAcl($boardId, $type, $participant, $write, $invite, $manage) {
        return $this->boardService->addAcl($boardId, $type, $participant, $write, $invite, $manage);
    }

-    /**
-     * @NoAdminRequired
-     * @RequireManagePermission
-     */
+	/**
+	 * @NoAdminRequired
+	 * @RequireManagePermission
+	 * @param $id
+	 * @param $permissionWrite
+	 * @param $permissionInvite
+	 * @param $permissionManage
+	 * @return \OCP\AppFramework\Db\Entity
+	 */
    public function updateAcl($id, $permissionWrite, $permissionInvite, $permissionManage) {
        return $this->boardService->updateAcl($id, $permissionWrite, $permissionInvite, $permissionManage);
    }
-    
-    /**
-     * @NoAdminRequired
-     * @RequireManagePermission
-     */
+
+	/**
+	 * @NoAdminRequired
+	 * @RequireManagePermission
+	 * @param $aclId
+	 * @return \OCP\AppFramework\Db\Entity
+	 */
    public function deleteAcl($aclId) {
        return $this->boardService->deleteAcl($aclId);
    }
--- a/lib/Controller/CardController.php
+++ b/lib/Controller/CardController.php
@@ -39,74 +39,114 @@ class CardController extends Controller {
        $this->userId = $userId;
        $this->cardService = $cardService;
    }
-    /**
-     * @NoAdminRequired
-     * @RequireReadPermission
-     */
+
+	/**
+	 * @NoAdminRequired
+	 * @RequireReadPermission
+	 * @param $cardId
+	 * @return \OCP\AppFramework\Db\Entity
+	 */
    public function read($cardId) {
        return $this->cardService->find($this->userId, $cardId);
    }
-    /**
-     * @NoAdminRequired
-     * @RequireEditPermission
-     */
+
+	/**
+	 * @NoAdminRequired
+	 * @RequireEditPermission
+	 * @param $cardId
+	 * @param $stackId
+	 * @param $order
+	 * @return array
+	 */
    public function reorder($cardId, $stackId, $order) {
        return $this->cardService->reorder($cardId, $stackId, $order);
    }
-    /**
-     * @NoAdminRequired
-     * @RequireEditPermission
-     */
+
+	/**
+	 * @NoAdminRequired
+	 * @RequireEditPermission
+	 * @param $cardId
+	 * @param $title
+	 * @return \OCP\AppFramework\Db\Entity
+	 */
    public function rename($cardId, $title) {
        return $this->cardService->rename($cardId, $title);
    }
-    /**
-     * @NoAdminRequired
-     * @RequireEditPermission
-     */
+
+	/**
+	 * @NoAdminRequired
+	 * @RequireEditPermission
+	 * @param $title
+	 * @param $stackId
+	 * @param $type
+	 * @param int $order
+	 * @return \OCP\AppFramework\Db\Entity
+	 */
    public function create($title, $stackId, $type, $order=999) {
        return $this->cardService->create($title, $stackId, $type, $order, $this->userId);
    }
-    /**
-     * @NoAdminRequired
-     * @RequireEditPermission
-     */
+
+	/**
+	 * @NoAdminRequired
+	 * @RequireEditPermission
+	 * @param $id
+	 * @param $title
+	 * @param $stackId
+	 * @param $type
+	 * @param $order
+	 * @param $description
+	 * @return \OCP\AppFramework\Db\Entity
+	 */
    public function update($id, $title, $stackId, $type, $order, $description) {
            return $this->cardService->update($id, $title, $stackId, $type, $order, $description, $this->userId);
    }
-    /**
-     * @NoAdminRequired
-     * @RequireEditPermission
-     */
+
+	/**
+	 * @NoAdminRequired
+	 * @RequireEditPermission
+	 * @param $cardId
+	 * @return \OCP\AppFramework\Db\Entity
+	 */
    public function delete($cardId) {
        return $this->cardService->delete($this->userId, $cardId);
    }

-    /**
-     * @NoAdminRequired
-     * @RequireEditPermission
-     */
+	/**
+	 * @NoAdminRequired
+	 * @RequireEditPermission
+	 * @param $cardId
+	 * @return \OCP\AppFramework\Db\Entity
+	 */
    public function archive($cardId) {
        return $this->cardService->archive($cardId);
    }
-    /**
-     * @NoAdminRequired
-     * @RequireEditPermission
-     */
+
+	/**
+	 * @NoAdminRequired
+	 * @RequireEditPermission
+	 * @param $cardId
+	 * @return \OCP\AppFramework\Db\Entity
+	 */
    public function unarchive($cardId) {
        return $this->cardService->unarchive($cardId);
    }
-    /**
-     * @NoAdminRequired
-     * @RequireEditPermission
-     */
+
+	/**
+	 * @NoAdminRequired
+	 * @RequireEditPermission
+	 * @param $cardId
+	 * @param $labelId
+	 */
    public function assignLabel($cardId, $labelId) {
        return $this->cardService->assignLabel($this->userId, $cardId, $labelId);
    }
-    /**
-     * @NoAdminRequired
-     * @RequireEditPermission
-     */
+
+	/**
+	 * @NoAdminRequired
+	 * @RequireEditPermission
+	 * @param $cardId
+	 * @param $labelId
+	 */
    public function removeLabel($cardId, $labelId) {
        return $this->cardService->removeLabel($this->userId, $cardId, $labelId);
    }
--- a/lib/Controller/LabelController.php
+++ b/lib/Controller/LabelController.php
@@ -42,24 +42,36 @@ class LabelController extends Controller {
        $this->labelService = $labelService;
    }

-    /**
-     * @NoAdminRequired
-     * @RequireManagePermission
-     */
+	/**
+	 * @NoAdminRequired
+	 * @RequireManagePermission
+	 * @param $title
+	 * @param $color
+	 * @param $boardId
+	 * @return \OCP\AppFramework\Db\Entity
+	 */
    public function create($title, $color, $boardId) {
        return $this->labelService->create($title, $this->userId, $color, $boardId);
    }
-    /**
-     * @NoAdminRequired
-     * @RequireManagePermission
-     */
+
+	/**
+	 * @NoAdminRequired
+	 * @RequireManagePermission
+	 * @param $id
+	 * @param $title
+	 * @param $color
+	 * @return \OCP\AppFramework\Db\Entity
+	 */
    public function update($id, $title, $color) {
        return $this->labelService->update($id, $title, $this->userId, $color);
    }
-    /**
-     * @NoAdminRequired
-     * @RequireManagePermission
-     */
+
+	/**
+	 * @NoAdminRequired
+	 * @RequireManagePermission
+	 * @param $labelId
+	 * @return \OCP\AppFramework\Db\Entity
+	 */
    public function delete($labelId) {
        return $this->labelService->delete($this->userId, $labelId);
    }
--- a/lib/Controller/ShareController.php
+++ b/lib/Controller/ShareController.php
@@ -47,10 +47,13 @@ class ShareController extends Controller {
        $this->userId = $userId;

    }
-    /**
-     * @NoAdminRequired
+
+	/**
+	 * @NoAdminRequired
 	 * @RequireNoPermission
-     */
+	 * @param $search
+	 * @return array
+	 */
    public function searchUser($search) {
        $limit = 3;
        $offset = null;
--- a/lib/Controller/StackController.php
+++ b/lib/Controller/StackController.php
@@ -41,45 +41,68 @@ class StackController extends Controller {
        $this->userId = $userId;
        $this->stackService = $cardService;
    }
-    /**
-     * @NoAdminRequired
-     * @RequireReadPermission
-     */
+
+	/**
+	 * @NoAdminRequired
+	 * @RequireReadPermission
+	 * @param $boardId
+	 * @return array
+	 */
    public function index($boardId) {
            return $this->stackService->findAll($boardId);
    }
-    /**
-     * @NoAdminRequired
-     * @RequireReadPermission
-     */
+
+	/**
+	 * @NoAdminRequired
+	 * @RequireReadPermission
+	 * @param $boardId
+	 * @return array
+	 */
    public function archived($boardId) {
            return $this->stackService->findAllArchived($boardId);
    }
-    /**
-     * @NoAdminRequired
-     * @RequireReadPermission
-     */
+
+	/**
+	 * @NoAdminRequired
+	 * @RequireReadPermission
+	 * @param $boardId
+	 * @return
+	 */
    public function read($boardId) {
        return $this->stackService->find($this->userId, $boardId);
    }
-    /**
-     * @NoAdminRequired
-     * @RequireManagePermission
-     */
+
+	/**
+	 * @NoAdminRequired
+	 * @RequireManagePermission
+	 * @param $title
+	 * @param $boardId
+	 * @param int $order
+	 * @return \OCP\AppFramework\Db\Entity
+	 */
    public function create($title, $boardId, $order=999) {
        return $this->stackService->create($title, $boardId, $order);
    }
-    /**
-     * @NoAdminRequired
-     * @RequireManagePermission
-     */
+
+	/**
+	 * @NoAdminRequired
+	 * @RequireManagePermission
+	 * @param $id
+	 * @param $title
+	 * @param $boardId
+	 * @param $order
+	 * @return \OCP\AppFramework\Db\Entity
+	 */
    public function update($id, $title, $boardId, $order) {
        return $this->stackService->update($id, $title, $boardId, $order);
    }
-    /**
-     * @NoAdminRequired
-     * @RequireManagePermission
-     */
+
+	/**
+	 * @NoAdminRequired
+	 * @RequireManagePermission
+	 * @param $stackId
+	 * @return \OCP\AppFramework\Db\Entity
+	 */
    public function delete($stackId) {
        return $this->stackService->delete($this->userId, $stackId);
    }