KMP PHP API Reference

ReportsControllerPolicy extends BasePolicy
in package

Controller-level authorization policy for Activities Reports.

Controls access to activity reporting interfaces including authorization reports and warrant rosters. Uses URL-based policy evaluation via BasePolicy.

Tags
see
BasePolicy

For inherited RBAC and URL-based authorization

see

/docs/5.6.5-activity-security-patterns.md For security patterns

Table of Contents

Methods

before()  : bool|null
Check if $user is a super user and can skip auth with an auto True
canActivityWarrantsRoster()  : bool
Check if user can access activity warrant roster reports.
canAdd()  : bool
Check if $user can add RolesPermissions
canAuthorizations()  : bool
Check if user can access activity authorization reports.
canDelete()  : bool
Check if $user can delete RolesPermissions
canEdit()  : bool
Check if $user can edit RolesPermissions
canGridData()  : bool
Check if $user can view role
canIndex()  : bool
Check if $user can view role
canView()  : bool
Check if $user can view RolesPermissions
canViewPrivateNotes()  : bool
Check if $user can view hidden
scopeIndex()  : mixed
Apply scope for index action.
_getBranchIdsForPolicy()  : array<string|int, mixed>|null
Check if $user can view hidden
_getPermissions()  : bool
Check if $user can view hidden
_getPolicies()  : bool
Check if $user can view hidden
_hasPolicy()  : bool
Check if $user can view hidden
_hasPolicyForUrl()  : bool
Check if $user can view hidden
_isSuperUser()  : bool
Check if $user is a super user

Methods

before()

Check if $user is a super user and can skip auth with an auto True

public before(KmpIdentityInterface $user, mixed $resource, string $action) : bool|null
Parameters
$user : KmpIdentityInterface

The user.

$resource : mixed

The resource.

$action : string

The action.

Return values
bool|null

canActivityWarrantsRoster()

Check if user can access activity warrant roster reports.

public canActivityWarrantsRoster(KmpIdentityInterface $user, array<string|int, mixed> $urlProps) : bool
Parameters
$user : KmpIdentityInterface

The requesting user

$urlProps : array<string|int, mixed>

URL properties for authorization context

Return values
bool —

True if user has permission for warrant roster access

canAuthorizations()

Check if user can access activity authorization reports.

public canAuthorizations(KmpIdentityInterface $user, array<string|int, mixed> $urlProps) : bool
Parameters
$user : KmpIdentityInterface

The requesting user

$urlProps : array<string|int, mixed>

URL properties for authorization context

Return values
bool —

True if user has permission for authorization reports

_getBranchIdsForPolicy()

Check if $user can view hidden

protected _getBranchIdsForPolicy(KmpIdentityInterface $user, string $policyMethod) : array<string|int, mixed>|null
Parameters
$user : KmpIdentityInterface

The user.

$policyMethod : string
Return values
array<string|int, mixed>|null

_hasPolicy()

Check if $user can view hidden

protected _hasPolicy(KmpIdentityInterface $user, string $policyMethod, BaseEntity|Table $entity[, int|null $branchId = null ][, mixed $grantSource = null ]) : bool
Parameters
$user : KmpIdentityInterface

The user.

$policyMethod : string
$entity : BaseEntity|Table
$branchId : int|null = null
$grantSource : mixed = null
Return values
bool

_hasPolicyForUrl()

Check if $user can view hidden

protected _hasPolicyForUrl(KmpIdentityInterface $user, string $policyMethod, array<string|int, mixed> $urlProps[, int|null $branchId = null ][, mixed $grantSource = null ]) : bool
Parameters
$user : KmpIdentityInterface

The user.

$policyMethod : string
$urlProps : array<string|int, mixed>
$branchId : int|null = null
$grantSource : mixed = null
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results