API Reference

This page documents the contracts and interfaces that define the public API of the Hypervel Permission system. These contracts specify the required methods and signatures for permission management functionality.

For implementation details, see page 5.1 (Service Providers and Configuration). For configuration options, see page 5.2 (Configuration Reference).

Contract Overview

The system defines three contracts:

Contract	Location	Purpose
Factory	src/Contracts/Factory.php9	Model resolution, cache management, cache key generation
Role	src/Contracts/Role.php12	Role-permission relationship definition
Permission	src/Contracts/Permission.php12	Permission-role relationship definition

Sources: src/Contracts/Factory.php9-34 src/Contracts/Role.php12-18 src/Contracts/Permission.php12-18

Contract Structure

Contract code entity relationships:

Sources: src/Contracts/Factory.php9-34 src/Contracts/Role.php12-18 src/Contracts/Permission.php12-18

Factory Contract

The Factory contract src/Contracts/Factory.php9 defines 12 methods organized into five functional categories:

Method Categories

Factory method organization by responsibility:

Sources: src/Contracts/Factory.php11-33

Complete Method Signatures

Line	Method Signature	Return Type
11	getRoleClass()	mixed
13	getPermissionClass()	mixed
15	getCache()	?Repository
17	getOwnerRolesCacheKey(string $ownerType, int|string $ownerId)	string
19	getOwnerPermissionsCacheKey(string $ownerType, int|string $ownerId)	string
21	getAllRolesWithPermissions()	array
23	cacheOwnerRoles(string $ownerType, int|string $ownerId, array $roles)	void
25	cacheOwnerPermissions(string $ownerType, int|string $ownerId, array $permissions)	void
27	getOwnerCachedRoles(string $ownerType, int|string $ownerId)	?array
29	getOwnerCachedPermissions(string $ownerType, int|string $ownerId)	?array
31	clearAllRolesPermissionsCache()	void
33	clearOwnerCache(string $ownerType, int|string $ownerId)	void

Sources: src/Contracts/Factory.php11-33

Model Contracts

Role Contract

The Role contract src/Contracts/Role.php12 defines the relationship method for role models:

Line	Method	Return Type	Purpose
17	permissions()	BelongsToMany	Many-to-many relationship with permissions

The contract includes @mixin \Hypervel\Permission\Models\Role src/Contracts/Role.php10 for IDE support.

Sources: src/Contracts/Role.php10-17

Permission Contract

The Permission contract src/Contracts/Permission.php12 defines the relationship method for permission models:

Line	Method	Return Type	Purpose
17	roles()	BelongsToMany	Many-to-many relationship with roles

The contract includes @mixin \Hypervel\Permission\Models\Permission src/Contracts/Permission.php10 for IDE support.

Sources: src/Contracts/Permission.php10-17

Parameter Details

Factory Method Parameters

Parameter specifications for methods with arguments:

Method	Parameter	Type	Description
getOwnerRolesCacheKey	$ownerType	string	Fully qualified class name of owner model
$ownerId	int|string	Primary key of owner instance
getOwnerPermissionsCacheKey	$ownerType	string	Fully qualified class name of owner model
$ownerId	int|string	Primary key of owner instance
cacheOwnerRoles	$ownerType	string	Fully qualified class name of owner model
$ownerId	int|string	Primary key of owner instance
$roles	array	Array of role data to cache
cacheOwnerPermissions	$ownerType	string	Fully qualified class name of owner model
$ownerId	int|string	Primary key of owner instance
$permissions	array	Array of permission data to cache
getOwnerCachedRoles	$ownerType	string	Fully qualified class name of owner model
$ownerId	int|string	Primary key of owner instance
getOwnerCachedPermissions	$ownerType	string	Fully qualified class name of owner model
$ownerId	int|string	Primary key of owner instance
clearOwnerCache	$ownerType	string	Fully qualified class name of owner model
$ownerId	int|string	Primary key of owner instance

Sources: src/Contracts/Factory.php17-33

Contract Usage Flow

Factory contract method call sequence:

Sources: src/Contracts/Factory.php17-33

Method Signatures and Parameters

Factory Interface Method Reference

Method Signature	Parameters	Return Type	Line Reference
getRoleClass()	None	mixed	src/Contracts/Factory.php11
getPermissionClass()	None	mixed	src/Contracts/Factory.php13
getCache()	None	?Repository	src/Contracts/Factory.php15
getOwnerRolesCacheKey(string $ownerType, int|string $ownerId)	$ownerType, $ownerId	string	src/Contracts/Factory.php17
getOwnerPermissionsCacheKey(string $ownerType, int|string $ownerId)	$ownerType, $ownerId	string	src/Contracts/Factory.php19
getAllRolesWithPermissions()	None	array	src/Contracts/Factory.php21
cacheOwnerRoles(string $ownerType, int|string $ownerId, array $roles)	$ownerType, $ownerId, $roles	void	src/Contracts/Factory.php23
cacheOwnerPermissions(string $ownerType, int|string $ownerId, array $permissions)	$ownerType, $ownerId, $permissions	void	src/Contracts/Factory.php25
getOwnerCachedRoles(string $ownerType, int|string $ownerId)	$ownerType, $ownerId	?array	src/Contracts/Factory.php27
getOwnerCachedPermissions(string $ownerType, int|string $ownerId)	$ownerType, $ownerId	?array	src/Contracts/Factory.php29
clearAllRolesPermissionsCache()	None	void	src/Contracts/Factory.php31
clearOwnerCache(string $ownerType, int|string $ownerId)	$ownerType, $ownerId	void	src/Contracts/Factory.php33

Model Interface Method Reference

Interface	Method Signature	Return Type	Relationship	Line Reference
Role	permissions()	BelongsToMany	Many-to-many with permissions	src/Contracts/Role.php17
Permission	roles()	BelongsToMany	Many-to-many with roles	src/Contracts/Permission.php17

Type Annotations and Mixins

Interface	Mixin Declaration	Purpose
Role	@mixin \Hypervel\Permission\Models\Role	IDE support for concrete model methods
Permission	@mixin \Hypervel\Permission\Models\Permission	IDE support for concrete model methods

Sources: src/Contracts/Factory.php11-33 src/Contracts/Role.php10-17 src/Contracts/Permission.php10-17

Factory Method Implementation Flow

Cache Operation Sequence

Factory Method Categorization by Responsibility

Sources: src/Contracts/Factory.php11-33

Contract Usage Patterns

Resource Access Pattern

Cache Management Pattern

Cache Invalidation Pattern

Sources: src/Contracts/Factory.php11-33