File tree Expand file tree Collapse file tree 1 file changed +9
-4
lines changed Expand file tree Collapse file tree 1 file changed +9
-4
lines changed Original file line number Diff line number Diff line change @@ -20,10 +20,15 @@ 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+ * An associative array of the available groups in the system, where the keys are
24+ * the group names and the values are arrays of the group info.
25+ *
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+ *
29+ * @var array<string, array<string, string>>
30+ *
31+ * @see https://github.com/codeigniter4/shield/blob/develop/docs/quickstart.md#change-available-groups for more info
2732 */
2833 public array $ groups = [
2934 'superadmin ' => [
You can’t perform that action at this time.
0 commit comments