Arikaim CMS

DefaultTrait

Default column trait

Table of Contents

Methods

getDefault()  : Model|null
Get default model
getDefaultAttribute()  : bool
Mutator (get) for default attribute.
getDefaultColumnName()  : string
Get default column name
getDefaultKeyColumnName()  : string
Get default key column name
hasDefault()  : bool
Return true if default value is set
scopeDefaultQuery()  : Builder
Default scope
setDefault()  : bool
Set model as default

Methods

getDefault()

Get default model

public getDefault([mixed|null $keyValue = null ]) : Model|null
Parameters
$keyValue : mixed|null = null
Return values
Model|null

getDefaultAttribute()

Mutator (get) for default attribute.

public getDefaultAttribute() : bool
Return values
bool

getDefaultColumnName()

Get default column name

public getDefaultColumnName() : string
Return values
string

getDefaultKeyColumnName()

Get default key column name

public getDefaultKeyColumnName() : string
Return values
string

hasDefault()

Return true if default value is set

public hasDefault([mixed|null $keyValue = null ]) : bool
Parameters
$keyValue : mixed|null = null
Return values
bool

scopeDefaultQuery()

Default scope

public scopeDefaultQuery(Builder $query[, mixed|null $keyValue = null ]) : Builder
Parameters
$query : Builder
$keyValue : mixed|null = null
Return values
Builder

setDefault()

Set model as default

public setDefault([int|string|null $id = null ][, int|null $keyValue = null ]) : bool
Parameters
$id : int|string|null = null
$keyValue : int|null = null
Return values
bool

        
On this page

Search results