Arikaim CMS

UserRelation

User Relation trait

Define custom user column

protected $userColumnName = 'column name';

Table of Contents

Properties

$DEFAULT_USER_COLUMN  : string
Default user column name

Methods

bootUserRelation()  : void
Init model events.
getAuthId()  : mixed
Get current auth id
scopeUserQuery()  : Builder
Filter by user
scopeUserQueryWithPublic()  : Builder
Filter rows by user + null (public)
user()  : Relation|null
Get user relation

Properties

$DEFAULT_USER_COLUMN

Default user column name

protected static string $DEFAULT_USER_COLUMN = 'user_id'

Methods

bootUserRelation()

Init model events.

public static bootUserRelation() : void

getAuthId()

Get current auth id

public getAuthId() : mixed

scopeUserQuery()

Filter by user

public scopeUserQuery(Builder $query, int|null $userId) : Builder
Parameters
$query : Builder
$userId : int|null
Return values
Builder

scopeUserQueryWithPublic()

Filter rows by user + null (public)

public scopeUserQueryWithPublic(Builder $query, int|null $userId) : Builder
Parameters
$query : Builder
$userId : int|null
Return values
Builder

user()

Get user relation

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

        
On this page

Search results