KMP PHP API Reference

MembersTablePolicy extends BasePolicy
in package

role policy

Table of Contents

Methods

before()  : bool|null
Check if $user is a super user and can skip auth with an auto True
canAdd()  : bool
Check if $user can add RolesPermissions
canDelete()  : bool
Check if $user can delete RolesPermissions
canEdit()  : bool
Check if $user can edit RolesPermissions
canExport()  : bool
Check if user can export member data to CSV
canGridData()  : bool
Check if $user can view role
canIndex()  : bool
Check if $user can view role
canVerifyQueue()  : bool
Check if user can verify queue
canVerifyQueueGridData()  : bool
Check if user can access verifyQueueGridData (grid data endpoint) Uses the same authorization as the verifyQueue action
canView()  : bool
Check if $user can view RolesPermissions
canViewPrivateNotes()  : bool
Check if $user can view hidden
scopeGridData()  : mixed
Check if user can access gridData scope (Dataverse grid data endpoint) Uses the same authorization scope as the standard index action
scopeIndex()  : mixed
Apply scope for index action.
scopeIndexDv()  : mixed
Check if user can access indexDv scope (Dataverse grid view) Uses the same authorization scope as the standard index action
scopeVerifyQueue()  : mixed
Check if user can access verifyQueue scope
scopeVerifyQueueGridData()  : mixed
Check if user can access verifyQueueGridData scope (Dataverse grid data endpoint) Uses the same authorization scope as the verifyQueue 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

canVerifyQueueGridData()

Check if user can access verifyQueueGridData (grid data endpoint) Uses the same authorization as the verifyQueue action

public canVerifyQueueGridData(KmpIdentityInterface $user, BaseEntity|Table $entity, mixed ...$optionalArgs) : bool
Parameters
$user : KmpIdentityInterface

User

$entity : BaseEntity|Table

Entity

$optionalArgs : mixed

Optional arguments

Return values
bool

scopeGridData()

Check if user can access gridData scope (Dataverse grid data endpoint) Uses the same authorization scope as the standard index action

public scopeGridData(KmpIdentityInterface $user, mixed $query) : mixed
Parameters
$user : KmpIdentityInterface

User

$query : mixed

Query

scopeVerifyQueueGridData()

Check if user can access verifyQueueGridData scope (Dataverse grid data endpoint) Uses the same authorization scope as the verifyQueue action

public scopeVerifyQueueGridData(KmpIdentityInterface $user, mixed $query) : mixed
Parameters
$user : KmpIdentityInterface

User

$query : mixed

Query

_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