Skip to content

Commit e44dac1

Browse files
authored
Update comments for groups in AuthGroups.php
The current comment content does not match what the code is doing. Please feel free to clean up or let me know any suggestions. Thank you!
1 parent 9d0b0c9 commit e44dac1

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

src/Config/AuthGroups.php

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,12 @@ class AuthGroups extends BaseConfig
2020
* --------------------------------------------------------------------
2121
* Groups
2222
* --------------------------------------------------------------------
23-
* The available authentication systems, listed
24-
* with alias and class name. These can be referenced
25-
* by alias in the auth helper:
26-
* auth('api')->attempt($credentials);
23+
* The available groups in the system.
24+
* Where the key is the group name, and the values are an
25+
* array of any additional fields you would like for that group.
26+
* Whatever value you assign as the key, will be used to refer to the group when using functions such as:
27+
* $user->addGroup('superadmin')
28+
* ref: https://github.com/codeigniter4/shield/blob/develop/docs/quickstart.md#change-available-groups for more info
2729
*/
2830
public array $groups = [
2931
'superadmin' => [

0 commit comments

Comments
 (0)