Arikaim CMS

EntityPermissions

Entity permissions

Table of Contents

Methods

addGroupPermission()  : Model|false
Add group permission
addPermission()  : Model|false
Add permission
addPublicPermission()  : Model
Add public permission
addUserPermission()  : Model|false
Add user permission
deleteGroupPermission()  : bool
Delete group permission
deletePublicPermission()  : bool
Delete public permissions
deleteUserPermission()  : bool
Delete user permission
entity()  : Relation|null
Get entity relation
getNameAttribute()  : string
Get permission name attribute
getPermission()  : Model|null
Get permission model
getPermissionsQuery()  : Builder
Get permissions query
getPublicPermission()  : Model|null
Get public permission
permission()  : Relation|null
Get permission relation
related()  : Relation|null
Morphed models
scopeGroupPermissions()  : Builder
Get group permissions query
scopePermissionsForUser()  : Builder
Query for all permissions for user
scopePermissionsQuery()  : Builder
Permissions scope query
scopeUserPermissions()  : Builder
Get user permissions query

Methods

addGroupPermission()

Add group permission

public addGroupPermission(int $entityId, int $groupId, array<string|int, mixed>|string $permissions[, int|null $permissionId = null ]) : Model|false
Parameters
$entityId : int
$groupId : int
$permissions : array<string|int, mixed>|string
$permissionId : int|null = null
Return values
Model|false

addPermission()

Add permission

public addPermission(int $entityId, int $id, array<string|int, mixed>|string $permissions[, string $type = 'user' ][, int|null $permissionId = null ]) : Model|false
Parameters
$entityId : int
$id : int
$permissions : array<string|int, mixed>|string
$type : string = 'user'

(user or gorup)

$permissionId : int|null = null
Return values
Model|false

addPublicPermission()

Add public permission

public addPublicPermission(int $entityId, array<string|int, mixed>|string $permissions) : Model
Parameters
$entityId : int
$permissions : array<string|int, mixed>|string
Return values
Model

addUserPermission()

Add user permission

public addUserPermission(int $entityId, int $userId, array<string|int, mixed>|string $permissions[, int|null $permissionId = null ]) : Model|false
Parameters
$entityId : int
$userId : int
$permissions : array<string|int, mixed>|string
$permissionId : int|null = null
Return values
Model|false

deleteGroupPermission()

Delete group permission

public deleteGroupPermission(int $entityId, int $groupId) : bool
Parameters
$entityId : int
$groupId : int
Return values
bool

deletePublicPermission()

Delete public permissions

public deletePublicPermission(int $entityId) : bool
Parameters
$entityId : int
Return values
bool

deleteUserPermission()

Delete user permission

public deleteUserPermission(int $entityId, int $userId) : bool
Parameters
$entityId : int
$userId : int
Return values
bool

entity()

Get entity relation

public entity() : Relation|null
Return values
Relation|null

getNameAttribute()

Get permission name attribute

public getNameAttribute() : string
Return values
string

getPermission()

Get permission model

public getPermission(int $entityId, int $id[, string $type = 'user' ]) : Model|null
Parameters
$entityId : int
$id : int
$type : string = 'user'
Return values
Model|null

getPermissionsQuery()

Get permissions query

public getPermissionsQuery(int $entityId[, string|null $type = null ]) : Builder
Parameters
$entityId : int
$type : string|null = null
Return values
Builder

getPublicPermission()

Get public permission

public getPublicPermission(int $entityId) : Model|null
Parameters
$entityId : int
Return values
Model|null

permission()

Get permission relation

public permission() : Relation|null
Return values
Relation|null

related()

Morphed models

public related() : Relation|null
Return values
Relation|null

scopeGroupPermissions()

Get group permissions query

public scopeGroupPermissions(Builder $query) : Builder
Parameters
$query : Builder
Return values
Builder

scopePermissionsForUser()

Query for all permissions for user

public scopePermissionsForUser(Builder $query, int $userId) : Builder
Parameters
$query : Builder
$userId : int
Return values
Builder

scopePermissionsQuery()

Permissions scope query

public scopePermissionsQuery(Builder $query[, int|null $entityId = null ][, string|null $type = null ][, int|null $typeId = null ]) : Builder
Parameters
$query : Builder
$entityId : int|null = null
$type : string|null = null
$typeId : int|null = null
Return values
Builder

scopeUserPermissions()

Get user permissions query

public scopeUserPermissions(Builder $query) : Builder
Parameters
$query : Builder
Return values
Builder 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results