Arikaim CMS

UserGroupMembers extends Model
in package
Uses Uuid, Find, DateCreated

User groups details database model

Table of Contents

Properties

$timestamps  : bool
Disable timestamps
$DEFAULT_UUID_COLUMN  : string
Default uuid column name
$fillable  : array<string|int, mixed>
Fillable attributes
$table  : string
Db table name

Methods

addMember()  : Model|false
Add member to group
bootDateCreated()  : void
Set model events
bootUuid()  : void
Init model events.
findByColumn()  : Model|null
Find model by column name
findById()  : Model|null
Find model by id or uuid
findByIdQuery()  : Builder
Return query builder
findItems()  : QueryBuilder|false
Find collection of models by id or uuid
findMultiple()  : Builder
Find multiole query
findQuery()  : Builder
Return query builder
getDateCreatedAttributeName()  : string
Get date created attribute
getIdAttributeName()  : string
Return id column name dependiv of id value type for string return uuid
getLastId()  : int|null
Get last id
getLastRow()  : Model|null
Get last row
group()  : Relation|null
User group relation
hasAttribute()  : bool
Return true if atr exist
isMember()  : bool
Add member to group
scopeSearchIgnoreCase()  : Builder
Case insensitive search
scopeUserGroups()  : Builder
User goroups scope
user()  : Relation|null
User relation
whereIgnoreCase()  : Builder
Where case insensitive

Properties

$DEFAULT_UUID_COLUMN

Default uuid column name

protected static string $DEFAULT_UUID_COLUMN = 'uuid'

$fillable

Fillable attributes

protected array<string|int, mixed> $fillable = ['user_id', 'group_id', 'date_expired', 'date_created']

Methods

addMember()

Add member to group

public addMember(string|int $userId, string|int $groupId) : Model|false
Parameters
$userId : string|int

Group Id or Group slug

$groupId : string|int
Return values
Model|false

bootDateCreated()

Set model events

public static bootDateCreated() : void

bootUuid()

Init model events.

public static bootUuid() : void

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

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

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

getDateCreatedAttributeName()

Get date created attribute

public getDateCreatedAttributeName() : string
Return values
string

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

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

group()

User group relation

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

hasAttribute()

Return true if atr exist

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

isMember()

Add member to group

public isMember(int $userId, int $groupId) : bool
Parameters
$userId : int

Group Id or Group slug

$groupId : int
Return values
bool

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

scopeUserGroups()

User goroups scope

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

user()

User relation

public user() : Relation|null
Return values
Relation|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