Selaa lähdekoodia

Update services doc block

Bubka 3 vuotta sitten
vanhempi
commit
054b8a2c21
2 muutettua tiedostoa jossa 13 lisäystä ja 13 poistoa
  1. 6 6
      app/Services/GroupService.php
  2. 7 7
      app/Services/TwoFAccountService.php

+ 6 - 6
app/Services/GroupService.php

@@ -59,7 +59,7 @@ class GroupService
      * Creates a group
      * 
      * @param array $data
-     * @return Group The created group
+     * @return \App\Group The created group
      */
     public function create(array $data) : Group
     {
@@ -78,9 +78,9 @@ class GroupService
     /**
      * Updates a group using a list of parameters
      * 
-     * @param Group $group The group
+     * @param \App\Group $group The group
      * @param array $data The parameters
-     * @return Group The updated group
+     * @return \App\Group The updated group
      */
     public function update(Group $group, array $data) : Group
     {
@@ -133,7 +133,7 @@ class GroupService
      * Assign one or more accounts to a group
      * 
      * @param array|int $ids accounts ids to assign
-     * @param Group $group The target group
+     * @param \App\Group $group The target group
      * @return void
      */
     public function assign($ids, Group $group = null) : void
@@ -162,7 +162,7 @@ class GroupService
     /**
      * Finds twofaccounts assigned to the group
      * 
-     * @param Group $group The group
+     * @param \App\Group $group The group
      * @return Collection The assigned accounts
      */
     public function getAccounts(Group $group) : Collection
@@ -176,7 +176,7 @@ class GroupService
     /**
      * Determines the destination group
      * 
-     * @return Group|null The group or null if it does not exist
+     * @return \App\Group|null The group or null if it does not exist
      */
     private function defaultGroup()
     {

+ 7 - 7
app/Services/TwoFAccountService.php

@@ -48,7 +48,7 @@ class TwoFAccountService
      * @param string $uri
      * @param bool $saveToDB Whether or not the created account should be saved to DB
      * 
-     * @return TwoFAccount The created account
+     * @return \App\TwoFAccount The created account
      */
     public function createFromUri(string $uri, bool $saveToDB = true ) : TwoFAccount
     {
@@ -76,7 +76,7 @@ class TwoFAccountService
      * @param array $data
      * @param bool $saveToDB Whether or not the created account should be saved to DB
      * 
-     * @return TwoFAccount The created account
+     * @return \App\TwoFAccount The created account
      */
     public function createFromParameters(array $data, bool $saveToDB = true) : TwoFAccount
     {
@@ -102,10 +102,10 @@ class TwoFAccountService
     /**
      * Updates an account using a list of parameters
      * 
-     * @param TwoFAccount $twofaccount The account
+     * @param \App\TwoFAccount $twofaccount The account
      * @param array $data The parameters
      * 
-     * @return TwoFAccount The updated account
+     * @return \App\TwoFAccount The updated account
      */
     public function update(TwoFAccount $twofaccount, array $data) : TwoFAccount
     {
@@ -125,7 +125,7 @@ class TwoFAccountService
     /**
      * Returns a One-Time Password (with its parameters) for the specified account
      * 
-     * @param TwoFAccount|TwoFAccountDto|int|string $data Data defining an account
+     * @param \App\TwoFAccount|TwoFAccountDto|int|string $data Data defining an account
      * 
      * @return OtpDto an OTP DTO
      * 
@@ -176,7 +176,7 @@ class TwoFAccountService
     /**
      * Returns a generated otpauth URI for the specified account
      * 
-     * @param TwoFAccount|TwoFAccountDto|int $data Data defining an account
+     * @param \App\TwoFAccount|TwoFAccountDto|int $data Data defining an account
      */
     public function getURI($data) : string
     {
@@ -308,7 +308,7 @@ class TwoFAccountService
     /**
      * Instanciates the token with a TwoFAccount
      * 
-     * @param TwoFAccount $twofaccount
+     * @param \App\TwoFAccount $twofaccount
      * 
      * @param bool $usingUri Whether or not the token should be fed with the account uri
      */