From e44dac13914632a8d35c164d78d1326f126ab987 Mon Sep 17 00:00:00 2001 From: iamsyh Date: Fri, 4 Nov 2022 01:45:09 +0500 Subject: [PATCH 1/5] 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! --- src/Config/AuthGroups.php | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/src/Config/AuthGroups.php b/src/Config/AuthGroups.php index 95309f1b0..d0c3b9a65 100644 --- a/src/Config/AuthGroups.php +++ b/src/Config/AuthGroups.php @@ -20,10 +20,12 @@ class AuthGroups extends BaseConfig * -------------------------------------------------------------------- * Groups * -------------------------------------------------------------------- - * The available authentication systems, listed - * with alias and class name. These can be referenced - * by alias in the auth helper: - * auth('api')->attempt($credentials); + * The available groups in the system. + * Where the key is the group name, and the values are an + * array of any additional fields you would like for that group. + * Whatever value you assign as the key, will be used to refer to the group when using functions such as: + * $user->addGroup('superadmin') + * ref: https://github.com/codeigniter4/shield/blob/develop/docs/quickstart.md#change-available-groups for more info */ public array $groups = [ 'superadmin' => [ From f112e1dd6c52e1222a0b7925aa9c924edde2b6cc Mon Sep 17 00:00:00 2001 From: iamsyh Date: Fri, 4 Nov 2022 17:27:46 +0500 Subject: [PATCH 2/5] Update src/Config/AuthGroups.php Co-authored-by: kenjis --- src/Config/AuthGroups.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Config/AuthGroups.php b/src/Config/AuthGroups.php index d0c3b9a65..38317697b 100644 --- a/src/Config/AuthGroups.php +++ b/src/Config/AuthGroups.php @@ -22,7 +22,7 @@ class AuthGroups extends BaseConfig * -------------------------------------------------------------------- * The available groups in the system. * Where the key is the group name, and the values are an - * array of any additional fields you would like for that group. + * array of the group info. * Whatever value you assign as the key, will be used to refer to the group when using functions such as: * $user->addGroup('superadmin') * ref: https://github.com/codeigniter4/shield/blob/develop/docs/quickstart.md#change-available-groups for more info From 0216f6f92db9872337ae3894fe5b060d229f1839 Mon Sep 17 00:00:00 2001 From: iamsyh Date: Wed, 16 Nov 2022 05:28:54 +0500 Subject: [PATCH 3/5] Update src/Config/AuthGroups.php Co-authored-by: John Paul E. Balandan, CPA --- src/Config/AuthGroups.php | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/src/Config/AuthGroups.php b/src/Config/AuthGroups.php index 38317697b..30aea179e 100644 --- a/src/Config/AuthGroups.php +++ b/src/Config/AuthGroups.php @@ -20,12 +20,14 @@ class AuthGroups extends BaseConfig * -------------------------------------------------------------------- * Groups * -------------------------------------------------------------------- - * The available groups in the system. - * Where the key is the group name, and the values are an - * array of the group info. - * Whatever value you assign as the key, will be used to refer to the group when using functions such as: - * $user->addGroup('superadmin') - * ref: https://github.com/codeigniter4/shield/blob/develop/docs/quickstart.md#change-available-groups for more info + * An associative array of the available groups in the system, where the keys are + * the group names and the values are arrays of the group info. + * + * Whatever value you assign as the key will be used to refer to the group when using functions such as: + * $user->addGroup('superadmin'); + * + * @var array> + * @see https://github.com/codeigniter4/shield/blob/develop/docs/quickstart.md#change-available-groups for more info */ public array $groups = [ 'superadmin' => [ From 4475332ef02b0cad8719d485a0fc1a00202f0ff3 Mon Sep 17 00:00:00 2001 From: iamsyh Date: Wed, 16 Nov 2022 05:55:59 +0500 Subject: [PATCH 4/5] Update AuthGroups.php --- src/Config/AuthGroups.php | 1 + 1 file changed, 1 insertion(+) diff --git a/src/Config/AuthGroups.php b/src/Config/AuthGroups.php index 30aea179e..529fa1968 100644 --- a/src/Config/AuthGroups.php +++ b/src/Config/AuthGroups.php @@ -26,6 +26,7 @@ class AuthGroups extends BaseConfig * Whatever value you assign as the key will be used to refer to the group when using functions such as: * $user->addGroup('superadmin'); * + * * @var array> * @see https://github.com/codeigniter4/shield/blob/develop/docs/quickstart.md#change-available-groups for more info */ From fb4f33d459d00d0c9780c20091b2d845023085a0 Mon Sep 17 00:00:00 2001 From: "John Paul E. Balandan, CPA" Date: Fri, 18 Nov 2022 09:45:06 +0800 Subject: [PATCH 5/5] Update src/Config/AuthGroups.php --- src/Config/AuthGroups.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Config/AuthGroups.php b/src/Config/AuthGroups.php index 529fa1968..1fef9e312 100644 --- a/src/Config/AuthGroups.php +++ b/src/Config/AuthGroups.php @@ -26,8 +26,8 @@ class AuthGroups extends BaseConfig * Whatever value you assign as the key will be used to refer to the group when using functions such as: * $user->addGroup('superadmin'); * - * * @var array> + * * @see https://github.com/codeigniter4/shield/blob/develop/docs/quickstart.md#change-available-groups for more info */ public array $groups = [