Documentation

ModelModel extends BaseModel
in package

Manages plugin models.

Tags
author

Alexey Bobkov, Samuel Georges

Table of Contents

UNQUALIFIED_CLASS_NAME_PATTERN  = '/^[A-Z]+[a-zA-Z0-9_]+$/'
$className  : mixed
$databaseTable  : mixed
$exists  : bool
$fillable  : mixed
$pluginCodeObj  : PluginCode
$updatedData  : mixed
$validationMessages  : mixed
$validationRules  : mixed
fill()  : mixed
getDatabaseTableOptions()  : mixed
getModelColumnsAndTypes()  : mixed
getModelFields()  : mixed
getModelPluginName()  : mixed
getPluginCodeObj()  : mixed
getPluginRegistryData()  : mixed
getPluginRegistryDataColumns()  : mixed
isNewModel()  : mixed
listPluginModels()  : mixed
save()  : mixed
setPluginCode()  : mixed
Sets a string code of a plugin the model is associated with
setPluginCodeObj()  : mixed
Sets a code object of a plugin the model is associated with
validate()  : mixed
validateModelClassName()  : mixed
getFilePath()  : mixed
validateBeforeCreate()  : mixed
validateColumnsExist()  : mixed
getTableNameFromModelClass()  : mixed

Constants

UNQUALIFIED_CLASS_NAME_PATTERN

public mixed UNQUALIFIED_CLASS_NAME_PATTERN = '/^[A-Z]+[a-zA-Z0-9_]+$/'

Properties

$exists

public bool $exists = false

This property is used by the system internally.

$fillable

protected static mixed $fillable = ['className', 'databaseTable', 'addTimestamps', 'addSoftDeleting']

$pluginCodeObj

protected PluginCode $pluginCodeObj = null

The plugin code object the model is associated with.

$updatedData

protected mixed $updatedData = []

$validationMessages

protected mixed $validationMessages = []

$validationRules

protected mixed $validationRules = ['className' => ['required', 'regex:' . self::UNQUALIFIED_CLASS_NAME_PATTERN, 'uniqModelName'], 'databaseTable' => ['required'], 'addTimestamps' => ['timestampColumnsMustExist'], 'addSoftDeleting' => ['deletedAtColumnMustExist']]

Methods

fill()

public fill(array<string|int, mixed> $attributes) : mixed
Parameters
$attributes : array<string|int, mixed>
Return values
mixed —

getDatabaseTableOptions()

public getDatabaseTableOptions() : mixed
Return values
mixed —

getModelColumnsAndTypes()

public static getModelColumnsAndTypes(mixed $pluginCodeObj, mixed $modelClassName) : mixed
Parameters
$pluginCodeObj : mixed
$modelClassName : mixed
Return values
mixed —

getModelFields()

public static getModelFields(mixed $pluginCodeObj, mixed $modelClassName) : mixed
Parameters
$pluginCodeObj : mixed
$modelClassName : mixed
Return values
mixed —

getModelPluginName()

public getModelPluginName() : mixed
Return values
mixed —

getPluginCodeObj()

public getPluginCodeObj() : mixed
Return values
mixed —

getPluginRegistryData()

public static getPluginRegistryData(mixed $pluginCode, mixed $subtype) : mixed
Parameters
$pluginCode : mixed
$subtype : mixed
Return values
mixed —

getPluginRegistryDataColumns()

public static getPluginRegistryDataColumns(mixed $pluginCode, mixed $modelClassName) : mixed
Parameters
$pluginCode : mixed
$modelClassName : mixed
Return values
mixed —

isNewModel()

public isNewModel() : mixed
Return values
mixed —

listPluginModels()

public static listPluginModels(mixed $pluginCodeObj) : mixed
Parameters
$pluginCodeObj : mixed
Return values
mixed —

save()

public save() : mixed
Return values
mixed —

setPluginCode()

Sets a string code of a plugin the model is associated with

public setPluginCode(string $code) : mixed
Parameters
$code : string

Specifies the plugin code

Return values
mixed —

setPluginCodeObj()

Sets a code object of a plugin the model is associated with

public setPluginCodeObj(PluginCode $obj) : mixed
Parameters
$obj : PluginCode

Specifies the plugin code object

Return values
mixed —

validate()

public validate() : mixed
Return values
mixed —

validateModelClassName()

public static validateModelClassName(mixed $modelClassName) : mixed
Parameters
$modelClassName : mixed
Return values
mixed —

getFilePath()

protected getFilePath() : mixed
Return values
mixed —

validateBeforeCreate()

protected validateBeforeCreate() : mixed
Return values
mixed —

validateColumnsExist()

protected validateColumnsExist(mixed $value, mixed $columns, mixed $columnsToCheck) : mixed
Parameters
$value : mixed
$columns : mixed
$columnsToCheck : mixed
Return values
mixed —

getTableNameFromModelClass()

private static getTableNameFromModelClass(mixed $pluginCodeObj, mixed $modelClassName) : mixed
Parameters
$pluginCodeObj : mixed
$modelClassName : mixed
Return values
mixed —

Search results