QueuedJobPolicy
extends BasePolicy
in package
QueuedJob 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
- canAddJob() : bool
- Check if $user can add a job
- canCleanup() : bool
- Check if $user can cleanup a job
- canData() : bool
- Check if $user can view data
- canDelete() : bool
- Check if $user can delete RolesPermissions
- canEdit() : bool
- Check if $user can edit RolesPermissions
- canExecute() : bool
- Check if $user can execute a job
- canFlush() : bool
- Check if $user can flush a job
- canGridData() : bool
- Check if $user can view role
- canHardReset() : bool
- Check if $user can hard reset a job
- canImport() : bool
- Check if $user can import jobs
- canIndex() : bool
- Check if $user can view role
- canMigrate() : bool
- Check if $user can run migrations
- canProcesses() : bool
- Check if $user can processes a job
- canRemoveJob() : bool
- Check if $user can remove a job
- canReset() : bool
- Check if $user can reset a job
- canResetJob() : bool
- Check if $user reset a job
- canStats() : bool
- Check if $user can view stats
- canTerminate() : bool
- Check if $user can kill a job
- canTest() : bool
- Check if $user can test a job
- canView() : bool
- Check if $user can view RolesPermissions
- canViewClasses() : bool
- Check if $user can view classes
- 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|nullcanAdd()
Check if $user can add RolesPermissions
public
canAdd(KmpIdentityInterface $user, BaseEntity|Table $entity, mixed ...$optionalArgs) : bool
Parameters
- $user : KmpIdentityInterface
-
The user.
- $entity : BaseEntity|Table
- $optionalArgs : mixed
Return values
boolcanAddJob()
Check if $user can add a job
public
canAddJob(KmpIdentityInterface $user, BaseEntity $entity, mixed ...$optionalArgs) : bool
Parameters
- $user : KmpIdentityInterface
-
The user
- $entity : BaseEntity
-
The entity
- $optionalArgs : mixed
-
Optional arguments
Return values
boolcanCleanup()
Check if $user can cleanup a job
public
canCleanup(KmpIdentityInterface $user, BaseEntity $entity, mixed ...$optionalArgs) : bool
Parameters
- $user : KmpIdentityInterface
-
The user
- $entity : BaseEntity
-
The entity
- $optionalArgs : mixed
-
Optional arguments
Return values
boolcanData()
Check if $user can view data
public
canData(KmpIdentityInterface $user, BaseEntity $entity, mixed ...$optionalArgs) : bool
Parameters
- $user : KmpIdentityInterface
-
The user
- $entity : BaseEntity
-
The entity
- $optionalArgs : mixed
-
Optional arguments
Return values
boolcanDelete()
Check if $user can delete RolesPermissions
public
canDelete(KmpIdentityInterface $user, BaseEntity $entity, mixed ...$optionalArgs) : bool
Parameters
- $user : KmpIdentityInterface
-
The user.
- $entity : BaseEntity
- $optionalArgs : mixed
Return values
boolcanEdit()
Check if $user can edit RolesPermissions
public
canEdit(KmpIdentityInterface $user, BaseEntity $entity, mixed ...$optionalArgs) : bool
Parameters
- $user : KmpIdentityInterface
-
The user.
- $entity : BaseEntity
- $optionalArgs : mixed
Return values
boolcanExecute()
Check if $user can execute a job
public
canExecute(KmpIdentityInterface $user, BaseEntity $entity, mixed ...$optionalArgs) : bool
Parameters
- $user : KmpIdentityInterface
-
The user
- $entity : BaseEntity
-
The entity
- $optionalArgs : mixed
-
Optional arguments
Return values
boolcanFlush()
Check if $user can flush a job
public
canFlush(KmpIdentityInterface $user, BaseEntity $entity, mixed ...$optionalArgs) : bool
Parameters
- $user : KmpIdentityInterface
-
The user
- $entity : BaseEntity
-
The entity
- $optionalArgs : mixed
-
Optional arguments
Return values
boolcanGridData()
Check if $user can view role
public
canGridData(KmpIdentityInterface $user, BaseEntity $entity, mixed ...$optionalArgs) : bool
Parameters
- $user : KmpIdentityInterface
-
The user.
- $entity : BaseEntity
- $optionalArgs : mixed
Return values
boolcanHardReset()
Check if $user can hard reset a job
public
canHardReset(KmpIdentityInterface $user, BaseEntity $entity, mixed ...$optionalArgs) : bool
Parameters
- $user : KmpIdentityInterface
-
The user
- $entity : BaseEntity
-
The entity
- $optionalArgs : mixed
-
Optional arguments
Return values
boolcanImport()
Check if $user can import jobs
public
canImport(KmpIdentityInterface $user, BaseEntity $entity, mixed ...$optionalArgs) : bool
Parameters
- $user : KmpIdentityInterface
-
The user
- $entity : BaseEntity
-
The entity
- $optionalArgs : mixed
-
Optional arguments
Return values
boolcanIndex()
Check if $user can view role
public
canIndex(KmpIdentityInterface $user, BaseEntity $entity, mixed ...$optionalArgs) : bool
Parameters
- $user : KmpIdentityInterface
-
The user.
- $entity : BaseEntity
- $optionalArgs : mixed
Return values
boolcanMigrate()
Check if $user can run migrations
public
canMigrate(KmpIdentityInterface $user, BaseEntity $entity, mixed ...$optionalArgs) : bool
Parameters
- $user : KmpIdentityInterface
-
The user
- $entity : BaseEntity
-
The entity
- $optionalArgs : mixed
-
Optional arguments
Return values
boolcanProcesses()
Check if $user can processes a job
public
canProcesses(KmpIdentityInterface $user, BaseEntity $entity, mixed ...$optionalArgs) : bool
Parameters
- $user : KmpIdentityInterface
-
The user
- $entity : BaseEntity
-
The entity
- $optionalArgs : mixed
-
Optional arguments
Return values
boolcanRemoveJob()
Check if $user can remove a job
public
canRemoveJob(KmpIdentityInterface $user, BaseEntity $entity, mixed ...$optionalArgs) : bool
Parameters
- $user : KmpIdentityInterface
-
The user
- $entity : BaseEntity
-
The entity
- $optionalArgs : mixed
-
Optional arguments
Return values
boolcanReset()
Check if $user can reset a job
public
canReset(KmpIdentityInterface $user, BaseEntity $entity, mixed ...$optionalArgs) : bool
Parameters
- $user : KmpIdentityInterface
-
The user
- $entity : BaseEntity
-
The entity
- $optionalArgs : mixed
-
Optional arguments
Return values
boolcanResetJob()
Check if $user reset a job
public
canResetJob(KmpIdentityInterface $user, BaseEntity $entity, mixed ...$optionalArgs) : bool
Parameters
- $user : KmpIdentityInterface
-
The user
- $entity : BaseEntity
-
The entity
- $optionalArgs : mixed
-
Optional arguments
Return values
boolcanStats()
Check if $user can view stats
public
canStats(KmpIdentityInterface $user, BaseEntity $entity, mixed ...$optionalArgs) : bool
Parameters
- $user : KmpIdentityInterface
-
The user
- $entity : BaseEntity
-
The entity
- $optionalArgs : mixed
-
Optional arguments
Return values
boolcanTerminate()
Check if $user can kill a job
public
canTerminate(KmpIdentityInterface $user, BaseEntity $entity, mixed ...$optionalArgs) : bool
Parameters
- $user : KmpIdentityInterface
-
The user
- $entity : BaseEntity
-
The entity
- $optionalArgs : mixed
-
Optional arguments
Return values
boolcanTest()
Check if $user can test a job
public
canTest(KmpIdentityInterface $user, BaseEntity $entity, mixed ...$optionalArgs) : bool
Parameters
- $user : KmpIdentityInterface
-
The user
- $entity : BaseEntity
-
The entity
- $optionalArgs : mixed
-
Optional arguments
Return values
boolcanView()
Check if $user can view RolesPermissions
public
canView(KmpIdentityInterface $user, BaseEntity|Table $entity, mixed ...$optionalArgs) : bool
Parameters
- $user : KmpIdentityInterface
-
The user.
- $entity : BaseEntity|Table
- $optionalArgs : mixed
Return values
boolcanViewClasses()
Check if $user can view classes
public
canViewClasses(KmpIdentityInterface $user, BaseEntity $entity, mixed ...$optionalArgs) : bool
Parameters
- $user : KmpIdentityInterface
-
The user
- $entity : BaseEntity
-
The entity
- $optionalArgs : mixed
-
Optional arguments
Return values
boolcanViewPrivateNotes()
Check if $user can view hidden
public
canViewPrivateNotes(KmpIdentityInterface $user, BaseEntity $entity) : bool
Parameters
- $user : KmpIdentityInterface
-
The user.
- $entity : BaseEntity
Return values
boolscopeIndex()
Apply scope for index action.
public
scopeIndex(KmpIdentityInterface $user, mixed $query) : mixed
Parameters
- $user : KmpIdentityInterface
- $query : mixed
_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_getPermissions()
Check if $user can view hidden
protected
_getPermissions(KmpIdentityInterface $user) : bool
Parameters
- $user : KmpIdentityInterface
-
The user.
Return values
bool_getPolicies()
Check if $user can view hidden
protected
_getPolicies(KmpIdentityInterface $user) : bool
Parameters
- $user : KmpIdentityInterface
-
The user.
Return values
bool_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_isSuperUser()
Check if $user is a super user
protected
_isSuperUser(KmpIdentityInterface $user) : bool
Parameters
- $user : KmpIdentityInterface
-
The user.