extern/2FAuth
1
0
Fork 0
mirror of https://github.com/Bubka/2FAuth.git synced 2025-04-29 20:04:41 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update services doc block

Browse Source
This commit is contained in:
Bubka 2021-11-30 17:37:57 +01:00
parent 4ee3557cc1
commit 054b8a2c21
2 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
app/Services/GroupService.php
View File

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

14
app/Services/TwoFAccountService.php
View File

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