Skip to content

Commit 9481cd3

Browse files
dereuromarkdereuromark
committed
Fix up docs.
1 parent ca45891 commit 9481cd3

File tree

2 files changed

+29
-29
lines changed

2 files changed

+29
-29
lines changed

‎docs/Authentication.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -257,9 +257,9 @@ The helper also supports named routes:
257257

258258
TinyAuth Authentication component supports the following configuration options.
259259

260-
Option | Type | Description
261-
:---------------|:-------|:---------------------------------------------------------------------------------------------------
262-
autoClearCache | bool | True will generate a new ACL cache file every time.
263-
allowFilePath | string | Full path to the INI file. Can also be an array of paths. Defaults to `ROOT . DS . 'config' . DS`.
264-
allowFile | string | Name of the INI file. Defaults to `auth_allow.ini`.
265-
allowAdapter | string | Class name, defaults to `IniAllowAdapter::class`.
260+
| Option | Type | Description |
261+
|:---------------|:-------|:--------------------------------------------------------------------------------------------------------|
262+
| autoClearCache | bool | True will generate a new ACL cache file every time. |
263+
| allowFilePath | string | Full path to the INI file. Can also be an array of paths. <br/>Defaults to `ROOT . DS . 'config' . DS`. |
264+
| allowFile | string | Name of the INI file. Defaults to `auth_allow.ini`. |
265+
| allowAdapter | string | Class name, defaults to `IniAllowAdapter::class`. |

‎docs/Authorization.md‎

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -297,29 +297,29 @@ $this->loadComponent('TinyAuth.Authorization', [
297297

298298
TinyAuthorize adapter supports the following configuration options.
299299

300-
Option | Type | Description
301-
:----------------------|:--------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------
302-
roleColumn | string | Name of column in user table holding role id (used for foreign key in users table in a single role per user setup, or in the pivot table on multi-roles setup)
303-
userColumn | string | Name of column in pivot table holding role id (only used in pivot table on multi-roles setup)
304-
aliasColumn | string | Name of the column for the alias in the role table
305-
idColumn | string | Name of the ID Column in users table
306-
rolesTable | string | Name of Configure key holding all available roles OR class name of roles database table
307-
usersTable | string | Class name of the users table.
308-
pivotTable | string | Name of the pivot table, for a multi-group setup.
309-
rolesTablePlugin | string | Name of the plugin for the roles table, if any.
310-
pivotTablePlugin | string | Name of the plugin for the pivot table, if any.
311-
multiRole | bool | True will enable multi-role/HABTM authorization (requires a valid join table).
312-
superAdminRole | int | Id of the super admin role. Users with this role will have access to ALL resources.
313-
superAdmin | int or string | Id/name of the super admin. Users with this id/name will have access to ALL resources. null/0/'0' disable it.
314-
superAdminColumn | string | Column of super admin in user table. Default is idColumn option.
315-
authorizeByPrefix | bool/array | If prefixed routes should be auto-handled by their matching role name or a prefix=>role map.
316-
allowLoggedIn | bool | True will give authenticated users access to all resources except those using the `protectedPrefix`.
317-
protectedPrefix | string/array | Name of the prefix(es) used for admin pages. Defaults to `Admin`.
318-
autoClearCache | bool | True will generate a new ACL cache file every time.
319-
aclFilePath | string | Full path to the auth_acl.ini. Can also be an array of multiple paths. Defaults to `ROOT . DS . 'config' . DS`.
320-
aclFile | string | Name of the INI file. Defaults to `auth_acl.ini`.
321-
aclAdapter | string | Class name, defaults to `IniAclAdapter::class`.
322-
includeAuthentication | bool | Set to true to include public auth access into hasAccess() checks. Note, that this requires Configure configuration.
300+
| Option | Type | Description |
301+
|:----------------------|:--------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------|
302+
| roleColumn | string | Name of column in user table holding role id (used for foreign key in users table in a single role per user setup, or in the pivot table on multi-roles setup) |
303+
| userColumn | string | Name of column in pivot table holding role id (only used in pivot table on multi-roles setup) |
304+
| aliasColumn | string | Name of the column for the alias in the role table |
305+
| idColumn | string | Name of the ID Column in users table |
306+
| rolesTable | string | Name of Configure key holding all available roles OR class name of roles database table |
307+
| usersTable | string | Class name of the users table. |
308+
| pivotTable | string | Name of the pivot table, for a multi-group setup. |
309+
| rolesTablePlugin | string | Name of the plugin for the roles table, if any. |
310+
| pivotTablePlugin | string | Name of the plugin for the pivot table, if any. |
311+
| multiRole | bool | True will enable multi-role/HABTM authorization (requires a valid join table). |
312+
| superAdminRole | int | Id of the super admin role. Users with this role will have access to ALL resources. |
313+
| superAdmin | int or string | Id/name of the super admin. Users with this id/name will have access to ALL resources. null/0/'0' disable it. |
314+
| superAdminColumn | string | Column of super admin in user table. Default is idColumn option. |
315+
| authorizeByPrefix | bool/array | If prefixed routes should be auto-handled by their matching role name or a prefix=>role map. |
316+
| allowLoggedIn | bool | True will give authenticated users access to all resources except those using the `protectedPrefix`. |
317+
| protectedPrefix | string/array | Name of the prefix(es) used for admin pages. Defaults to `Admin`. |
318+
| autoClearCache | bool | True will generate a new ACL cache file every time. |
319+
| aclFilePath | string | Full path to the auth_acl.ini. Can also be an array of multiple paths. Defaults to `ROOT . DS . 'config' . DS`. |
320+
| aclFile | string | Name of the INI file. Defaults to `auth_acl.ini`. |
321+
| aclAdapter | string | Class name, defaults to `IniAclAdapter::class`. |
322+
| includeAuthentication | bool | Set to true to include public auth access into hasAccess() checks. Note, that this requires Configure configuration. |
323323

324324
## AuthUser Component
325325
Add the AuthUserComponent and you can easily check permissions inside your controller scope:

0 commit comments

Comments
 (0)