wonnova-development / woost-gamification-php-sdk

src/Connection/Client.php

Doc Comments +38 added lines, -38 removed lines

@@ -228,8 +228,8 @@ 
      * Fetches a route and maps a resource list of models under provided key
      *
      * @param Route|string $route
-     * @param $resourceKey
-     * @param $resourceClass
+     * @param string $resourceKey
+     * @param string $resourceClass
      * @return ArrayCollection
      */
     protected function getResourceCollection($route, $resourceKey, $resourceClass)
@@ -246,7 +246,7 @@ 
     /**
      * Returns users list
      *
-     * @return Collection|User[]
+     * @return ArrayCollection
      */
     public function getUsers()
     {
@@ -315,8 +315,8 @@ 
     /**
      *
      *
-     * @param User|string $user A User model or userId
-     * @return Collection|Notification[]
+     * @param string $user A User model or userId
+     * @return ArrayCollection
      */
     public function getUserNotifications($user)
     {
@@ -329,8 +329,8 @@ 
     /**
      * Returns the list of badges that certain user has won
      *
-     * @param User|string $user A User model or userId
-     * @return Collection|Badge[]
+     * @param string $user A User model or userId
+     * @return ArrayCollection
      */
     public function getUserBadges($user)
     {
@@ -343,10 +343,10 @@ 
     /**
      * Returns the number of achievements of each type for certain user
      *
-     * @param User|string $user A User model or userId
+     * @param string $user A User model or userId
      * @param array|string $types List of types in a comma-separated string or array.
      *          All the types will be returned by default
-     * @return Collection|Achievement[]
+     * @return ArrayCollection
      */
     public function getUserAchievements($user, $types = [])
     {
@@ -364,9 +364,9 @@ 
     /**
      * Returns the list of steps in a quest telling if certain user has already completed them
      *
-     * @param User|string $user A User model or userId
+     * @param string $user A User model or userId
      * @param string $questCode
-     * @return Collection|QuestStep[]
+     * @return ArrayCollection
      */
     public function getUserProgressInQuest($user, $questCode)
     {
@@ -380,7 +380,7 @@ 
     /**
      * Returns the list of created quests
      *
-     * @return Collection|Quest[]
+     * @return ArrayCollection
      */
     public function getQuests()
     {
@@ -390,8 +390,8 @@ 
     /**
      * Returns all the quests with which a user is involved with, including the list of their steps
      *
-     * @param User|string $user A User model or userId
-     * @return Collection|Quest[]
+     * @param string $user A User model or userId
+     * @return ArrayCollection
      */
     public function getUserStatusInQuests($user)
     {
@@ -402,7 +402,7 @@ 
     }
 
     /**
-     * @return Collection|Level[]
+     * @return ArrayCollection
      */
     public function getLevels()
     {
@@ -412,7 +412,7 @@ 
     /**
      * Returns the level of a user in certain scenario
      *
-     * @param User|string $user A User model or userId
+     * @param string $user A User model or userId
      * @param string|null $scenarioCode
      * @return Level
      */
@@ -441,8 +441,8 @@ 
      * If a user is provided, the list will include the team of that user, even if it is not in the top list
      *
      * @param int|null $maxCount Maximum number of results
-     * @param User|string|null $user A User model or userId
-     * @return Collection|Team[]
+     * @param string $user A User model or userId
+     * @return ArrayCollection
      */
     public function getTeamsLeaderboard($maxCount = null, $user = null)
     {
@@ -468,7 +468,7 @@ 
      * Returns the top rated items
      *
      * @param int $maxCount
-     * @return Collection|Item[]
+     * @return ArrayCollection
      */
     public function getItemsLeaderboard($maxCount = 6)
     {
@@ -480,8 +480,8 @@ 
     /**
      * Rates an item increasing its score and setting the rate from certain user.
      *
-     * @param User|string $user a User model or userId
-     * @param Item|string $item an Item model or itemId
+     * @param string $user a User model or userId
+     * @param string $item an Item model or itemId
      * @param int $score
      * @return Item
      */
@@ -513,8 +513,8 @@ 
     /**
      * Rates an item increasing its score and setting the rate from certain user.
      *
-     * @param User|string $user a User model or userId
-     * @param array $items an array of Item models
+     * @param string $user a User model or userId
+     * @param Item[] $items an array of Item models
      * @return ArrayCollection
      */
     public function rateSeveralItems($user, array $items)
@@ -545,7 +545,7 @@ 
     /**
      * Deletes certain item
      *
-     * @param Item|string $item an Item model or itemId
+     * @param string $item an Item model or itemId
      * @return void
      */
     public function deleteItem($item)
@@ -559,7 +559,7 @@ 
     /**
      * Resets an item's score to zero
      *
-     * @param Item|string $item an Item model or itemId
+     * @param string $item an Item model or itemId
      * @return void
      */
     public function resetItemScore($item)
@@ -575,7 +575,7 @@ 
      * By calling this method, only the properties username, fullName, avatar and score of the User will be popullated,
      * as well as the provided userId
      *
-     * @param $userId
+     * @param string $userId
      * @return User
      */
     public function getUserData($userId)
@@ -596,10 +596,10 @@ 
     /**
      * Performs an action notification from certain user
      *
-     * @param User|string $user A User model or userId
+     * @param string $user A User model or userId
      * @param string $actionCode
      * @param Item|string $item An Item model or itemId
-     * @param array $categories
+     * @param string[] $categories
      * @return void
      */
     public function notifyAction($user, $actionCode, $item = null, array $categories = [])
@@ -627,7 +627,7 @@ 
     /**
      * Performs an action notification from certain user
      *
-     * @param User|string $user A User model or userId
+     * @param string $user A User model or userId
      * @param array $actions array of Action objects or strings
      * @return void
      */
@@ -661,11 +661,11 @@ 
     /**
      * Performs an interaction notification between two users
      *
-     * @param User|string $user A User model or userId
-     * @param User|string $targetUser A User model or userId
+     * @param string $user A User model or userId
+     * @param string $targetUser A User model or userId
      * @param string $interactionCode
      * @param Item|null $item An Item model or itemId
-     * @param array $categories
+     * @param string[] $categories
      * @return void
      */
     public function notifyInteraction($user, $targetUser, $interactionCode, $item = null, array $categories = [])
@@ -694,7 +694,7 @@ 
     /**
      * Returns the number of times a user has performed certain action
      *
-     * @param User|string $user A User model or userId
+     * @param string $user A User model or userId
      * @param string $actionCode
      * @return int
      */
@@ -711,10 +711,10 @@ 
     /**
      * Returns information about the status of an interactionaccording to its limits
      *
-     * @param User|string $user A User model or userId
-     * @param User|string $targetUser A User model or userId
+     * @param string $user A User model or userId
+     * @param string $targetUser A User model or userId
      * @param string $interactionCode
-     * @param Item|string $item An Item model or itemId
+     * @param string $item An Item model or itemId
      * @return array
      */
     public function getInteractionStatus($user, $targetUser, $interactionCode, $item)
@@ -749,9 +749,9 @@ 
     /**
      * Returns the list of most recent updates for certain user
      *
-     * @param User|string $user A User model or userId
+     * @param string $user A User model or userId
      * @param int $maxCount
-     * @return Collection|Update[]
+     * @return ArrayCollection
      */
     public function getUserLastUpdates($user, $maxCount = null)
     {

src/Model/Quest.php

Doc Comments +2 added lines, -2 removed lines

@@ -89,7 +89,7 @@ 
     }
 
     /**
-     * @return mixed
+     * @return boolean
      */
     public function getGeneratesNotification()
     {
@@ -97,7 +97,7 @@ 
     }
 
     /**
-     * @param mixed $generatesNotification
+     * @param boolean $generatesNotification
      * @return $this
      */
     public function setGeneratesNotification($generatesNotification)