Arikaim CMS

Permissions extends Model
in package
Uses Uuid, Slug, Find

Permissions database model

Table of Contents

Properties

$timestamps  : bool
Disable timestamps
$DEFAUL_SLUG_COLUMN  : string
Default slug column name
$DEFAUL_SLUG_SEPARATOR  : string
Default slug column name
$DEFAUL_SLUG_SOURCE_COLUMN  : string
Default slug source column
$DEFAULT_UUID_COLUMN  : string
Default uuid column name
$fillable  : array<string|int, mixed>
Fillable attributes
$slugSourceColumn  : string
Custom slug source column
$table  : string
Db table name

Methods

bootSlug()  : void
Set model event on saving
bootUuid()  : void
Init model events.
createPermission()  : Model|false
Create permission model
createSlug()  : string
Create slug from text
findByColumn()  : Model|null
Find model by column name
findById()  : Model|null
Find model by id or uuid
findByIdQuery()  : Builder
Return query builder
findBySlug()  : Model|null
Find model by slug
findItems()  : QueryBuilder|false
Find collection of models by id or uuid
findMultiple()  : Builder
Find multiole query
findPermission()  : Model|null
Find permission model by id, uuid, slug, name
findQuery()  : Builder
Return query builder
getId()  : int|false
Get permission id
getIdAttributeName()  : string
Return id column name dependiv of id value type for string return uuid
getIsDenyAttribute()  : bool
Mutator (get) for is_deny attribute.
getLastId()  : int|null
Get last id
getLastRow()  : Model|null
Get last row
getListQuery()  : Builder
Get permisisons list query
getSlug()  : string
Get slug value
getTitleAttribute()  : string
Mutator (get) for title attribute.
has()  : bool
Return true if permission item exist.
hasAttribute()  : bool
Return true if atr exist
isDeny()  : bool
Return if permission is deny
saveSlug()  : Model
Save slug
scopeSearchIgnoreCase()  : Builder
Case insensitive search
scopeSlugQuery()  : Builder
Find by slug scope
setSlug()  : void
Set slug field
whereIgnoreCase()  : Builder
Where case insensitive

Properties

$timestamps

Disable timestamps

public bool $timestamps = false

$DEFAUL_SLUG_COLUMN

Default slug column name

protected static string $DEFAUL_SLUG_COLUMN = 'slug'

$DEFAUL_SLUG_SEPARATOR

Default slug column name

protected static string $DEFAUL_SLUG_SEPARATOR = '-'

$DEFAUL_SLUG_SOURCE_COLUMN

Default slug source column

protected static string $DEFAUL_SLUG_SOURCE_COLUMN = 'title'

$DEFAULT_UUID_COLUMN

Default uuid column name

protected static string $DEFAULT_UUID_COLUMN = 'uuid'

$fillable

Fillable attributes

protected array<string|int, mixed> $fillable = ['name', 'slug', 'editable', 'title', 'description', 'extension_name', 'deny', 'validator_class']

$slugSourceColumn

Custom slug source column

protected string $slugSourceColumn = 'name'

$table

Db table name

protected string $table = 'permissions'

Methods

bootSlug()

Set model event on saving

public static bootSlug() : void

bootUuid()

Init model events.

public static bootUuid() : void

createPermission()

Create permission model

public createPermission(string $name[, string $title = '' ][, string|null $description = null ][, int|null $deny = null ]) : Model|false
Parameters
$name : string
$title : string = ''
$description : string|null = null
$deny : int|null = null
Return values
Model|false

createSlug()

Create slug from text

public createSlug(string $text[, string|null $separator = null ]) : string
Parameters
$text : string
$separator : string|null = null
Return values
string

findByColumn()

Find model by column name

public findByColumn(mixed $value[, string|null|array<string|int, mixed> $column = null ]) : Model|null
Parameters
$value : mixed
$column : string|null|array<string|int, mixed> = null
Return values
Model|null

findById()

Find model by id or uuid

public findById(int|string $id) : Model|null
Parameters
$id : int|string
Return values
Model|null

findByIdQuery()

Return query builder

public findByIdQuery(int|string $id) : Builder
Parameters
$id : int|string
Return values
Builder

findBySlug()

Find model by slug

public findBySlug(string $slug) : Model|null
Parameters
$slug : string
Return values
Model|null

findItems()

Find collection of models by id or uuid

public findItems(array<string|int, mixed>|null $items) : QueryBuilder|false
Parameters
$items : array<string|int, mixed>|null
Return values
QueryBuilder|false

findMultiple()

Find multiole query

public findMultiple(array<string|int, mixed> $idList) : Builder
Parameters
$idList : array<string|int, mixed>
Return values
Builder

findPermission()

Find permission model by id, uuid, slug, name

public findPermission(mixed $value) : Model|null
Parameters
$value : mixed
Return values
Model|null

findQuery()

Return query builder

public findQuery(mixed $value[, string|null|array<string|int, mixed> $column = null ]) : Builder
Parameters
$value : mixed
$column : string|null|array<string|int, mixed> = null
Return values
Builder

getId()

Get permission id

public getId(string $name) : int|false
Parameters
$name : string

Name or Slug

Return values
int|false

getIdAttributeName()

Return id column name dependiv of id value type for string return uuid

public getIdAttributeName(int|string $id) : string
Parameters
$id : int|string
Return values
string

getIsDenyAttribute()

Mutator (get) for is_deny attribute.

public getIsDenyAttribute() : bool
Return values
bool

getLastId()

Get last id

public getLastId() : int|null
Return values
int|null

getLastRow()

Get last row

public getLastRow([string $field = 'id' ]) : Model|null
Parameters
$field : string = 'id'
Return values
Model|null

getListQuery()

Get permisisons list query

public getListQuery() : Builder
Return values
Builder

getSlug()

Get slug value

public getSlug() : string
Return values
string

getTitleAttribute()

Mutator (get) for title attribute.

public getTitleAttribute() : string
Return values
string

has()

Return true if permission item exist.

public has(string $name) : bool
Parameters
$name : string
Return values
bool

hasAttribute()

Return true if atr exist

public hasAttribute(string $attr) : bool
Parameters
$attr : string
Return values
bool

isDeny()

Return if permission is deny

public isDeny() : bool
Return values
bool

saveSlug()

Save slug

public static saveSlug(Model $model) : Model
Parameters
$model : Model
Return values
Model

scopeSearchIgnoreCase()

Case insensitive search

public scopeSearchIgnoreCase(Builder $query, string $column, string|null $value) : Builder
Parameters
$query : Builder
$column : string
$value : string|null
Return values
Builder

scopeSlugQuery()

Find by slug scope

public scopeSlugQuery(Builder $query, string $slug[, int|null $userId = null ]) : Builder
Parameters
$query : Builder
$slug : string
$userId : int|null = null
Return values
Builder

setSlug()

Set slug field

public setSlug([string|null $text = null ]) : void
Parameters
$text : string|null = null

whereIgnoreCase()

Where case insensitive

public whereIgnoreCase(string $attribute, mixed $value[, string $operator = '=' ]) : Builder
Parameters
$attribute : string
$value : mixed
$operator : string = '='
Return values
Builder 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results