Arikaim CMS

JobsRegistry extends Model
in package
Uses Uuid, Find, OptionsAttribute, DateCreated

Jobs registry 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
$optionsColumnName  : mixed
$table  : string
Db table name

Methods

bootDateCreated()  : void
Set model events
bootUuid()  : void
Init model events.
deleteJob()  : bool
Delete job
deleteJobs()  : bool
Delete jobs
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
findJob()  : object|null
Find job
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
getOption()  : mixed
Get option from options array
getOptionsAttribute()  : array<string|int, mixed>
Mutator (get) for options attribute.
getOptionsColumnName()  : string
Get options column name
hasAttribute()  : bool
Return true if atr exist
hasJob()  : bool
Return true if job exists
saveJob()  : bool
Save job in registry
saveOption()  : bool
Save option
saveOptions()  : bool
Save options
scopePackageQuery()  : Builder
Filter jobs by package
scopeSearchIgnoreCase()  : Builder
Case insensitive search
whereIgnoreCase()  : Builder
Where case insensitive

Properties

$timestamps

Disable timestamps

public bool $timestamps = false

$DEFAULT_UUID_COLUMN

Default uuid column name

protected static string $DEFAULT_UUID_COLUMN = 'uuid'

$fillable

Fillable attributes

protected array<string|int, mixed> $fillable = ['name', 'title', 'description', 'category', 'handler_class', 'package_name', 'package_type', 'date_created', 'properties']

$optionsColumnName

protected mixed $optionsColumnName = 'properties'

$table

Db table name

protected string $table = 'jobs_registry'

Methods

bootDateCreated()

Set model events

public static bootDateCreated() : void

bootUuid()

Init model events.

public static bootUuid() : void

deleteJob()

Delete job

public deleteJob(mixed $name) : bool
Parameters
$name : mixed
Return values
bool

deleteJobs()

Delete jobs

public deleteJobs(string $packageName, string $packageType) : bool
Parameters
$packageName : string
$packageType : string
Return values
bool

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

findJob()

Find job

public findJob(string|int $name) : object|null
Parameters
$name : string|int

Job id, uiid or name

Return values
object|null

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

getOption()

Get option from options array

public getOption(string $key[, mixed $default = null ]) : mixed
Parameters
$key : string
$default : mixed = null

getOptionsAttribute()

Mutator (get) for options attribute.

public getOptionsAttribute() : array<string|int, mixed>
Return values
array<string|int, mixed>

getOptionsColumnName()

Get options column name

public getOptionsColumnName() : string
Return values
string

hasAttribute()

Return true if atr exist

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

hasJob()

Return true if job exists

public hasJob(string|int $name) : bool
Parameters
$name : string|int

Job id, uiid, name

Return values
bool

saveJob()

Save job in registry

public saveJob(JobInterface $job, string|null $packageName[, string|null $packageType = null ]) : bool
Parameters
$job : JobInterface
$packageName : string|null
$packageType : string|null = null
Return values
bool

saveOption()

Save option

public saveOption(string $key, mixed $value) : bool
Parameters
$key : string
$value : mixed
Return values
bool

saveOptions()

Save options

public saveOptions(array<string|int, mixed> $options) : bool
Parameters
$options : array<string|int, mixed>
Return values
bool

scopePackageQuery()

Filter jobs by package

public scopePackageQuery(Builder $query, string|null $packageName[, string|null $packageType = null ]) : Builder
Parameters
$query : Builder
$packageName : string|null
$packageType : string|null = null
Return values
Builder

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

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