AccessRoleFactory
in package
Class AccessRoleFactory
Table of Contents
- createAccessRole() : AccessRole
- Creates and returns an access role.
- createAccessRoleDescriptions() : AccessRoleDescriptions
- Creates and returns a collection of access role descriptions.
- createAccessRoleId() : AccessRoleId
- Creates and returns an access role ID.
- createAccessRoleIds() : AccessRoleIds
- Creates and returns a collection of access role IDs.
- createAccessRoleNames() : AccessRoleNames
- Creates and returns a collection of access role names.
- createAccessRoles() : AccessRoles
- Creates and returns a collection of access roles.
- createAdminId() : AdminId
- Creates and returns an admin ID.
- createGroupId() : GroupId
- Creates and returns a group ID.
- createPermission() : Permission
- Creates and returns a permission.
- createPermissionAction() : PermissionAction
- Creates and returns a permission action.
- createPermissions() : Permissions
- Creates and returns a collection of permissions.
Methods
createAccessRole()
Creates and returns an access role.
public
createAccessRole(int $id, array<string|int, mixed> $names, array<string|int, mixed> $descriptions, Permissions $permissions, int $sortOrder, bool $isProtected) : AccessRole
Parameters
- $id : int
- $names : array<string|int, mixed>
- $descriptions : array<string|int, mixed>
- $permissions : Permissions
- $sortOrder : int
- $isProtected : bool
Return values
AccessRole —createAccessRoleDescriptions()
Creates and returns a collection of access role descriptions.
public
createAccessRoleDescriptions(array<string|int, mixed> $descriptions) : AccessRoleDescriptions
Parameters
- $descriptions : array<string|int, mixed>
Return values
AccessRoleDescriptions —createAccessRoleId()
Creates and returns an access role ID.
public
createAccessRoleId(int $id) : AccessRoleId
Parameters
- $id : int
Return values
AccessRoleId —createAccessRoleIds()
Creates and returns a collection of access role IDs.
public
createAccessRoleIds(AccessRoleId ...$ids) : AccessRoleIds
Parameters
- $ids : AccessRoleId
Return values
AccessRoleIds —createAccessRoleNames()
Creates and returns a collection of access role names.
public
createAccessRoleNames(array<string|int, mixed> $names) : AccessRoleNames
Parameters
- $names : array<string|int, mixed>
Return values
AccessRoleNames —createAccessRoles()
Creates and returns a collection of access roles.
public
createAccessRoles(AccessRole ...$roles) : AccessRoles
Parameters
- $roles : AccessRole
Return values
AccessRoles —createAdminId()
Creates and returns an admin ID.
public
createAdminId(int $id) : AdminId
Parameters
- $id : int
Return values
AdminId —createGroupId()
Creates and returns a group ID.
public
createGroupId(int $id) : GroupId
Parameters
- $id : int
Return values
GroupId —createPermission()
Creates and returns a permission.
public
createPermission(int $groupId, bool $readingGranted, bool $writingGranted, bool $deletingGranted) : Permission
Parameters
- $groupId : int
- $readingGranted : bool
- $writingGranted : bool
- $deletingGranted : bool
Return values
Permission —createPermissionAction()
Creates and returns a permission action.
public
createPermissionAction(string $action) : PermissionAction
Parameters
- $action : string
Return values
PermissionAction —createPermissions()
Creates and returns a collection of permissions.
public
createPermissions(Permission ...$permissions) : Permissions
Parameters
- $permissions : Permission